spip / SPIP

ecrire/req/pg.exp.php

Doc Comments +32 added lines, -1 removed lines

@@ -132,6 +132,11 @@ 
 
 // Par ou ca passe une fois les traductions faites
 // http://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'];
@@ -290,6 +295,9 @@ 
 }
 
 // http://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);
@@ -416,6 +424,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
  */
@@ -591,6 +600,9 @@ 
 }
 
 // http://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));
@@ -765,6 +777,9 @@ 
 }
 
 // http://code.spip.net/@calculer_pg_where
+/**
+ * @param string $v
+ */
 function calculer_pg_where($v) {
 	if (!is_array($v)) {
 		return spip_pg_frommysql($v);
@@ -790,6 +805,9 @@ 
 
 
 // http://code.spip.net/@calculer_pg_expression
+/**
+ * @param string $expression
+ */
 function calculer_pg_expression($expression, $v, $join = 'AND') {
 	if (empty($v)) {
 		return '';
@@ -841,6 +859,9 @@ 
 }
 
 // http://code.spip.net/@spip_pg_fetch
+/**
+ * @param resource $res
+ */
 function spip_pg_fetch($res, $t = '', $serveur = '', $requeter = true) {
 
 	if ($res) {
@@ -912,6 +933,10 @@ 
 }
 
 // http://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'];
@@ -1148,6 +1173,9 @@ 
 // Pas extensible pour le moment,
 
 // http://code.spip.net/@spip_pg_sequence
+/**
+ * @return string
+ */
 function spip_pg_sequence($table, $raw = false) {
 
 	include_spip('base/serial');
@@ -1261,6 +1289,9 @@ 
 }
 
 // http://code.spip.net/@spip_pg_error
+/**
+ * @param string $serveur
+ */
 function spip_pg_error($query = '', $serveur, $requeter = true) {
 	$link = $GLOBALS['connexions'][$serveur ? strtolower($serveur) : 0]['link'];
 	$s = $link ? pg_last_error($link) : pg_last_error();
@@ -1311,7 +1342,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) {

ecrire/xml/analyser_dtd.php

Doc Comments +24 added lines

@@ -167,6 +167,9 @@ 
 }
 
 // http://code.spip.net/@analyser_dtd_comment
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_comment($dtd, &$dtc, $grammaire) {
 	// ejecter les commentaires, surtout quand ils contiennent du code.
 	// Option /s car sur plusieurs lignes parfois
@@ -179,6 +182,9 @@ 
 }
 
 // http://code.spip.net/@analyser_dtd_pi
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_pi($dtd, &$dtc, $grammaire) {
 	if (!preg_match('/^<\?.*?>\s*(.*)$/s', $dtd, $m)) {
 		return -10;
@@ -188,6 +194,9 @@ 
 }
 
 // http://code.spip.net/@analyser_dtd_lexeme
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_lexeme($dtd, &$dtc, $grammaire) {
 
 	if (!preg_match(_REGEXP_ENTITY_DEF, $dtd, $m)) {
@@ -215,6 +224,9 @@ 
 // ca ne depasse pas 3 ici.
 
 // http://code.spip.net/@analyser_dtd_data
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_data($dtd, &$dtc, $grammaire) {
 
 	if (!preg_match(_REGEXP_INCLUDE_USE, $dtd, $m)) {
@@ -236,6 +248,9 @@ 
 }
 
 // http://code.spip.net/@analyser_dtd_notation
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_notation($dtd, &$dtc, $grammaire) {
 	if (!preg_match('/^<!NOTATION.*?>\s*(.*)$/s', $dtd, $m)) {
 		return -8;
@@ -246,6 +261,9 @@ 
 }
 
 // http://code.spip.net/@analyser_dtd_entity
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_entity($dtd, &$dtc, $grammaire) {
 	if (!preg_match(_REGEXP_ENTITY_DECL, $dtd, $m)) {
 		return -2;
@@ -303,6 +321,9 @@ 
 // Fin du controle en finElement
 
 // http://code.spip.net/@analyser_dtd_element
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_element($dtd, &$dtc, $grammaire) {
 	if (!preg_match('/^<!ELEMENT\s+([^>\s]+)([^>]*)>\s*(.*)$/s', $dtd, $m)) {
 		return -3;
@@ -351,6 +372,9 @@ 
 
 
 // http://code.spip.net/@analyser_dtd_attlist
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_attlist($dtd, &$dtc, $grammaire) {
 	if (!preg_match('/^<!ATTLIST\s+(\S+)\s+([^>]*)>\s*(.*)/s', $dtd, $m)) {
 		return -5;

ecrire/xml/sax.php

Doc Comments +9 added lines

@@ -102,6 +102,9 @@ 
 		: xml_entites_html($data);
 }
 
+/**
+ * @param IndenteurXML $phraseur
+ */
 function xml_piElement($phraseur, $target, $data) {
 	$depth = $phraseur->depth;
 
@@ -118,6 +121,9 @@ 
 
 
 // http://code.spip.net/@xml_defautElement
+/**
+ * @param IndenteurXML $phraseur
+ */
 function xml_defaultElement($phraseur, $data) {
 	$depth = $phraseur->depth;
 
@@ -149,6 +155,9 @@ 
 }
 
 // http://code.spip.net/@coordonnees_erreur
+/**
+ * @param string $msg
+ */
 function coordonnees_erreur($phraseur, $msg) {
 	$entete_length = substr_count($phraseur->entete, "\n");
 	$phraseur->err[] = array(

ecrire/inc/securiser_action.php

Doc Comments +1 added lines

@@ -304,6 +304,7 @@
  * @param string $url Url à autoriser en prévisu
  * @param int|null id_auteur qui génère le token de prévisu. Null utilisera auteur courant.
  * @param string $alea Nom de l’alea à utiliser
+ * @param integer $id_auteur
  * @return string Token, de la forme "{id}*{hash}"
  */
 function calculer_token_previsu($url, $id_auteur = null, $alea = 'alea_ephemere') {

ecrire/public/quete.php

Doc Comments +5 added lines, -5 removed lines

@@ -28,9 +28,9 @@ 
 /**
  * Retourne l'URL de redirection d'un article virtuel, seulement si il est publié
  *
- * @param $id_article
- * @param $connect
- * @return array|bool|null
+ * @param integer $id_article
+ * @param string $connect
+ * @return string
  */
 function quete_virtuel($id_article, $connect) {
 	return sql_getfetsel(
@@ -122,7 +122,7 @@ 
  * @uses quete_parent_lang()
  *
  * @param int $id_article
- * @param $serveur
+ * @param string $serveur
  * @return int
  */
 function quete_rubrique($id_article, $serveur) {
@@ -293,7 +293,7 @@ 
  *
  * @param int $id_document
  * @param string $serveur
- * @return array|bool|null
+ * @return string
  */
 function quete_fichier($id_document, $serveur = '') {
 	return sql_getfetsel('fichier', 'spip_documents', ('id_document=' . intval($id_document)), '', array(), '', '', $serveur);

ecrire/inc/lien.php

Doc Comments +13 added lines, -1 removed lines

@@ -42,6 +42,9 @@ 
 define('_RACCOURCI_LIEN', "/\[([^][]*?([[]\w*[]][^][]*)*)->(>?)([^]]*)\]/msS");
 
 // http://code.spip.net/@expanser_liens
+/**
+ * @return string
+ */
 function expanser_liens($t, $connect = '', $env = array()) {
 
 	$t = pipeline('pre_liens', $t);
@@ -56,6 +59,9 @@ 
 // Meme analyse mais pour eliminer les liens
 // et ne laisser que leur titre, a expliciter si ce n'est fait
 // http://code.spip.net/@nettoyer_raccourcis_typo
+/**
+ * @param string $texte
+ */
 function nettoyer_raccourcis_typo($texte, $connect = '') {
 	return $texte;
 }
@@ -96,6 +102,9 @@ 
 // 'url':   seulement U  (i.e. generer_url_RACCOURCI)
 
 // http://code.spip.net/@calculer_url
+/**
+ * @return string
+ */
 function calculer_url($ref, $texte = '', $pour = 'url', $connect = '', $echappe_typo = true) {
 	$r = traiter_lien_implicite($ref, $texte, $pour, $connect, $echappe_typo);
 
@@ -256,7 +265,7 @@ 
  * @param int $id Identifiant de l'objet
  * @param string $type Type d'objet
  * @param string|null $connect Connecteur SQL utilisé
- * @return array {
+ * @return string {
  * @var string $titre Titre si présent, sinon ''
  * @var string $lang Langue si présente, sinon ''
  * }
@@ -302,6 +311,9 @@ 
 define('_RACCOURCI_MODELE_DEBUT', '@^' . _RACCOURCI_MODELE . '@isS');
 
 // http://code.spip.net/@traiter_modeles
+/**
+ * @return string
+ */
 function traiter_modeles($texte, $doublons = false, $echap = '', $connect = '', $liens = null, $env = array()) {
 	// preserver la compatibilite : true = recherche des documents
 	if ($doublons === true) {

ecrire/base/abstract_sql.php

Doc Comments +22 added lines, -22 removed lines

@@ -286,19 +286,19 @@ 
  * @api
  * @uses sql_select()
  *
- * @param array|string $select
+ * @param string $select
  *    Liste des champs a recuperer (Select)
- * @param array|string $from
+ * @param string $from
  *    Tables a consulter (From)
- * @param array|string $where
+ * @param string $where
  *    Conditions a remplir (Where)
- * @param array|string $groupby
+ * @param string $groupby
  *    Critere de regroupement (Group by)
- * @param array|string $orderby
+ * @param string $orderby
  *    Tableau de classement (Order By)
  * @param string $limit
  *    Critere de limite (Limit)
- * @param array $having
+ * @param string $having
  *    Tableau des des post-conditions a remplir (Having)
  * @param string $serveur
  *    Le serveur sollicite (pour retrouver la connexion)
@@ -343,9 +343,9 @@ 
  *    Tables a consulter (From)
  * @param array|string $where
  *    Conditions a remplir (Where)
- * @param array|string $groupby
+ * @param string $groupby
  *    Critere de regroupement (Group by)
- * @param array $having
+ * @param string $having
  *    Tableau des des post-conditions a remplir (Having)
  * @param string $serveur
  *    Le serveur sollicite (pour retrouver la connexion)
@@ -816,9 +816,9 @@ 
  *     Nom de la table
  * @param array $exp
  *     Couples (colonne => valeur)
- * @param string|array $where
+ * @param string $where
  *     Conditions a remplir (Where)
- * @param array $desc
+ * @param string $desc
  *     Tableau de description des colonnes de la table SQL utilisée
  *     (il sera calculé si nécessaire s'il n'est pas transmis).
  * @param string $serveur
@@ -1632,17 +1632,17 @@ 
  *
  * @param array|string $select
  *    Liste des champs a recuperer (Select)
- * @param array|string $from
+ * @param string $from
  *    Tables a consulter (From)
  * @param array|string $where
  *    Conditions a remplir (Where)
- * @param array|string $groupby
+ * @param string $groupby
  *    Critere de regroupement (Group by)
- * @param array|string $orderby
+ * @param string $orderby
  *    Tableau de classement (Order By)
  * @param string $limit
  *    Critere de limite (Limit)
- * @param array $having
+ * @param string $having
  *    Tableau des des post-conditions a remplir (Having)
  * @param string $serveur
  *    Le serveur sollicite (pour retrouver la connexion)
@@ -1700,7 +1700,7 @@ 
  * @api
  * @uses sql_fetsel()
  *
- * @param array|string $select
+ * @param string $select
  *     Liste des champs à récupérer (Select)
  * @param array|string $from
  *     Tables à consulter (From)
@@ -2051,16 +2051,16 @@ 
  * @api
  * @param string $in
  *     Colonne SQL sur laquelle appliquer le test
- * @param array|string $select
+ * @param string $select
  *     Liste des champs à récupérer (Select).
  *     La donnée extraite est le premier élément de la sélection.
- * @param array|string $from
+ * @param string $from
  *     Tables a consulter (From)
- * @param array|string $where
+ * @param string $where
  *     Conditions a remplir (Where)
- * @param array|string $groupby
+ * @param string $groupby
  *     Critere de regroupement (Group by)
- * @param array|string $orderby
+ * @param string $orderby
  *     Tableau de classement (Order By)
  * @param string $limit
  *     Critere de limite (Limit)
@@ -2159,7 +2159,7 @@ 
  *    Nom du connecteur
  * @param bool $option
  *     Inutilisé
- * @return bool
+ * @return integer
  *     True si le champ est de type entier
  */
 function sql_test_int($type, $serveur = '', $option = true) {
@@ -2178,7 +2178,7 @@ 
  *    Nom du connecteur
  * @param bool $option
  *     Inutilisé
- * @return bool
+ * @return integer
  *     True si le champ est de type entier
  */
 function sql_test_date($type, $serveur = '', $option = true) {

ecrire/req/sqlite_fonctions.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
  * @link http://www.sqlite.org/lang_corefunc.html Liste des fonctions natives
  * @link http://sqlite.org/changes.html Liste des évolutions
  * 
- * @param PDO|resource $sqlite Représente la connexion Sqlite
+ * @param PDO $sqlite Représente la connexion Sqlite
  * @return false|void
  */
 function _sqlite_init_functions(&$sqlite) {

ecrire/req/sqlite_generique.php

Doc Comments +6 added lines, -6 removed lines

@@ -1528,8 +1528,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
@@ -1687,7 +1687,7 @@ 
  * @param string $nom_table Nom de la table SQL
  * @param string $serveur Nom de la connexion
  * @param bool $requeter Exécuter la requête, sinon la retourner
- * @return array|string
+ * @return string
  *     - chaîne vide si pas de description obtenue
  *     - string Texte de la requête si demandé
  *     - array description de la table sinon
@@ -2194,7 +2194,7 @@ 
  * 4) Renommer la table B en A
  * 5) Remettre les index (qui sont supprimés avec la table A)
  *
- * @param string|array $table
+ * @param string $table
  *     - string : Nom de la table table,
  *     - array : couple (nom de la table => nom futur)
  * @param string|array $colonne
@@ -2597,7 +2597,7 @@ 
  * stocke le resultat pour ne pas faire
  * de requetes showtable intempestives
  *
- * @param  $table
+ * @param  string $table
  * @param  $couples
  * @param string $desc
  * @param string $serveur
@@ -2789,7 +2789,7 @@ 
 	 * Constructeur
 	 *
 	 * @param string $serveur
-	 * @return bool
+	 * @return false|null
 	 */
 	public function __construct($serveur = '') {
 		_sqlite_init();