spip / SPIP

ecrire/req/mysql.php

Doc Comments +3 added lines, -3 removed lines

@@ -315,8 +315,8 @@ 
  * @param string|array $select   Champs sélectionnés
  * @param string|array $from     Tables sélectionnées
  * @param string|array $where    Contraintes
- * @param string|array $groupby  Regroupements
- * @param string|array $orderby  Tris
+ * @param string $groupby  Regroupements
+ * @param string $orderby  Tris
  * @param string $limit          Limites de résultats
  * @param string|array $having   Contraintes posts sélections
  * @param string $serveur        Nom de la connexion
@@ -881,7 +881,7 @@ 
  * @param int $row_number  Position. Déplacer le pointeur à cette ligne
  * @param string $serveur  Nom de la connexion
  * @param bool $requeter   Inutilisé
- * @return bool True si déplacement réussi, false sinon.
+ * @return boolean|null True si déplacement réussi, false sinon.
 **/
 function spip_mysql_seek($r, $row_number, $serveur='',$requeter=true) {
 	if ($r and mysqli_num_rows($r)) return mysqli_data_seek($r,$row_number);

ecrire/inc/filtres.php

Doc Comments +42 added lines

@@ -53,6 +53,9 @@ 
 }
 
 // http://doc.spip.org/@appliquer_filtre
