- * #NOM_SITE
- *
+ * ```
+ * #NOM_SITE
+ * ```
*
* @param Champ $p
- * Pile au niveau de la balise
+ * Pile au niveau de la balise
* @return Champ
- * Pile complétée par le code à générer
-**/
+ * Pile complétée par le code à générer
+ **/
function balise_NOM_SITE_dist($p) {
if (!$p->etoile) {
$p->code = "supprimer_numero(calculer_url(" .
- champ_sql('url_site',$p) ."," .
- champ_sql('nom_site',$p) .
- ", 'titre', \$connect, false))";
- } else
- $p->code = champ_sql('nom_site',$p);
+ champ_sql('url_site', $p) . "," .
+ champ_sql('nom_site', $p) .
+ ", 'titre', \$connect, false))";
+ } else {
+ $p->code = champ_sql('nom_site', $p);
+ }
$p->interdire_scripts = true;
+
return $p;
}
-// http://doc.spip.org/@balise_NOTES_dist
+
+/**
+ * Compile la balise `#NOTE` qui affiche les notes de bas de page
+ *
+ * @balise
+ * @link http://www.spip.net/3964
+ * @see calculer_notes()
+ *
+ * @param Champ $p
+ * Pile au niveau de la balise
+ * @return Champ
+ * Pile complétée par le code à générer
+ **/
function balise_NOTES_dist($p) {
// Recuperer les notes
$p->code = 'calculer_notes()';
+
#$p->interdire_scripts = true;
return $p;
}
-// http://doc.spip.org/@balise_RECHERCHE_dist
+
+/**
+ * Compile la balise `#RECHERCHE` qui retourne le terme de recherche demandé
+ *
+ * Retourne un terme demandé en recherche, en le prenant dans _request()
+ * sous la clé `recherche`.
+ *
+ * @balise
+ * @example
+ * ```
+ * (#PAGINATION{prive})
] + * ``` + * + * @param Champ $p + * Pile au niveau de la balise + * @param string $liste + * Afficher ou non les liens de pagination (variable de type `string` + * car code à faire écrire au compilateur) : + * - `true` pour les afficher + * - `false` pour afficher uniquement l'ancre. + * @return Champ + * Pile complétée par le code à générer + */ +function balise_PAGINATION_dist($p, $liste = 'true') { $b = $p->nom_boucle ? $p->nom_boucle : $p->descr['id_mere']; // s'il n'y a pas de nom de boucle, on ne peut pas paginer if ($b === '') { - $msg = array('zbug_champ_hors_boucle', + $msg = array( + 'zbug_champ_hors_boucle', array('champ' => $liste ? 'PAGINATION' : 'ANCRE_PAGINATION') - ); + ); erreur_squelette($msg, $p); + return $p; } @@ -571,11 +1143,13 @@ function balise_PAGINATION_dist($p, $liste='true') { // dans un boucle recursive ou qu'on a oublie le critere {pagination} if (!$p->boucles[$b]->mode_partie) { if (!$p->boucles[$b]->table_optionnelle) { - $msg = array('zbug_pagination_sans_critere', - array('champ' => '#PAGINATION') - ); + $msg = array( + 'zbug_pagination_sans_critere', + array('champ' => '#PAGINATION') + ); erreur_squelette($msg, $p); } + return $p; } @@ -583,53 +1157,91 @@ function balise_PAGINATION_dist($p, $liste='true') { // si false, le compilo va bloquer sur des syntaxes avec un filtre sans argument qui suit la balise // si true, les arguments simples (sans truc=chose) vont degager $_contexte = argumenter_inclure($p->param, true, $p, $p->boucles, $p->id_boucle, false, false); - if (count($_contexte)){ - list($key,$val) = each($_contexte); - if (is_numeric($key)){ + if (count($_contexte)) { + list($key, $val) = each($_contexte); + if (is_numeric($key)) { array_shift($_contexte); - $__modele = interprete_argument_balise(1,$p); + $__modele = interprete_argument_balise(1, $p); } } - if (count($_contexte)){ - $code_contexte = implode(',',$_contexte); - } - else + if (count($_contexte)) { + $code_contexte = implode(',', $_contexte); + } else { $code_contexte = ''; + } $connect = $p->boucles[$b]->sql_serveur; $pas = $p->boucles[$b]->total_parties; $f_pagination = chercher_filtre('pagination'); $type = $p->boucles[$b]->modificateur['debut_nom']; - $modif = ($type[0]!=="'") ? "'debut'.$type" - : ("'debut" .substr($type,1)); + $modif = ($type[0] !== "'") ? "'debut'.$type" + : ("'debut" . substr($type, 1)); - $p->code = sprintf(CODE_PAGINATION, $f_pagination, $b, $type, $modif, $pas, $liste, ((isset($__modele) and $__modele) ? $__modele : "''"), _q($connect), $code_contexte); + $p->code = sprintf(CODE_PAGINATION, $f_pagination, $b, $type, $modif, $pas, $liste, + ((isset($__modele) and $__modele) ? $__modele : "''"), _q($connect), $code_contexte); $p->boucles[$b]->numrows = true; $p->interdire_scripts = false; + return $p; } -// N'afficher que l'ancre de la pagination (au-dessus, par exemple, alors -// qu'on mettra les liens en-dessous de la liste paginee) -// http://doc.spip.org/@balise_ANCRE_PAGINATION_dist +/** + * Compile la balise `#ANCRE_PAGINATION` chargée d'afficher l'ancre + * de la pagination + * + * Cette ancre peut ainsi être placée au-dessus la liste des éléments + * de la boucle alors qu'on mettra les liens de pagination en-dessous de + * cette liste paginée. + * + * Cette balise nécessite le critère `pagination` sur la boucle où elle + * est utilisée. + * + * @balise + * @link http://www.spip.net/3367 Le système de pagination + * @link http://www.spip.net/4328 Balise ANCRE_PAGINATION + * @see critere_pagination_dist() + * @see balise_PAGINATION_dist() + * + * @param Champ $p + * Pile au niveau de la balise + * @return Champ + * Pile complétée par le code à générer + **/ function balise_ANCRE_PAGINATION_dist($p) { - if ($f = charger_fonction('PAGINATION', 'balise', true)) - return $f($p, $liste='false'); - else return NULL; // ou une erreur ? + if ($f = charger_fonction('PAGINATION', 'balise', true)) { + return $f($p, $liste = 'false'); + } else { + return null; + } // ou une erreur ? } -// equivalent a #TOTAL_BOUCLE sauf pour les boucles paginees, ou elle -// indique le nombre total d'articles repondant aux criteres hors pagination -// http://doc.spip.org/@balise_GRAND_TOTAL_dist + +/** + * Compile la balise `#GRAND_TOTAL` qui retourne le nombre total de résultats + * d'une boucle + * + * Cette balise set équivalente à `#TOTAL_BOUCLE` sauf pour les boucles paginées. + * Dans ce cas elle indique le nombre total d'éléments répondant aux critères + * hors pagination. + * + * @balise + * @see balise_GRAND_TOTAL_dist() + * + * @param Champ $p + * Pile au niveau de la balise + * @return Champ + * Pile complétée par le code à générer + **/ function balise_GRAND_TOTAL_dist($p) { $b = $p->nom_boucle ? $p->nom_boucle : $p->descr['id_mere']; if ($b === '' || !isset($p->boucles[$b])) { - $msg = array('zbug_champ_hors_boucle', - array('champ' => "#$b" . 'TOTAL_BOUCLE') - ); + $msg = array( + 'zbug_champ_hors_boucle', + array('champ' => "#$b" . 'TOTAL_BOUCLE') + ); erreur_squelette($msg, $p); } else { $p->code = "(isset(\$Numrows['$b']['grand_total']) @@ -637,43 +1249,107 @@ function balise_GRAND_TOTAL_dist($p) { $p->boucles[$b]->numrows = true; $p->interdire_scripts = false; } + return $p; } -// Reference a l'URL de la page courante -// Attention dans un INCLURE() ou une balise dynamique on n'a pas le droit de -// mettre en cache #SELF car il peut correspondre a une autre page (attaque XSS) -// (Dans ce cas faire