spip / SPIP

ecrire/public/fonctions.php

Doc Comments +1 added lines, -1 removed lines

@@ -592,7 +592,7 @@
  * [(#ENV{objet_source}|rang_lien{#ID_AUTEUR,#ENV{objet},#ENV{id_objet},#ENV{_objet_lien}})]
  *
  * @param $objet_source
- * @param $ids
+ * @param integer $ids
  * @param $objet_lie
  * @param $idl
  * @param $objet_lien

ecrire/public/aiguiller.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
 	return;
 }
 
+/**
+ * @return string|null
+ */
 function securiser_redirect_action($redirect) {
 	// cas d'un double urlencode : si un urldecode de l'url n'est pas secure, on retient ca comme redirect
 	if (strpos($redirect, '%') !== false) {

ecrire/plugins/afficher_plugin.php

Doc Comments +13 added lines

@@ -121,6 +121,10 @@ 
 // checkbox pour activer ou desactiver
 // si ce n'est pas une extension
 
+/**
+ * @param integer $id_input
+ * @param string $file
+ */
 function plugin_checkbox($id_input, $file, $actif) {
 	$name = substr(md5($file), 0, 16);
 
@@ -185,6 +189,9 @@ 
 	. "</div>";
 }
 
+/**
+ * @param string $nom
+ */
 function plugin_desintalle($plug_file, $nom, $dir_plugins = null) {
 	if (!$dir_plugins) {
 		$dir_plugins = _DIR_PLUGINS;
@@ -221,6 +228,9 @@ 
 }
 
 // https://code.spip.net/@plugin_propre
+/**
+ * @return string
+ */
 function plugin_propre($texte, $module = '',$propre='propre') {
 	// retirer le retour a la racine du module, car le find_in_path se fait depuis la racine
 	if (_DIR_RACINE and strncmp($module, _DIR_RACINE, strlen(_DIR_RACINE)) == 0) {
@@ -233,6 +243,9 @@ 
 	return $propre($texte);
 }
 
+/**
+ * @return string
+ */
 function plugin_typo($texte, $module = '') {
 	return plugin_propre($texte, $module, 'typo');
 }

ecrire/plugins/afficher_repertoires.php

Doc Comments +8 added lines

@@ -75,11 +75,19 @@
 // vraiment n'importe quoi la gestion des chemins des plugins
 // une fonction pour aider...
 // https://code.spip.net/@chemin_plug
+/**
+ * @param string $racine
+ *
+ * @return string
+ */
 function chemin_plug($racine, $plug) {
 	return preg_replace(',[^/]+/\.\./,', '', "$racine/$plug");
 }
 
 // https://code.spip.net/@tree_open_close_dir
+/**
+ * @param string $target
+ */
 function tree_open_close_dir(&$current, $target, $deplie = array()) {
 	if ($current == $target) {
 		return "";

ecrire/public/compiler.php

Doc Comments +11 added lines, -1 removed lines

@@ -59,6 +59,10 @@ 
 
 
 // https://code.spip.net/@argumenter_inclure
+/**
+ * @param boolean $rejet_filtres
+ * @param string $id_boucle
+ */
 function argumenter_inclure(
 	$params,
 	$rejet_filtres,
@@ -751,7 +755,7 @@ 
  *    Nom de la commande
  * @param string $val
  *    Code PHP décrivant la valeur à affecter
- * @return array
+ * @return string[]
  *
  *    - index 0 : Code pour une affectation statique. Si non rempli, la propriété devra
  *                être ré-affectée à chaque appel de la boucle.
@@ -859,6 +863,9 @@ 
 }
 
 // https://code.spip.net/@calculer_order
+/**
+ * @param Boucle $boucle
+ */
 function calculer_order(&$boucle) {
 	if (!$order = $boucle->order
 		and !$order = $boucle->default_order
@@ -944,6 +951,9 @@ 
 define('_REGEXP_CONCAT_NON_VIDE', "/^(.*)[.]\s*'[^']+'\s*$/");
 
 // https://code.spip.net/@compile_cas
+/**
+ * @param string $id_boucle
+ */
 function compile_cas($tableau, $descr, &$boucles, $id_boucle) {
 
 	$codes = array();

ecrire/public/criteres.php

Doc Comments +9 added lines

@@ -654,6 +654,11 @@ 
 }
 
 // https://code.spip.net/@calculer_critere_arg_dynamique
+/**
+ * @param string $idb
+ *
+ * @return string
+ */
 function calculer_critere_arg_dynamique($idb, &$boucles, $crit, $suffix = '') {
 	$boucle = $boucles[$idb];
 	$alt = "('" . $boucle->id_table . '.\' . $x' . $suffix . ')';
@@ -1503,6 +1508,10 @@ 
 }
 
 // https://code.spip.net/@critere_IN_cas
+/**
+ * @param string $idb
+ * @param string $crit2
+ */
 function critere_IN_cas($idb, &$boucles, $crit2, $arg, $op, $val, $col) {
 	static $num = array();
 	$descr = $boucles[$idb]->descr;

ecrire/public/debusquer.php

Doc Comments +7 added lines

@@ -432,6 +432,10 @@ 
 }
 
 // https://code.spip.net/@reference_boucle_debug
+/**
+ * @param string $nom
+ * @param string $self
+ */
 function reference_boucle_debug($n, $nom, $self) {
 	list($skel, $boucle, $ligne) = trouve_boucle_debug($n, $nom);
 
@@ -820,6 +824,9 @@ 
 }
 
 // https://code.spip.net/@debusquer_entete
+/**
+ * @param string $corps
+ */
 function debusquer_entete($titre, $corps) {
 
 	include_spip('balise/formulaire_admin');

ecrire/public/references.php

Doc Comments +17 added lines, -3 removed lines

@@ -322,7 +322,7 @@ 
  *           est dans une autre table et construit la jointure dessus
  *         - liste (table, champ, fonction) idem, mais en passant un
  *           nom de fonction qui s'occupera de créer la jointure.
- * @return array
+ * @return string[]
  *     Liste (nom du champ alias, nom du champ). Le nom du champ alias
  *     est une expression pour le SELECT de la boucle du style "mots.titre AS titre_mot"
  **/
@@ -500,7 +500,7 @@ 
  *     Nom de la balise
  * @param Champ $p
  *     AST au niveau de la balise
- * @return string
+ * @return Champ
  *     Code PHP pour d'exécution de la balise et de ses filtres
  **/
 function calculer_balise_DEFAUT_dist($nom, $p) {
@@ -784,6 +784,9 @@ 
 //  - deux etoiles => pas de securite non plus !
 //
 // https://code.spip.net/@applique_filtres
+/**
+ * @param Champ $p
+ */
 function applique_filtres($p) {
 
 	// Traitements standards (cf. supra)
@@ -858,6 +861,9 @@ 
 
 // Filtres et,ou,oui,non,sinon,xou,xor,and,or,not,yes
 // et comparateurs
+/**
+ * @param string $arg
+ */
 function filtre_logique($fonc, $code, $arg) {
 
 	switch (true) {
@@ -881,6 +887,9 @@ 
 }
 
 // https://code.spip.net/@compose_filtres_args
+/**
+ * @param string $sep
+ */
 function compose_filtres_args($p, $args, $sep) {
 	$arglist = "";
 	foreach ($args as $arg) {
@@ -928,6 +937,11 @@ 
 //
 
 // https://code.spip.net/@rindex_pile
+/**
+ * @param Champ $p
+ * @param string $champ
+ * @param string $motif
+ */
 function rindex_pile($p, $champ, $motif) {
 	$n = 0;
 	$b = $p->id_boucle;
@@ -957,7 +971,7 @@ 
 
 /** 
  * Retourne le nom de la balise indiquée pour les messages d’erreurs
- * @param Pile $p Description de la balise
+ * @param Champ $p Description de la balise
  * @param string $champ Nom du champ
  * @return string Nom de la balise, avec indication de boucle explicite si présent.
  */

ecrire/req/pg.exp.php

Doc Comments +29 added lines, -1 removed lines

@@ -132,6 +132,11 @@ 
 
 // Par ou ca passe une fois les traductions faites
 // https://code.spip.net/@spip_pg_trace_query
+/**
+ * @param string $query
+ *
+ * @return resource
+ */
 function spip_pg_trace_query($query, $serveur = '') {
 	$connexion = &$GLOBALS['connexions'][$serveur ? strtolower($serveur) : 0];
 	$prefixe = $connexion['prefixe'];
@@ -291,6 +296,9 @@ 
 }
 
 // https://code.spip.net/@spip_pg_alter_change
+/**
+ * @param string $arg
+ */
 function spip_pg_alter_change($table, $arg, $serveur = '', $requeter = true) {
 	if (!preg_match('/^`?(\w+)`?\s+`?(\w+)`?\s+(.*?)\s*(DEFAULT .*?)?(NOT\s+NULL)?\s*(DEFAULT .*?)?$/i', $arg, $r)) {
 		spip_log("alter change: $arg  incompris", 'pg.' . _LOG_ERREUR);
@@ -417,6 +425,7 @@ 
  * @param string /array $champs : liste de champs sur lesquels s'applique l'index
  * @param string $serveur : nom de la connexion sql utilisee
  * @param bool $requeter : true pour executer la requete ou false pour retourner le texte de la requete
+ * @param string $champs
  *
  * @return bool ou requete
  */
@@ -592,6 +601,9 @@ 
 }
 
 // https://code.spip.net/@spip_pg_orderby
+/**
+ * @param string $order
+ */
 function spip_pg_orderby($order, $select) {
 	$res = array();
 	$arg = (is_array($order) ? $order : preg_split('/\s*,\s*/', $order));
@@ -766,6 +778,9 @@ 
 }
 
 // https://code.spip.net/@calculer_pg_where
+/**
+ * @param string $v
+ */
 function calculer_pg_where($v) {
 	if (!is_array($v)) {
 		return spip_pg_frommysql($v);
@@ -791,6 +806,9 @@ 
 
 
 // https://code.spip.net/@calculer_pg_expression
+/**
+ * @param string $expression
+ */
 function calculer_pg_expression($expression, $v, $join = 'AND') {
 	if (empty($v)) {
 		return '';
@@ -842,6 +860,9 @@ 
 }
 
 // https://code.spip.net/@spip_pg_fetch
+/**
+ * @param resource $res
+ */
 function spip_pg_fetch($res, $t = '', $serveur = '', $requeter = true) {
 
 	if ($res) {
@@ -913,6 +934,10 @@ 
 }
 
 // https://code.spip.net/@spip_pg_insert
+/**
+ * @param string $champs
+ * @param string $valeurs
+ */
 function spip_pg_insert($table, $champs, $valeurs, $desc = array(), $serveur = '', $requeter = true) {
 	$connexion = &$GLOBALS['connexions'][$serveur ? strtolower($serveur) : 0];
 	$prefixe = $connexion['prefixe'];
@@ -1149,6 +1174,9 @@ 
 // Pas extensible pour le moment,
 
 // https://code.spip.net/@spip_pg_sequence
+/**
+ * @return string
+ */
 function spip_pg_sequence($table, $raw = false) {
 
 	include_spip('base/serial');
@@ -1312,7 +1340,7 @@ 
  * @param bool $requeter
  *     true pour éxecuter la requête
  *     false pour retourner le texte de la requête.
- * @return ressource
+ * @return resource
  *     Ressource à utiliser avec sql_fetch()
  **/
 function spip_pg_showbase($match, $serveur = '', $requeter = true) {