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
plugins-dist/textwheel/inc/lien.php
Fonction
virtuel_redirige

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Retourne la valeur d'un champ de redirection (articles virtuels)
 * 
 * L'entrée accepte plusiers types d'écritures : 
 * - une URL compète, 
 * - un lien SPIP tel que `[Lien->article23]`, 
 * - ou un raccourcis SPIP comme `rub2` ou `rubrique2`
 *
 * @param string $virtuel
 *     Texte qui définit la redirection, à analyser. 
 *     Plusieurs types peuvent être acceptés :
 *     - un raccourci Spip habituel, tel que `[texte->TYPEnnn]`
 *     - un ultra raccourci Spip, tel que `TYPEnnn`
 *     - une URL standard
 * @param bool $url
 *     false : retourne uniquement le nom du lien (TYPEnnn)
 *     true : retourne l'URL calculée pour le lien
 * @return string
 *     Nom du lien ou URL
 */
function virtuel_redirige($virtuel, $url = false) {
	if (!strlen($virtuel)) {
		return '';
	}
	if (
		!preg_match(_RACCOURCI_LIEN, $virtuel, $m)
		and !preg_match(_RACCOURCI_CHAPO, $virtuel, $m)
	) {
		return $virtuel;
	}
 
	return !$url ? $m[3] : traiter_lien_implicite($m[3]);
}

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.