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
traiter_modeles

    Nom ou pseudo de l'auteur de la proposition

Code original

// https://code.spip.net/@traiter_modeles
function traiter_modeles($texte, $doublons = false, $echap = '', $connect = '', $liens = null, $env = array()) {
	// preserver la compatibilite : true = recherche des documents
	if ($doublons === true) {
		$doublons = array('documents' => array('doc', 'emb', 'img'));
	}
 
	// detecter les modeles (rapide)
	if (
		strpos($texte, "<") !== false
		and preg_match_all('/<[a-z_-]{3,}\s*[0-9|]+/iS', $texte, $matches, PREG_SET_ORDER)
	) {
		include_spip('public/assembler');
		$wrap_embed_html = charger_fonction("wrap_embed_html", "inc", true);
 
		// Recuperer l'appel complet (y compris un eventuel lien)
		foreach ($matches as $match) {
			$a = strpos($texte, $match[0]);
			preg_match(_RACCOURCI_MODELE_DEBUT, substr($texte, $a), $regs);
 
			// s'assurer qu'il y a toujours un 5e arg, eventuellement vide
			while (count($regs) < 6) {
				$regs[] = "";
			}
 
			list(, $mod, $type, $id, $params, $fin) = $regs;
 
			if (
				$fin
				and preg_match('/<a\s[^<>]*>\s*$/i', substr($texte, 0, $a), $r)
			) {
				$lien = array(
					'href' => extraire_attribut($r[0], 'href'),
					'class' => extraire_attribut($r[0], 'class'),
					'mime' => extraire_attribut($r[0], 'type'),
					'title' => extraire_attribut($r[0], 'title'),
					'hreflang' => extraire_attribut($r[0], 'hreflang')
				);
				$n = strlen($r[0]);
				$a -= $n;
				$cherche = $n + strlen($regs[0]);
			} else {
				$lien = false;
				$cherche = strlen($mod);
			}
 
			// calculer le modele
			# hack indexation
			if ($doublons) {
				$texte .= preg_replace(',[|][^|=]*,s', ' ', $params);
			} # version normale
			else {
				// si un tableau de liens a ete passe, reinjecter le contenu d'origine
				// dans les parametres, plutot que les liens echappes
				if (!is_null($liens)) {
					$params = str_replace($liens[0], $liens[1], $params);
				}
 
				$modele = inclure_modele($type, $id, $params, $lien, $connect, $env);
 
				// en cas d'echec,
				// si l'objet demande a une url,
				// creer un petit encadre vers elle
				if ($modele === false) {
					$modele = substr($texte, $a, $cherche);
 
					if (!is_null($liens)) {
						$modele = str_replace($liens[0], $liens[1], $modele);
					}
 
					$contexte = array_merge($env, array('id' => $id, 'type' => $type, 'modele' => $modele));
 
					if ($lien) {
						# un eventuel guillemet (") sera reechappe par #ENV
						$contexte['lien'] = str_replace("&quot;", '"', $lien['href']);
						$contexte['lien_class'] = $lien['class'];
						$contexte['lien_mime'] = $lien['mime'];
						$contexte['lien_title'] = $lien['title'];
						$contexte['lien_hreflang'] = $lien['hreflang'];
					}
 
					$modele = recuperer_fond("modeles/dist", $contexte, array(), $connect);
				}
				// le remplacer dans le texte
				if ($modele !== false) {
					$modele = protege_js_modeles($modele);
					if ($wrap_embed_html) {
						$modele = $wrap_embed_html($mod, $modele);
					}
					$rempl = code_echappement($modele, $echap);
					$texte = substr($texte, 0, $a)
						. $rempl
						. substr($texte, $a + $cherche);
				}
			}
 
			// hack pour tout l'espace prive
			if (((!_DIR_RESTREINT) or ($doublons)) and ($id)) {
				foreach ($doublons ? $doublons : array('documents' => array('doc', 'emb', 'img')) as $quoi => $modeles) {
					if (in_array(strtolower($type), $modeles)) {
						$GLOBALS["doublons_{$quoi}_inclus"][] = $id;
					}
				}
			}
		}
	}
 
	return $texte;
}

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.