Proposer une amélioration de commentaire

Le commentaire à poster est au format «docblock» (de phpDoc) qui peut être enrichi de tags spécifiques pour SPIP.
Fichier
ecrire/balise/url_logout.php

    Nom ou pseudo de l'auteur de la proposition

Code original

<?php
 
/***************************************************************************\
 *  SPIP, Systeme de publication pour l'internet                           *
 *                                                                         *
 *  Copyright (c) 2001-2016                                                *
 *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
 *                                                                         *
 *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
 *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
\***************************************************************************/
 
/**
 * Ce fichier gère la balise dynamique `#URL_LOGOUT`
 *
 * @package SPIP\Core\Compilateur\Balises
 **/
 
if (!defined('_ECRIRE_INC_VERSION')) {
	return;
}
 
/**
 * Compile la balise dynamique `#URL_LOGOUT` qui génère une URL permettant
 * de déconnecter l'auteur actuellement connecté
 *
 * @balise
 * @example
 *     ```
 *     [<a href="(#URL_LOGOUT)">déconnexion</a>]
 *     ```
 *
 * @param Champ $p
 *     Pile au niveau de la balise
 * @return Champ
 *     Pile complétée du code compilé
 **/
function balise_URL_LOGOUT($p) {
	return calculer_balise_dynamique($p, 'URL_LOGOUT', array());
}
 
 
/**
 * Calculs de paramètres de contexte automatiques pour la balise URL_LOGOUT
 *
 * @param array $args
 *   Liste des arguments transmis à la balise
 *   - `$args[0]` = URL destination après logout `[(#URL_LOGOUT{url})]`
 * @param array $context_compil
 *   Tableau d'informations sur la compilation
 * @return array
 *   Liste (url) des arguments collectés.
 */
function balise_URL_LOGOUT_stat($args, $context_compil) {
	$url = isset($args[0]) ? $args[0] : '';
 
	return array($url);
}
 
/**
 * Exécution de la balise dynamique `#URL_LOGOUT`
 *
 * Retourne une URL de déconnexion uniquement si le visiteur est connecté.
 *
 * @param string $cible
 *     URL de destination après déconnexion
 * @return string
 *     URL de déconnexion ou chaîne vide.
 **/
function balise_URL_LOGOUT_dyn($cible) {
 
	if (!$GLOBALS['visiteur_session']['login'] and !$GLOBALS['visiteur_session']['statut']) {
		return '';
	}
 
	return generer_url_action('logout', "logout=public&url=" . rawurlencode($cible ? $cible : self('&')));
}

Le commentaire au format « docblock » peut être complété des éléments suivants sécifiques
à SPIP.

Sur un entête de fichier :

  • @package SPIP\Core\x (pour un fichier du core, x dépendant du fichier)
  • @package SPIP\Nom\x (pour un fichier de plugin, Nom étant le nom du plugin)

Sur un entête de fonction :

  • @pipeline x : indique que la fonction est une utilisation d’un pipeline
  • @pipeline_appel x : indique que la fonction appelle le pipeline indiqué
  • @balise : indique que la fonction est une compilation de balise
  • @filtre : indique un |filtre
  • @critere : indique que la fonction est une compilaiton de critère
  • @boucle : indique que la fonction est une compilaiton de boucle
Vous inscrire sur ce site

L’espace privé de ce site est ouvert aux visiteurs, après inscription. Une fois enregistré, vous pourrez consulter les articles en cours de rédaction, proposer des articles et participer à tous les forums.

Identifiants personnels

Indiquez ici votre nom et votre adresse email. Votre identifiant personnel vous parviendra rapidement, par courrier électronique.