+/**
+ * @param string $filtre
+ */
 function appliquer_filtre($arg, $filtre) {
 	$f = chercher_filtre($filtre);
 	if (!$f)
@@ -79,6 +82,9 @@ 
 // (numero non garanti pour l'espace public et en cas de mutualisation)
 // on est negatif si on est sur .svn, et positif si on utilise svn.revision
 // http://doc.spip.org/@version_svn_courante
+/**
+ * @param string $dir
+ */
 function version_svn_courante($dir) {
 	if (!$dir) $dir = '.';
 
@@ -131,6 +137,9 @@ 
 
 // charge les fonctions graphiques et applique celle demandee
 // http://doc.spip.org/@filtrer
+/**
+ * @param string $filtre
+ */
 function filtrer($filtre) {
 	include_spip('public/parametrer'); // charger les fichiers fonctions
 	if (is_string($f = $GLOBALS['spip_matrice'][$filtre]))
@@ -334,12 +343,18 @@ 
 // preserver des echappements de caracteres "bas" (par exemple [ ou ")
 // et au cas particulier de & qui devient & dans les url
 // http://doc.spip.org/@corriger_entites_html
+/**
+ * @param string $texte
+ */
 function corriger_entites_html($texte) {
 	if (strpos($texte,'&') === false) return $texte;
 	return preg_replace(',&(#[0-9][0-9][0-9]+;|amp;),iS', '&\1', $texte);
 }
 // idem mais corriger aussi les é en é
 // http://doc.spip.org/@corriger_toutes_entites_html
+/**
+ * @param string $texte
+ */
 function corriger_toutes_entites_html($texte) {
 	if (strpos($texte,'&') === false) return $texte;
 	return preg_replace(',&(#?[a-z0-9]+;),iS', '&\1', $texte);
@@ -676,6 +691,9 @@ 
 
 // on normalise la date, si elle vient du contexte (public/parametrer.php), on force le jour
 // http://doc.spip.org/@normaliser_date
+/**
+ * @param string $date
+ */
 function normaliser_date($date, $forcer_jour = false) {
 	$date = vider_date($date);
 	if ($date) {
@@ -899,6 +917,9 @@ 
 }
 
 // http://doc.spip.org/@affdate_base
+/**
+ * @param string $vue
+ */
 function affdate_base($numdate, $vue, $param = '') {
 	global $spip_lang;
 	$date_array = recup_date($numdate, false);
@@ -1056,6 +1077,9 @@ 
 }
 
 // http://doc.spip.org/@affdate_heure
+/**
+ * @return string
+ */
 function affdate_heure($numdate) {
 	$date_array = recup_date($numdate);
 	if (!$date_array) return;
@@ -1345,6 +1369,9 @@ 
 // Extraire et transformer les blocs multi ; on indique la langue courante
 // pour ne pas mettre de span@lang=fr si on est deja en fr
 // http://doc.spip.org/@extraire_multi
+/**
+ * @param string $lang
+ */
 function extraire_multi($letexte, $lang=null, $echappe_span=false) {
 	if (strpos($letexte, '<multi>') === false) return $letexte; // perf
 	if (preg_match_all(_EXTRAIRE_MULTI, $letexte, $regs, PREG_SET_ORDER)) {
@@ -1419,6 +1446,9 @@ 
 
 // convertit le contenu d'une balise multi en un tableau
 // http://doc.spip.org/@extraire_trad
+/**
+ * @param string $bloc
+ */
 function extraire_trads($bloc) {
 	$lang = '';
 // ce reg fait planter l'analyse multi s'il y a de l'{italique} dans le champ
@@ -1470,6 +1500,9 @@ 
 // Exemple [(#COMPTEUR_BOUCLE|alterner{'bleu','vert','rouge'})]
 //
 // http://doc.spip.org/@alterner
+/**
+ * @param integer $i
+ */
 function alterner($i) {
 	// recuperer les arguments (attention fonctions un peu space)
 	$num = func_num_args();
@@ -1753,6 +1786,10 @@ 
 }
 // fabrique un bouton de type $t de Name $n, de Value $v et autres attributs $a
 // http://doc.spip.org/@boutonne
+/**
+ * @param string $t
+ * @param string $n
+ */
 function boutonne($t, $n, $v, $a='') {
 	return "\n<input type='$t'"
 	. (!$n ? '' : " name='$n'")
@@ -2289,6 +2326,9 @@ 
 // attention le htmlentities et la traduction doivent etre appliques avant.
 
 // http://doc.spip.org/@http_wrapper
+/**
+ * @return string
+ */
 function http_wrapper($img){
 	if (strpos($img,'/')===FALSE) // on ne prefixe par _NOM_IMG_PACK que si c'est un nom de fichier sans chemin
 		$f = chemin_image($img);
@@ -2584,6 +2624,8 @@ 
  * Afficher un message "un truc"/"N trucs"
  *
  * @param int $nb
+ * @param string $chaine_un
+ * @param string $chaine_plusieurs
  * @return string
  */
 function singulier_ou_pluriel($nb,$chaine_un,$chaine_plusieurs,$var='nb'){

ecrire/inc/utils.php

Doc Comments +30 added lines

@@ -62,6 +62,9 @@ 
 // la fonction cherchant un fichier PHP dans le SPIP_PATH
 //
 // http://doc.spip.org/@include_spip
+/**
+ * @param string $f
+ */
 function include_spip($f, $include = true) {
 	return find_in_path($f . '.php', '', $include);
 }
@@ -178,6 +181,9 @@ 
 // Methode set de la fonction _request()
 // Attention au cas ou l'on fait set_request('truc', NULL);
 // http://doc.spip.org/@set_request
+/**
+ * @param string $var
+ */
 function set_request($var, $val = NULL, $c=false) {
 	if (is_array($c)) {
 		unset($c[$var]);
@@ -394,6 +400,9 @@ 
 // Remplacer les variables @....@ par leur valeur dans une chaine de langue.
 // Aussi appelee quand une chaine n'est pas encore dans les fichiers de langue
 // http://doc.spip.org/@_L
+/**
+ * @param string $class
+ */
 function _L($text, $args=array(), $class=NULL) {
 	$f = $text;
 	if (is_array($args)) {
@@ -459,6 +468,9 @@ 
 // Renvoie False si un fichier n'est pas plus vieux que $duree secondes,
 // sinon renvoie True et le date sauf si ca n'est pas souhaite
 // http://doc.spip.org/@spip_touch
+/**
+ * @param string $fichier
+ */
 function spip_touch($fichier, $duree=0, $touch=true) {
 	if ($duree) {
 		clearstatcache();
@@ -576,6 +588,9 @@ 
 // retourne le chemin courant sinon, sous forme de array
 // seul le dossier squelette peut etre modifie en dehors de cette fonction, pour raison historique
 // http://doc.spip.org/@_chemin
+/**
+ * @param string $dir_path
+ */
 function _chemin($dir_path=NULL){
 	static $path_base = NULL;
 	static $path_full = NULL;
@@ -878,6 +893,9 @@ 
 }
 
 // http://doc.spip.org/@generer_url_entite_absolue
+/**
+ * @param boolean|string $connect
+ */
 function generer_url_entite_absolue($id='', $entite='', $args='', $ancre='', $connect=NULL)
 {
 	if (!$connect) $connect = true;
@@ -1077,6 +1095,9 @@ 
 // qui ne sont pas destines a etre mis en signets
 
 // http://doc.spip.org/@generer_form_action
+/**
+ * @param string $corps
+ */
 function generer_form_action($script, $corps, $atts='', $public=false) {
 	// si l'on est dans l'espace prive, on garde dans l'url
 	// l'exec a l'origine de l'action, qui permet de savoir si il est necessaire
@@ -1815,6 +1836,9 @@ 
 		return $options['trim'] ? ltrim($texte) : $texte;
 }
 
+/**
+ * @param string $nom
+ */
 function trouve_modele($nom)
 {
 	return find_in_path( 'modeles/' . $nom.'.'. _EXTENSION_SQUELETTES);
@@ -1822,6 +1846,9 @@ 
 
 // Charger dynamiquement une extension php
 // http://doc.spip.org/@charger_php_extension
+/**
+ * @param string $module
+ */
 function charger_php_extension($module) {
 	if (extension_loaded($module)) {
 		return true;
@@ -1839,6 +1866,9 @@ 
  */
 // Fonction depreciee
 // http://doc.spip.org/@lire_meta
+/**
+ * @param string $nom
+ */
 function lire_meta($nom) {
 	return $GLOBALS['meta'][$nom];
 }