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/inc/lister_objets.php
Fonction
inc_lister_objets_dist

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Affichage des liste d'objets
 *
 * Surcharge pour aiguiller vers la mise en squelettes des listes
 *
 * @deprecated Créer ou utiliser un squelette dans `prive/objets/liste/`
 *   pour la table en question et l'appeler avec une inclusion.
 *
 * @param string $vue
 *     Nom de l'objet
 * @param array $contexte
 *     Contexte du squelette
 * @param bool $force
 *     Si `true` le titre est affiché même s'il n'y a aucun élément dans la liste.
 * @return string
 *     Code HTML de la liste
 */
function inc_lister_objets_dist($vue, $contexte = array(), $force = false) {
	$res = ""; // debug
	if (!is_array($contexte)) {
		return _L('$contexte doit etre un tableau dans inc/lister_objets');
	}
 
	$fond = "prive/objets/liste/$vue";
	if (!find_in_path($fond . "." . _EXTENSION_SQUELETTES)) {
		// traiter les cas particuliers
		include_spip('base/connect_sql');
		$vue = table_objet($vue);
		$fond = "prive/objets/liste/$vue";
		if (!find_in_path($fond . "." . _EXTENSION_SQUELETTES)) {
			return _L("vue $vue introuvable pour lister les objets");
		}
	}
 
 
	$contexte['sinon'] = ($force ? $contexte['titre'] : '');
 
	$res = recuperer_fond($fond, $contexte, array('ajax' => true));
	if (_request('var_liste')) {
		echo var_export($contexte, true);
	}
 
	return $res;
}

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.