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_lien_implicite

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Transformer un lien raccourci art23 en son URL
 * Par defaut la fonction produit une url prive si on est dans le prive
 * ou publique si on est dans le public.
 * La globale lien_implicite_cible_public permet de forcer un cas ou l'autre :
 * $GLOBALS['lien_implicite_cible_public'] = true;
 *  => tous les liens raccourcis pointent vers le public
 * $GLOBALS['lien_implicite_cible_public'] = false;
 *  => tous les liens raccourcis pointent vers le prive
 * unset($GLOBALS['lien_implicite_cible_public']);
 *  => retablit le comportement automatique
 *
 * https://code.spip.net/@traiter_lien_implicite
 *
 * @param string $ref
 * @param string $texte
 * @param string $pour
 * @param string $connect
 * @return array|bool|string
 */
function traiter_lien_implicite($ref, $texte = '', $pour = 'url', $connect = '') {
	$cible = ($connect ? $connect : (isset($GLOBALS['lien_implicite_cible_public']) ? $GLOBALS['lien_implicite_cible_public'] : null));
	if (!($match = typer_raccourci($ref))) {
		return false;
	}
 
	@list($type, , $id, , $args, , $ancre) = $match;
 
	# attention dans le cas des sites le lien doit pointer non pas sur
	# la page locale du site, mais directement sur le site lui-meme
	$url = '';
	if ($f = charger_fonction("implicite_$type", "liens", true)) {
		$url = $f($texte, $id, $type, $args, $ancre, $connect);
	}
 
	if (!$url) {
		$url = generer_url_entite($id, $type, $args, $ancre, $cible);
	}
 
	if (!$url) {
		return false;
	}
 
	if (is_array($url)) {
		@list($type, $id) = $url;
		$url = generer_url_entite($id, $type, $args, $ancre, $cible);
	}
 
	if ($pour === 'url') {
		return $url;
	}
 
	$r = traiter_raccourci_titre($id, $type, $connect);
	if ($r) {
		$r['class'] = ($type == 'site') ? 'spip_out' : 'spip_in';
	}
 
	if ($texte = trim($texte)) {
		$r['titre'] = $texte;
	}
 
	if (!@$r['titre']) {
		$r['titre'] = _T($type) . " $id";
	}
 
	if ($pour == 'titre') {
		return $r['titre'];
	}
 
	$r['url'] = $url;
 
	// dans le cas d'un lien vers un doc, ajouter le type='mime/type'
	if (
		$type == 'document'
		and $mime = sql_getfetsel('mime_type', 'spip_types_documents',
			"extension IN (" . sql_get_select("extension", "spip_documents", "id_document=" . sql_quote($id)) . ")",
			'', '', '', '', $connect)
	) {
		$r['mime'] = $mime;
	}
 
	return $r;
}

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.