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/menu_lang_ecrire.php
Fonction
menu_lang_pour_tous

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Calcule l'environnement et le squelette permettant d'afficher
 * le formulaire de sélection de changement de langue
 *
 * Le changement de langue se fait par l'appel à l'action `converser`
 *
 * @uses lang_select()
 * @see  action_converser_dist()
 *
 * @param string $nom
 *     Nom de la variable qui sera postée par le formulaire
 * @param string $default
 *     Valeur par défaut de la langue
 * @return array
 *     Liste : Chemin du squelette, durée du cache, contexte
 **/
function menu_lang_pour_tous($nom, $default) {
	include_spip('inc/lang');
 
	if ($GLOBALS['spip_lang'] <> $default) {
		$opt = lang_select($default);  # et remplace
		if ($GLOBALS['spip_lang'] <> $default) {
			$default = '';  # annule tout choix par defaut
			if ($opt) {
				lang_select();
			}
		}
	}
 
	# lien a partir de /
	$cible = parametre_url(self(), 'lang', '', '&');
	$post = generer_url_action('converser', 'redirect=' . rawurlencode($cible), '&');
 
	return array(
		'formulaires/menu_lang',
		3600,
		array(
			'nom' => $nom,
			'url' => $post,
			'name' => $nom,
			'default' => $default,
		)
	);
}

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.