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/petitions/balise/formulaire_signature.php

    Nom ou pseudo de l'auteur de la proposition

Code original

<?php
 
/***************************************************************************\
 *  SPIP, Systeme de publication pour l'internet                           *
 *                                                                         *
 *  Copyright (c) 2001-2016                                                *
 *  Arnaud Martin, Antoine Pitrou, Philippe Riviere, Emmanuel Saint-James  *
 *                                                                         *
 *  Ce programme est un logiciel libre distribue sous licence GNU/GPL.     *
 *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
\***************************************************************************/
 
if (!defined("_ECRIRE_INC_VERSION")) {
	return;
}  #securite

//
// Formulaire de signature d'une petition
//
 
include_spip('base/abstract_sql');
 
// Contexte necessaire lors de la compilation
 
// Il *faut* demander petition, meme si on ne s'en sert pas dans l'affichage,
// car on doit obtenir la jointure avec la table des petitions pour verifier 
// si une petition est attachee a l'article.
 
// https://code.spip.net/@balise_FORMULAIRE_SIGNATURE
function balise_FORMULAIRE_SIGNATURE($p) {
	return calculer_balise_dynamique($p, 'FORMULAIRE_SIGNATURE', array('id_article', 'petition'));
}
 
// Verification des arguments (contexte + filtres)
// https://code.spip.net/@balise_FORMULAIRE_SIGNATURE_stat
function balise_FORMULAIRE_SIGNATURE_stat($args, $context_compil) {
 
	// pas d'id_article => erreur de contexte
	if (!$args[0]) {
		$msg = array(
			'zbug_champ_hors_motif',
			array(
				'champ' => 'FORMULAIRE_SIGNATURE',
				'motif' => 'ARTICLES'
			)
		);
		erreur_squelette($msg, $context_compil);
 
		return '';
	} // article sans petition => pas de balise
	else {
		if (!$args[1]) {
			return '';
		}
	}
 
	// on envoie pas cet argument dans le CVT
	unset($args[1]);
 
	return $args;
}

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.