spip / SPIP

ecrire/inc/utils.php

Doc Comments +31 added lines, -6 removed lines

@@ -88,6 +88,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);
 }
@@ -180,8 +183,6 @@ 
  *
  * @param string $message
  * @param string|int $name
- * @param string $logdir  ## inutile !! a supprimer ?
- * @param string $logsuf  ## inutile !! a supprimer ?
  */
 function spip_log($message=NULL, $name=NULL) {
 	static $pre = array();
@@ -366,6 +367,10 @@ 
 // pour l'ancre on translitere, vire les non alphanum du debut,
 // et on remplace ceux a l'interieur ou au bout par -
 // http://doc.spip.org/@ancre_url
+/**
+ * @param null|string $url
+ * @param string $ancre
+ */
 function ancre_url($url, $ancre) {
 	// lever l'#ancre
 	if (preg_match(',^([^#]*)(#.*)$,', $url, $r)) {
@@ -596,6 +601,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();
@@ -660,9 +668,9 @@ 
 /**
  * Ajout d'une tache dans la file d'attente
  *
- * @param $function
+ * @param string $function
  *   The function name to call.
- * @param $description
+ * @param string $description
  *   A human-readable description of the queued job.
  * @param $arguments
  *   Optional array of arguments to pass to the function.
@@ -718,7 +726,6 @@ 
  *  - si int, affecte la static directement avec la valeur
  *
  * @staticvar int $queue_next_job_time
- * @param int/bool $force_next
  * @return int
  */
 function queue_sleep_time_to_next_job($force=null) {
@@ -795,6 +802,9 @@ 
 // du path, dans cet ordre.
 // Exception: si un $dossier_squelette est defini, il reste en tete, 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;
@@ -1050,6 +1060,9 @@ 
  * @return array
  */
 // http://doc.spip.org/@find_all_in_path
+/**
+ * @param string $pattern
+ */
 function find_all_in_path($dir,$pattern, $recurs=false){
 	$liste_fichiers=array();
 	$maxfiles = 10000;
@@ -1197,6 +1210,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;
@@ -1440,6 +1456,9 @@ 
 }
 
 // http://doc.spip.org/@generer_url_action
+/**
+ * @param string $script
+ */
 function generer_url_action($script, $args="", $no_entities=false , $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
@@ -2202,7 +2221,7 @@ 
 /**
  * Trouve un squelette dans le repertoire modeles/
  *
- * @param  $nom
+ * @param  string $nom
  * @return string
  */
 function trouve_modele($nom) {
@@ -2256,6 +2275,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;
@@ -2279,6 +2301,9 @@ 
  */
 // Fonction depreciee
 // http://doc.spip.org/@lire_meta
+/**
+ * @param string $nom
+ */
 function lire_meta($nom) {
 	return $GLOBALS['meta'][$nom];
 }

ecrire/iterateur/data.php

Doc Comments +6 added lines, -6 removed lines

@@ -105,7 +105,7 @@ 
 
 	/**
 	 * Declarer les criteres exceptions
-	 * @return array
+	 * @return string[]
 	 */
 	public function exception_des_criteres() {
 		return array('tableau');
@@ -113,7 +113,7 @@ 
 
 	/**
 	 * Recuperer depuis le cache si possible
-	 * @param  $cle
+	 * @param  string|null $cle
 	 * @return
 	 */
 	protected function cache_get($cle) {
@@ -126,8 +126,8 @@ 
 
 	/**
 	 * Stocker en cache si possible
-	 * @param  $cle
-	 * @param  $ttl
+	 * @param  string|null $cle
+	 * @param  integer $ttl
 	 * @return
 	 */
 	protected function cache_set($cle, $ttl, $valeur = null) {
@@ -661,7 +661,7 @@ 
  * lister des fichiers a partir d'un dossier de base et selon une regexp.
  * pour la syntaxe cf la fonction spip preg_files
  * @param string $dir
- * @param string $regexp
+ * @param integer $regexp
  * @param int $limit
  * @return array|bool
  */
@@ -694,7 +694,7 @@ 
 
 /**
  * Object -> tableau
- * @param Object $object
+ * @param SimpleXMLIterator $object
  * @return array|bool
  */
 function XMLObjectToArray($object){

ecrire/maj/svn10000.php

Doc Comments +3 added lines

@@ -346,6 +346,9 @@
 		}
 	}
 }
+/**
+ * @param string $table
+ */
 function maj_liens_insertq_multi_check($table,$couples,$desc=array()){
 	$n_before = sql_countsel($table);
 	sql_insertq_multi($table,$couples,$desc);

ecrire/plugins/infos_plugin.php

Doc Comments -2 removed lines

@@ -116,8 +116,6 @@
  * - 'nom' (= id)
  * - 'compatibilite' (= version)
  *
- * @param array $utilise
- * 		Liste des necessite trouvés pour le plugin
  * @return array
  * 		Liste des necessite modifiés.
  */

ecrire/public/compiler.php

Doc Comments +15 added lines

@@ -57,6 +57,9 @@ 
 
 
 // http://doc.spip.org/@argumenter_inclure
+/**
+ * @param boolean $rejet_filtres
+ */
 function argumenter_inclure($params, $rejet_filtres, $p, &$boucles, $id_boucle, $echap=true, $lang = '', $fond1=false){
 	$l = array();
 	$erreur_p_i_i = '';
@@ -665,6 +668,9 @@ 
 }
 
 // http://doc.spip.org/@calculer_dec
+/**
+ * @param string $nom
+ */
 function calculer_dec($nom, $val)
 {
 	$static = 'if (!isset($command[\''.$nom.'\'])) ';
@@ -712,6 +718,9 @@ 
 }
 
 // http://doc.spip.org/@calculer_from
+/**
+ * @param Boucle $boucle
+ */
 function calculer_from(&$boucle)
 {
   $res = "";
@@ -783,6 +792,9 @@ 
 define('_REGEXP_CONCAT_NON_VIDE', "/^(.*)[.]\s*'[^']+'\s*$/");
 
 // http://doc.spip.org/@compile_cas
+/**
+ * @param string $id_boucle
+ */
 function compile_cas($tableau, $descr, &$boucles, $id_boucle) {
 
         $codes = array();
@@ -960,6 +972,9 @@ 
 // de meme si EXP est de la forme (t ? '' : 'C')
 
 // http://doc.spip.org/@compile_retour
+/**
+ * @param string $tab
+ */
 function compile_retour($code, $avant, $apres, $altern, $tab, $n)
 {
 	if ($avant == "''") $avant = '';

ecrire/public/criteres.php

Doc Comments +13 added lines

@@ -788,6 +788,9 @@ 
 // Code specifique aux criteres {pagination}, {1,n} {n/m} etc
 //
 
+/**
+ * @param string $mode
+ */
 function calculer_parties(&$boucles, $id_boucle, $debut, $mode){
 	$total_parties = $boucles[$id_boucle]->total_parties;
 
@@ -978,6 +981,9 @@ 
 }
 
 // http://doc.spip.org/@critere_IN_cas
+/**
+ * @param string $crit2
+ */
 function critere_IN_cas($idb, &$boucles, $crit2, $arg, $op, $val, $col){
 	static $num = array();
 	$descr = $boucles[$idb]->descr;
@@ -1473,6 +1479,9 @@ 
 
 
 // http://doc.spip.org/@trouver_champ
+/**
+ * @param string $champ
+ */
 function trouver_champ($champ, $where){
 	if (!is_array($where))
 		return preg_match($champ, $where);
@@ -1680,6 +1689,10 @@ 
 }
 
 // http://doc.spip.org/@calculer_param_date
+/**
+ * @param string $date_compare
+ * @param string $date_orig
+ */
 function calculer_param_date($date_compare, $date_orig){
 	if (preg_match(",'\" *\.(.*)\. *\"',", $date_compare, $r)){
 		$init = "'\" . (\$x = $r[1]) . \"'";

ecrire/public/debusquer.php

Doc Comments +10 added lines

@@ -374,6 +374,10 @@ 
 }
 
 // http://doc.spip.org/@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);
 
@@ -459,6 +463,9 @@ 
 
 // l'environnement graphique du debuggueur 
 
+/**
+ * @param null|string $self
+ */
 function debusquer_squelette($fonc, $mode, $self){
 	global $debug_objets;
 
@@ -745,6 +752,9 @@ 
 }
 
 // http://doc.spip.org/@debusquer_entete
+/**
+ * @param string $corps
+ */
 function debusquer_entete($titre, $corps){
 	global $debug_objets;
 	include_spip('balise/formulaire_admin');

ecrire/public/references.php

Doc Comments +17 added lines

@@ -130,6 +130,10 @@ 
 }
 
 // http://doc.spip.org/@index_tables_en_pile
+/**
+ * @param string $nom_champ
+ * @param boolean $joker
+ */
 function index_tables_en_pile($idb, $nom_champ, &$boucles, &$joker) {
 	global $exceptions_des_tables;
 
@@ -568,6 +572,9 @@ 
 
 // Filtres et,ou,oui,non,sinon,xou,xor,and,or,not,yes
 // et comparateurs
+/**
+ * @param string $arg
+ */
 function filtre_logique($fonc, $code, $arg)
 {
 	global $table_criteres_infixes;
@@ -591,6 +598,9 @@ 
 }
 
 // http://doc.spip.org/@compose_filtres_args
+/**
+ * @param string $sep
+ */
 function compose_filtres_args($p, $args, $sep)
 {
 	$arglist = "";
@@ -607,6 +617,9 @@ 
 // ET chez sa maman
 // 
 // http://doc.spip.org/@calculer_argument_precedent
+/**
+ * @param string $defaut
+ */
 function calculer_argument_precedent($idb, $nom_champ, &$boucles, $defaut=null) {
 
 	// si recursif, forcer l'extraction du champ SQL mais ignorer le code
@@ -631,6 +644,10 @@ 
 //
 
 // http://doc.spip.org/@rindex_pile
+/**
+ * @param string $champ
+ * @param string $motif
+ */
 function rindex_pile($p, $champ, $motif) 
 {
 	$n = 0;

ecrire/public/sandbox.php

Doc Comments +1 added lines, -3 removed lines

@@ -20,8 +20,6 @@ 
  * dans les squelette
  *
  * @param string $texte
- * @param string $code
- * @param string $arglist
  * @param Object $p
  * @return string
  */
@@ -85,7 +83,7 @@ 
  * Composer le code d'inclusion PHP
  *
  * @param string $fichier
- * @param Object $p
+ * @param Inclure $p
  * @param array $_contexte
  * @return string
  */