spip / SPIP

ecrire/inc/pclzip.php

Doc Comments +31 added lines

@@ -28,6 +28,11 @@ 
     define('PCLZIP_TEMPORARY_DIR', _DIR_TMP);
   }
   if (!function_exists('gzopen') && function_exists('gzopen64')) {
+
+    /**
+     * @param string $filename
+     * @param string $mode
+     */
     function gzopen($filename, $mode, $use_include_path = 0) {
       return gzopen64($filename, $mode, $use_include_path);
     }
@@ -221,6 +226,10 @@ 
   //   Note that no real action is taken, if the archive does not exist it is not
   //   created. Use create() for that.
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param string $p_zipname
+   */
   function PclZip($p_zipname)
   {
 
@@ -2344,6 +2353,10 @@ 
   // Description :
   // Parameters :
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param string $p_mode
+   */
   function privOpenFd($p_mode)
   {
     $v_result=1;
@@ -4160,6 +4173,10 @@ 
   // Parameters :
   // Return Values :
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param string $p_string
+   */
   function privExtractFileAsString(&$p_entry, &$p_string, &$p_options)
   {
     $v_result=1;
@@ -5053,6 +5070,10 @@ 
   // Parameters :
   // Return Values :
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param PclZip $p_archive_to_add
+   */
   function privMerge(&$p_archive_to_add)
   {
     $v_result=1;
@@ -5560,6 +5581,11 @@ 
   //             3 : src & dest gzip
   // Return Values :
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param integer $p_src
+   * @param integer $p_dest
+   */
   function PclZipUtilCopyBlock($p_src, $p_dest, $p_size, $p_mode=0)
   {
     $v_result = 1;
@@ -5622,6 +5648,11 @@ 
   // Return Values :
   //   1 on success, 0 on failure.
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param string $p_src
+   * @param string $p_dest
+   */
   function PclZipUtilRename($p_src, $p_dest)
   {
     $v_result = 1;

ecrire/inc/prepare_recherche.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
  * @param string $primary
  * @param array $rows
  * @param string $serveur
- * @return array
+ * @return string[]
  */
 function generer_select_where_explicites($table, $primary, $rows, $serveur){
 	# calculer le {id_article IN()} et le {... as points}

ecrire/plugins/afficher_plugin.php

Doc Comments +7 added lines

@@ -101,6 +101,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);
@@ -162,6 +166,9 @@ 
 	. "</div>";
 }
 
+/**
+ * @param string $nom
+ */
 function plugin_desintalle($plug_file, $nom, $dir_plugins=null){
 	if (!$dir_plugins)
 		$dir_plugins = _DIR_PLUGINS;

ecrire/public/iterateur.php

Doc Comments +4 added lines

@@ -412,6 +412,10 @@
 	 * aller a la position $n en parcourant
 	 * un par un tous les elements
 	 */
+
+	/**
+	 * @param integer $n
+	 */
 	private function seek_loop($n) {
 		if ($this->pos > $n)
 			$this->rewind();

ecrire/public/jointures.php

Doc Comments +1 added lines, -1 removed lines

@@ -211,7 +211,7 @@
  *
  * @param array $depart
  * @param array $arrivee
- * @param string|array $col
+ * @param string $col
  * @return bool
  */
 function nogroupby_if($depart, $arrivee, $col){

ecrire/action/calculer_taille_cache.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
  *
  * http://doc.spip.org/@calculer_taille_dossier
  *
- * @param $dir
+ * @param string|null $dir
  * @return int
  */
 function calculer_taille_dossier ($dir) {

ecrire/action/converser.php

Doc Comments +3 added lines

@@ -35,6 +35,9 @@
 	redirige_par_entete($redirect, true);
 }
 
+/**
+ * @param boolean $update_session
+ */
 function action_converser_changer_langue($update_session){
 	if ($lang = _request('var_lang'))
 		action_converser_post($lang);

ecrire/action/editer_auteur.php

Doc Comments +1 added lines, -1 removed lines

@@ -221,7 +221,7 @@
  * @param  $id_auteur
  * @param  $c
  * @param bool $force_webmestre
- * @return bool|string
+ * @return false|string
  */
 function auteur_instituer($id_auteur, $c, $force_webmestre = false) {
 	if (!$id_auteur=intval($id_auteur))

ecrire/base/abstract_sql.php

Doc Comments +38 added lines, -11 removed lines

@@ -208,19 +208,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)
@@ -249,9 +249,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)
@@ -507,6 +507,9 @@ 
 }
 
 // http://doc.spip.org/@sql_update
+/**
+ * @param string $table
+ */
 function sql_update($table, $exp, $where='', $desc=array(), $serveur='', $option=true)
 {
 	$f = sql_serveur('update', $serveur,  $option==='continue' OR $option===false);
@@ -540,6 +543,9 @@ 
 }
 
 // http://doc.spip.org/@sql_replace
+/**
+ * @param string $table
+ */
 function sql_replace($table, $couples, $desc=array(), $serveur='', $option=true)
 {
 	$f = sql_serveur('replace', $serveur,  $option==='continue' OR $option===false);
@@ -663,6 +669,9 @@ 
 }
 
 // http://doc.spip.org/@sql_create
+/**
+ * @param string $nom
+ */
 function sql_create($nom, $champs, $cles=array(), $autoinc=false, $temporary=false, $serveur='', $option=true) {
 	$f = sql_serveur('create', $serveur,  $option==='continue' OR $option===false);
 	if (!is_string($f) OR !$f) return false;
@@ -694,6 +703,9 @@ 
 }
 
 // http://doc.spip.org/@sql_multi
+/**
+ * @param string $sel
+ */
 function sql_multi($sel, $lang, $serveur='', $option=true)
 {
 	$f = sql_serveur('multi', $serveur,  $option==='continue' OR $option===false);
@@ -753,6 +765,9 @@ 
 }
 
 // http://doc.spip.org/@sql_repair
+/**
+ * @return string
+ */
 function sql_repair($table, $serveur='', $option=true) {
 	$f = sql_serveur('repair', $serveur,  $option==='continue' OR $option===false);
 	if (!is_string($f) OR !$f) return false;
@@ -765,6 +780,9 @@ 
 // A n'utiliser qu'en derniere extremite
 
 // http://doc.spip.org/@sql_query
+/**
+ * @param string $ins
+ */
 function sql_query($ins, $serveur='', $option=true) {
 	$f = sql_serveur('query', $serveur,  $option==='continue' OR $option===false);
 	if (!is_string($f) OR !$f) return false;
@@ -852,13 +870,13 @@ 
  * 		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)
@@ -1107,6 +1125,11 @@ 
 	return $f($val, $type);
 }
 
+/**
+ * @param string $champ
+ * @param double $interval
+ * @param string $unite
+ */
 function sql_date_proche($champ, $interval, $unite, $serveur='', $option=true)
 {
 	$f = sql_serveur('date_proche', $serveur, true);
@@ -1159,6 +1182,10 @@ 
 // s'il accepte les requetes imbriquees afin d'optimiser ca
 
 // http://doc.spip.org/@sql_in_select
+/**
+ * @param string $in
+ * @param string $select
+ */
 function sql_in_select($in, $select, $from = array(), $where = array(),
 		    $groupby = array(), $orderby = array(), $limit = '', $having = array(), $serveur='')
 {