Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
tips_informatiques:programmation:php:plugin_alaxos:components:shibbolethauthenticatorcomponent [2010/08/24 22:30] nico |
tips_informatiques:programmation:php:plugin_alaxos:components:shibbolethauthenticatorcomponent [2010/08/24 00:00] (Version actuelle) |
||
---|---|---|---|
Ligne 61: | Ligne 61: | ||
- | __set_shibboleth_attribute_uid($shibboleth_attribute_uid)__ | + | **set_shibboleth_attribute_uid($shibboleth_attribute_uid)** |
>Permet de spécifier le nom de l'attribut Shibboleth contenant l'identifiant unique de l'utilisateur. | >Permet de spécifier le nom de l'attribut Shibboleth contenant l'identifiant unique de l'utilisateur. | ||
- | __set_user_model_name($user_model_name)__ | + | **set_user_model_name($user_model_name)** |
>Permet de spécifier le nom du Model utilisé pour stocker les utilisateurs. Par défaut: //User// | >Permet de spécifier le nom du Model utilisé pour stocker les utilisateurs. Par défaut: //User// | ||
- | __set_external_uid_fieldname($external_uid_fieldname)__ | + | **set_external_uid_fieldname($external_uid_fieldname)** |
>Permet de spécifier le nom du champ utilisé pour stocker l'identifiant unique Shibboleth. Par défaut: //external_uid// | >Permet de spécifier le nom du champ utilisé pour stocker l'identifiant unique Shibboleth. Par défaut: //external_uid// | ||
- | __set_authentication_type_fieldname($authentication_type_fieldname)__ | + | **set_authentication_type_fieldname($authentication_type_fieldname)** |
>Dans le cas où plusieurs systèmes de login existent dans l'application, permet d'indiquer le nom d'un champ contenant le type d'authentification de l'utilisateur. Par défaut: //authenticationtype_id// | >Dans le cas où plusieurs systèmes de login existent dans l'application, permet d'indiquer le nom d'un champ contenant le type d'authentification de l'utilisateur. Par défaut: //authenticationtype_id// | ||
- | __set_default_authentication_type_value($default_authentication_type_value)__ | + | **set_default_authentication_type_value($default_authentication_type_value)** |
>Dans le cas où plusieurs systèmes de login existent dans l'application, permet d'indiquer la valeur du type d'authentification par défaut. | >Dans le cas où plusieurs systèmes de login existent dans l'application, permet d'indiquer la valeur du type d'authentification par défaut. | ||
- | __set_create_new_user($create_new_user)__ | + | **set_create_new_user($create_new_user)** |
>Permet d'indiquer si des utilisateurs qui n'existent pas dans l'application doivent être créés automatiquement. Defaut: //true// | >Permet d'indiquer si des utilisateurs qui n'existent pas dans l'application doivent être créés automatiquement. Defaut: //true// | ||
- | __add_attribute_mapping($shibboleth_attribute_name, $user_property, $update_on_login = true)__ | + | **add_attribute_mapping($shibboleth_attribute_name, $user_property, $update_on_login = true)** |
>Permet d'ajouter une correspondance entre un attribut Shibboleth et une propriété de l'utilisateur (le nom d'un champ dans la base de données). | >Permet d'ajouter une correspondance entre un attribut Shibboleth et une propriété de l'utilisateur (le nom d'un champ dans la base de données). | ||
Permet également d'indiquer si la valeur doit être mise à jour à chaque fois que l'utilisateur s'authentifie. | Permet également d'indiquer si la valeur doit être mise à jour à chaque fois que l'utilisateur s'authentifie. | ||
- | __add_callback_function($shibboleth_attribute_name, $callback_function)__ | + | **add_callback_function($shibboleth_attribute_name, $callback_function)** |
>Permet d'indiquer une fonction qui sera appelée lors de la récupération d'un attribut et qui doit retourner une valeur à utiliser pour l'attribut. | >Permet d'indiquer une fonction qui sera appelée lors de la récupération d'un attribut et qui doit retourner une valeur à utiliser pour l'attribut. | ||
Ligne 123: | Ligne 123: | ||
</code> | </code> | ||
- | __authenticate()__ | + | **authenticate()** |
>Méthode qui effectue l'authentification d'un utilisateur - déjà authentifié dans Shibboleth - dans l'application CakePHP | >Méthode qui effectue l'authentification d'un utilisateur - déjà authentifié dans Shibboleth - dans l'application CakePHP | ||
>En fonction des paramètres passés au préalable au composant, elle peut créer des nouveaux utilisateurs et mettre à jour les attributs des autres. | >En fonction des paramètres passés au préalable au composant, elle peut créer des nouveaux utilisateurs et mettre à jour les attributs des autres. | ||
- | __is_new_user()__ | + | **is_new_user()** |
>Retourne un boolean indiquant si l'utilisateur authentifié est un utilisateur qui vient d'être créé par le composant | >Retourne un boolean indiquant si l'utilisateur authentifié est un utilisateur qui vient d'être créé par le composant | ||
- | __get_shibboleth_value($shibboleth_attribute)__ | + | **get_shibboleth_value($shibboleth_attribute)** |
>Retourne la valeur d'un attribut Shibboleth d'un utilisateur authentifié | >Retourne la valeur d'un attribut Shibboleth d'un utilisateur authentifié | ||
Ligne 147: | Ligne 147: | ||
Certaines méthodes sont d'ailleurs écrites dans l'idée de pouvoir être overridées facilement. | Certaines méthodes sont d'ailleurs écrites dans l'idée de pouvoir être overridées facilement. | ||
- | __set_new_user_default_properties($user)__ | + | **set_new_user_default_properties($user)** |
>Un override de cette méthode permet d'écrire du code exécuté lors de la création d'un nouvel utilisateur | >Un override de cette méthode permet d'écrire du code exécuté lors de la création d'un nouvel utilisateur | ||
- | __log_user($user)__ | + | **log_user($user)** |
>Un override de cette méthode permet d'écrire sa propre logique de login | >Un override de cette méthode permet d'écrire sa propre logique de login |