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/public/references.php
Fonction
index_boucle

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Retrouver l'index de la boucle d'une balise
 *
 * Retrouve à quelle boucle appartient une balise, utile dans le cas
 * où une référence explicite est demandée
 *
 * - `#MABALISE` : l'index est celui de la première boucle englobante
 * - `#_autreboucle:MABALISE` : l'index est celui de la boucle _autreboucle si elle est bien englobante
 *
 * @example
 *     Dans une balise dynamique ou calculée :
 *     ```
 *     $idb = index_boucle($p);
 *     ```
 *
 * @param Champ $p AST au niveau de la balise
 * @return string
 *
 *     - Identifiant de la boucle possédant ce champ.
 *     - '' si une référence explicite incorrecte est envoyée
 */
function index_boucle($p) {
 
	$idb = $p->id_boucle;
	$explicite = $p->nom_boucle;
 
	if (strlen($explicite)) {
		// Recherche d'un champ dans un etage superieur
		while (($idb !== $explicite) && ($idb !== '')) {
			$idb = $p->boucles[$idb]->id_parent;
		}
	}
 
	return $idb;
}

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.