Skip to content
Extraits de code Groupes Projets
Valider d7a38a98 rédigé par amemo's avatar amemo
Parcourir les fichiers

Documentation du code :

- ask_php_auth (par Ybbet) : Ajout de @uses
- auth_administrer (par Ybbet) : On explique un peu plus cette fonction importante
- auth_autoriser_modifier_login (par Ybbet) : Ajout de @uses
- auth_autoriser_modifier_pass (par Ybbet) : Ajout de @uses
- auth_deloger (par Ybbet) : Nouveau phpdoc

Note de marcimat :
Je n'ai pas envoyé tous les @uses suggérés par Ybbet : pas la peine de mettre les fonctions courantes de SPIP sans intérêt particulier pour la fonction documenté. J'ai également reformulé certains éléments.

Relecteur : Matthieu Marcillaud
parent 26f889f6
Aucune branche associée trouvée
Aucune étiquette associée trouvée
Aucune requête de fusion associée trouvée
...@@ -316,9 +316,19 @@ function auth_trace($row, $date=null) ...@@ -316,9 +316,19 @@ function auth_trace($row, $date=null)
*/ */
/** /**
* Fonction aiguillage, privee * Fonction privée d'aiguillage des fonctions d'authentification
*
* Charge une fonction d'authentification présente dans un répertoire `auth/`.
* Ainsi, utiliser `auth_administrer('informer_login', array('spip', ...)` appellera
* `auth_spip_informer_login()` de `ecrire/auth/spip.php`.
*
* @uses charger_fonction()
*
* @param string $fonction * @param string $fonction
* Nom de la fonction d'authentification
* @param array $args * @param array $args
* Le premier élément du tableau doit être le nom du système d'authentification
* choisi, tel que `spip` (par défaut) ou encore `ldap`.
* @param mixed $defaut * @param mixed $defaut
* @return mixed * @return mixed
*/ */
...@@ -495,16 +505,23 @@ function auth_loger($auteur){ ...@@ -495,16 +505,23 @@ function auth_loger($auteur){
return true; return true;
} }
/**
* Déconnexion de l'auteur
*
* @uses action_logout_dist()
* return void
**/
function auth_deloger(){ function auth_deloger(){
$logout = charger_fonction('logout','action'); $logout = charger_fonction('logout','action');
$logout(); $logout();
} }
/** /**
* Tester la possibilite de modifier le login d'authentification * Tester la possibilité de modifier le login d'authentification
* pour la methode donnee * pour la méthode donnée
* *
* @uses auth_administrer()
*
* @param string $auth_methode * @param string $auth_methode
* @param string $serveur * @param string $serveur
* @return bool * @return bool
...@@ -545,13 +562,15 @@ function auth_modifier_login($auth_methode, $new_login, $id_auteur, $serveur='') ...@@ -545,13 +562,15 @@ function auth_modifier_login($auth_methode, $new_login, $id_auteur, $serveur='')
} }
/** /**
* Tester la possibilite de modifier le pass * Tester la possibilité de modifier le pass
* pour la methode donnee * pour la méthode donnée
*
* @uses auth_administrer()
* *
* @param string $auth_methode * @param string $auth_methode
* @param string $serveur * @param string $serveur
* @return bool * @return bool
* succes ou echec * succès ou échec
*/ */
function auth_autoriser_modifier_pass($auth_methode, $serveur=''){ function auth_autoriser_modifier_pass($auth_methode, $serveur=''){
$args = func_get_args(); $args = func_get_args();
...@@ -653,8 +672,10 @@ function lire_php_auth($login, $pw, $serveur=''){ ...@@ -653,8 +672,10 @@ function lire_php_auth($login, $pw, $serveur=''){
} }
/** /**
* entete php_auth (est-encore utilise ?) * entête php_auth (est-encore utilisé ?)
* *
* @uses minipres()
*
* @param string $pb * @param string $pb
* @param string $raison * @param string $raison
* @param string $retour * @param string $retour
......
0% Chargement en cours ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter