diff --git a/ecrire/inc/auth.php b/ecrire/inc/auth.php index 6e7b0da39baa8e641fc9c3c606f831b21db5dd8f..e82432a83f27fba2cfbcfdce79b2a4d442400284 100644 --- a/ecrire/inc/auth.php +++ b/ecrire/inc/auth.php @@ -287,8 +287,7 @@ function auth_a_loger() } /** - * Tracer en base la date de derniere connexion de l'auteur - * http://doc.spip.org/@auth_trace + * Tracer en base la date de dernière connexion de l'auteur * * @param array $row * @param null|string $date @@ -460,7 +459,16 @@ function auth_url_retour_login($auth_methode, $login, $redirect='', $serveur='') $securiser_action = charger_fonction('securiser_action','inc'); return $securiser_action('auth', "$auth_methode/$login", $redirect, true); } - +/** + * Terminer l'action d'authentification d'un auteur + * + * @uses auth_administrer() + * + * @param string $auth_methode + * @param string $login + * @param string $serveur + * @return mixed + */ function auth_terminer_identifier_login($auth_methode, $login, $serveur=''){ $args = func_get_args(); $auteur = auth_administrer('terminer_identifier_login',$args); @@ -640,11 +648,12 @@ function auth_synchroniser_distant($auth_methode=true, $id_auteur=0, $champs=arr /** - * + * Vérifier si l'auteur est bien authentifié + * * @param string $login * @param string $pw * @param string $serveur - * @return array + * @return array|bool */ function lire_php_auth($login, $pw, $serveur=''){ diff --git a/ecrire/inc/autoriser.php b/ecrire/inc/autoriser.php index fd8d00a8d55855ae52d12761d32ad46db0be3b87..5fe7ee6cfbf41a6f070f9c40a3a76a5bf98e1d48 100644 --- a/ecrire/inc/autoriser.php +++ b/ecrire/inc/autoriser.php @@ -296,11 +296,17 @@ function autoriser_previsualiser_dist($faire, $type, $id, $qui, $opt) { } /** - * Options de la fonction autoriser_previsualiser_dist + * Options de la fonction autoriser_previsualiser_dist * * commande l'affichage dans l'espace prive du bouton "previsualiser" * voir prive/objets/infos/article.html etc. - * + * + * @uses lister_tables_objets_sql() + * @uses table_objet_sql() + * + * @param string|null $type + * @param array $opt + * @return boolean */ function test_previsualiser_objet_champ($type=null, $opt=array()) { diff --git a/ecrire/inc/boutons.php b/ecrire/inc/boutons.php index b43eaef970c04b2451b8784939b003909d5f0bd5..4d466e757b06b75285ad3766145cfb0efbb44cfc 100644 --- a/ecrire/inc/boutons.php +++ b/ecrire/inc/boutons.php @@ -10,23 +10,64 @@ * Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne. * \***************************************************************************/ +/** + * Gestion des boutons de l'interface privée + * + * @package SPIP\Core\Boutons + */ + + * @var nulll|string $url2 + * URL du javascript + * @var null|string $target + * Pour ouvrir dans une fenêtre à part + * @var null|mixed $sousmenu + * Sous-barre de boutons/onglets + */ + if (!defined('_ECRIRE_INC_VERSION')) return; /** - * une classe definissant un bouton dans la barre du haut de l'interface - * privee ou dans un de ses sous menus + * Classe définissant un bouton dans la barre du haut de l'interface + * privée ou dans un de ses sous menus */ -// http://doc.spip.org/@Bouton class Bouton { - var $icone; /* l'icone a mettre dans le bouton */ - var $libelle; /* le nom de l'entree d'i18n associe */ - var $url= null; /* l'url de la page (null => ?exec=nom) */ - var $urlArg= null; /* arguments supplementaires de l'url */ - var $url2= null; /* url jscript */ - var $target= null; /* pour ouvrir dans une fenetre a part */ - var $sousmenu= null;/* sous barre de boutons / onglets */ - -// http://doc.spip.org/@Bouton + /** @var string L'icone à mettre dans le bouton */ + var $icone; + + /* @var string Le nom de l'entrée d'i18n associé */ + var $libelle; + + /** @var null|string L'URL de la page (null => ?exec=nom) */ + var $url= null; + + /** @var null|string|array Arguments supplementaires de l'URL */ + var $urlArg= null; + + /** @var null|string URL du javascript */ + var $url2= null; + + /** @var null|string Pour ouvrir dans une fenetre a part */ + var $target= null; + + /** @var null|mixed Sous-barre de boutons / onglets */ + var $sousmenu= null; + + /** + * Définit un bouton + * + * @param string $icone + * L'icone à mettre dans le bouton + * @param string $libelle + * Le nom de l'entrée i18n associé + * @param null|string $url + * L'URL de la page + * @param null|string|array $urlArg + * Arguments supplémentaires de l'URL + * @param null|string $url2 + * URL du javascript + * @param null|mixed $target + * Pour ouvrir une fenêtre à part + */ function Bouton($icone, $libelle, $url=null, $urlArg=null, $url2=null, $target=null) { $this->icone = $icone; @@ -40,10 +81,18 @@ class Bouton { /** - * definir la liste des onglets dans une page de l'interface privee - * on passe la main au pipeline "ajouter_onglets". + * Définir la liste des onglets dans une page de l'interface privée. + * + * On passe la main au pipeline "ajouter_onglets". + * + * @uses onglets_plugins() + * @uses autoriser() + * + * @pipeline_appel ajouter_onglets + * + * @param string $script + * @return array */ -// http://doc.spip.org/@definir_barre_onglets function definir_barre_onglets($script) { $onglets=array(); @@ -72,7 +121,20 @@ function definir_barre_onglets($script) { } -// http://doc.spip.org/@barre_onglets +/** + * + * Création de la barre d'onglets + * + * @uses definir_barre_onglets() + * @uses onglet() + * @uses debut_onglet() + * @uses fin_onglet() + * + * @param string $rubrique + * @param string $ongletCourant + * @param string $class + * @return string + */ function barre_onglets($rubrique, $ongletCourant, $class="barre_onglet"){ include_spip('inc/presentation');