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/filtres_ecrire.php
Fonction
traduire_statut_auteur

    Nom ou pseudo de l'auteur de la proposition

Code original

/**
 * Traduire le statut technique de l'auteur en langage compréhensible
 *
 * Si $statut=='nouveau' et que le statut en attente est fourni,
 * le prendre en compte en affichant que l'auteur est en attente
 *
 * @param string $statut
 * @param string $attente
 * @return string
 */
function traduire_statut_auteur($statut, $attente = "") {
	$plus = "";
	if ($statut == 'nouveau') {
		if ($attente) {
			$statut = $attente;
			$plus = " (" . _T('info_statut_auteur_a_confirmer') . ")";
		} else {
			return _T('info_statut_auteur_a_confirmer');
		}
	}
 
	$recom = array(
		"info_administrateurs" => _T('item_administrateur_2'),
		"info_redacteurs" => _T('intem_redacteur'),
		"info_visiteurs" => _T('item_visiteur'),
		'5poubelle' => _T('texte_statut_poubelle'), // bouh
	);
	if (isset($recom[$statut])) {
		return $recom[$statut] . $plus;
	}
 
	// retrouver directement par le statut sinon
	if ($t = array_search($statut, $GLOBALS['liste_des_statuts'])) {
		if (isset($recom[$t])) {
			return $recom[$t] . $plus;
		}
 
		return _T($t) . $plus;
	}
 
	// si on a pas reussi a le traduire, retournons la chaine telle quelle
	// c'est toujours plus informatif que rien du tout
	return $statut;
}

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.