spip / SPIP

ecrire/inc/distant.php

Doc Comments +12 added lines

@@ -110,6 +110,9 @@ 
 }
 
 // http://doc.spip.org/@prepare_donnees_post
+/**
+ * @param string $donnees
+ */
 function prepare_donnees_post($donnees, $boundary = '') {
 
 	// permettre a la fonction qui a demande le post de formater elle meme ses donnees
@@ -211,6 +214,9 @@ 
 //   dans lequel on ecrit directement la page
 // * si c'est true/null ca correspond a une demande d'encodage/charset
 // http://doc.spip.org/@recuperer_page
+/**
+ * @param integer $taille_max
+ */
 function recuperer_page($url, $trans = false, $get_headers = false,
                         $taille_max = null, $datas = '', $boundary = '', $refuser_gz = false,
                         $date_verif = '', $uri_referer = ''){
@@ -655,6 +661,9 @@ 
 // retourne le descripteur sur lequel lire la reponse
 //
 // http://doc.spip.org/@init_http
+/**
+ * @param string $method
+ */
 function init_http($method, $url, $refuse_gz = false, $referer = '', $datas = "", $vers = "HTTP/1.0", $date = ''){
 	$user = $via_proxy = $proxy_user = '';
 	$fopen = false;
@@ -699,6 +708,9 @@ 
 }
 
 // http://doc.spip.org/@lance_requete
+/**
+ * @param string $noproxy
+ */
 function lance_requete($method, $scheme, $user, $host, $path, $port, $noproxy, $refuse_gz = false, $referer = '', $datas = "", $vers = "HTTP/1.0", $date = ''){
 
 	$proxy_user = '';

ecrire/inc/drapeau_edition.php

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
 }
 
 // http://doc.spip.org/@exec_meme_rubrique_args
+/**
+ * @param integer $id
+ */
 function exec_meme_rubrique_args($id, $type, $order)
 {
         if ((!autoriser('publierdans','rubrique',$id))

ecrire/inc/editer.php

Doc Comments +17 added lines, -2 removed lines

@@ -57,6 +57,9 @@ 
 }
 
 // http://doc.spip.org/@formulaires_editer_objet_verifier
+/**
+ * @param string $type
+ */
 function formulaires_editer_objet_verifier($type,$id='new', $oblis = array()){
 	$erreurs = array();
 	if (intval($id)) {
@@ -79,6 +82,9 @@ 
 }
 
 // http://doc.spip.org/@formulaires_editer_objet_charger
+/**
+ * @param string $type
+ */
 function formulaires_editer_objet_charger($type, $id='new', $id_parent=0, $lier_trad=0, $retour='', $config_fonc='articles_edit_config', $row=array(), $hidden=''){
 	$table_objet = table_objet($type);
 	$table_objet_sql = table_objet_sql($type);
@@ -200,6 +206,9 @@ 
 }
 
 // http://doc.spip.org/@editer_texte_recolle
+/**
+ * @param string $att_text
+ */
 function editer_texte_recolle($texte, $att_text)
 {
 	if ((strlen($texte)<29*1024)
@@ -222,8 +231,8 @@ 
 /**
  * auto-renseigner le titre si il n'existe pas
  *
- * @param $champ_titre
- * @param $champs_contenu
+ * @param string $champ_titre
+ * @param string[] $champs_contenu
  * @param int $longueur
  */
 function titre_automatique($champ_titre,$champs_contenu,$longueur=null){
@@ -296,6 +305,9 @@ 
 }
 
 // http://doc.spip.org/@controler_contenu
+/**
+ * @param string $id
+ */
 function controler_contenu($type, $id, $options=array(), $c=false, $serveur='') {
 	include_spip('inc/filtres');
 
@@ -366,6 +378,9 @@ 
 // Controle la liste des md5 envoyes, supprime les inchanges,
 // signale les modifies depuis telle date
 // http://doc.spip.org/@controler_md5
+/**
+ * @param string $serveur
+ */
 function controler_md5(&$champs, $ctr, $type, $id, $serveur, $prefix = 'ctr_') {
 	$table_objet = table_objet($type);
 	$spip_table_objet = table_objet_sql($type);

ecrire/inc/filtres.php

Doc Comments +52 added lines, -3 removed lines

@@ -37,7 +37,7 @@ 
  * http://doc.spip.org/@chercher_filtre
  *
  * @param string $fonc
- * @param null $default
+ * @param string $default
  * @return string
  */
 function chercher_filtre($fonc, $default=NULL) {
@@ -117,6 +117,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 = '.';
 
@@ -169,6 +172,9 @@ 
 
 // charge les fonctions graphiques et applique celle demandee
 // http://doc.spip.org/@filtrer
+/**
+ * @param string $filtre
+ */
 function filtrer($filtre) {
 	if (isset($GLOBALS['spip_matrice'][$filtre]) and is_string($f = $GLOBALS['spip_matrice'][$filtre])){
 		find_in_path($f,'', true);
@@ -363,12 +369,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);
@@ -434,6 +446,9 @@ 
 
 // caracteres de controle - http://www.w3.org/TR/REC-xml/#charsets
 // http://doc.spip.org/@supprimer_caracteres_illegaux
+/**
+ * @param string $texte
+ */
 function supprimer_caracteres_illegaux($texte) {
 	static $from = "\x0\x1\x2\x3\x4\x5\x6\x7\x8\xB\xC\xE\xF\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F";
 	static $to = null;
@@ -461,7 +476,7 @@ 
  * http://doc.spip.org/@texte_backend
  *
  * @param $texte
- * @return mixed
+ * @return string
  */
 function texte_backend($texte) {
 
@@ -591,6 +606,9 @@ 
 
 // Transformer les sauts de paragraphe en simples passages a la ligne
 // http://doc.spip.org/@PtoBR
+/**
+ * @param string $texte
+ */
 function PtoBR($texte){
 	$u = $GLOBALS['meta']['pcre_u'];
 	$texte = preg_replace("@</p>@iS", "\n", $texte);
@@ -649,6 +667,9 @@ 
 
 // "127.4 ko" ou "3.1 Mo"
 // http://doc.spip.org/@taille_en_octets
+/**
+ * @param integer $taille
+ */
 function taille_en_octets ($taille) {
 	if ($taille < 1) return '';
 	if ($taille < 1024) {$taille = _T('taille_octets', array('taille' => $taille));}
@@ -753,6 +774,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) {
@@ -979,7 +1003,7 @@ 
  * http://doc.spip.org/@affdate_base
  *
  * @param $numdate
- * @param $vue
+ * @param string $vue
  * @param array $options
  *   param : 'abbr' ou 'initiale' permet d'afficher les jours au format court ou initiale
  *   annee_courante : permet de definir l'annee de reference pour l'affichage des dates courtes
@@ -1096,12 +1120,18 @@ 
 }
 
 // http://doc.spip.org/@nom_jour
+/**
+ * @param string $numdate
+ */
 function nom_jour($numdate, $forme = '') {
 	if(!($forme == 'abbr' OR $forme == 'initiale')) $forme = '';
 	return affdate_base($numdate, 'nom_jour', $forme);
 }
 
 // http://doc.spip.org/@jour
+/**
+ * @param string $numdate
+ */
 function jour($numdate) {
 	return affdate_base($numdate, 'jour');
 }
@@ -1148,6 +1178,10 @@ 
 }
 
 // http://doc.spip.org/@affdate_jourcourt
+/**
+ * @param string $numdate
+ * @param string $annee_courante
+ */
 function affdate_jourcourt($numdate, $annee_courante=null) {
 	return affdate_base($numdate, 'jourcourt', array('annee_courante'=>$annee_courante));
 }
@@ -1342,6 +1376,9 @@ 
 // date_iso retourne la date au format "RFC 3339" / "ISO 8601"
 // voir http://www.php.net/manual/fr/ref.datetime.php#datetime.constants
 // http://doc.spip.org/@date_iso
+/**
+ * @param string $date_heure
+ */
 function date_iso($date_heure) {
 	list($annee, $mois, $jour) = recup_date($date_heure);
 	list($heures, $minutes, $secondes) = recup_heure($date_heure);
@@ -1451,6 +1488,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 (preg_match_all(_EXTRAIRE_MULTI, $letexte, $regs, PREG_SET_ORDER)) {
 		if (!$lang) $lang = $GLOBALS['spip_lang'];
@@ -1490,6 +1530,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
@@ -1555,6 +1598,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();
@@ -1897,6 +1943,9 @@ 
 // l'URL donnee en argument, compatible avec les types_urls depuis [14447].
 // cf. tests/filtres/form_hidden.html
 // http://doc.spip.org/@form_hidden
+/**
+ * @param string $action
+ */
 function form_hidden($action) {
 
 	$contexte = array();

ecrire/inc/filtres_images_lib_mini.php

Doc Comments +8 added lines, -3 removed lines

@@ -74,7 +74,7 @@ 
  *
  * @param bool|string $stat
  * 		true, false ou le statut déjà défini si traitements enchaînés.
- * @return bool
+ * @return false|null
  * 		true si il faut supprimer le fichier temporaire ; false sinon.
  */
 function statut_effacer_images_temporaires($stat){
@@ -472,7 +472,7 @@ 
  * Crée un fichier_image temporaire .src ou vérifie que le fichier_image
  * définitif a bien été créé.
  *
- * @param ressource $img
+ * @param resource $img
  * 		Une ressource de type Image GD.
  * @param array $valeurs
  * 		Un tableau des informations (tailles, traitement, path...) accompagnant
@@ -943,6 +943,11 @@ 
 }
 
 // http://doc.spip.org/@process_image_reduire
+/**
+ * @param boolean $force
+ * @param boolean $cherche_image
+ * @param string $process
+ */
 function process_image_reduire($fonction,$img,$taille,$taille_y,$force,$cherche_image,$process){
 	$image = false;
 	if (($process == 'AUTO') AND isset($GLOBALS['meta']['image_process']))
@@ -1070,7 +1075,7 @@ 
 	}
 
 	/**
-	 * @param array $gd_image_array
+	 * @param ressource[] $gd_image_array
 	 * @return string
 	 */
 	public static function GD2ICOstring(&$gd_image_array) {

ecrire/inc/flock.php

Doc Comments +9 added lines, -2 removed lines

@@ -26,6 +26,10 @@ 
 
 $GLOBALS['liste_verrous'] = array();
 // http://doc.spip.org/@spip_fopen_lock
+/**
+ * @param string $mode
+ * @param integer $verrou
+ */
 function spip_fopen_lock($fichier,$mode,$verrou){
 	if (_SPIP_LOCK_MODE==1){
 		if ($fl = @fopen($fichier,$mode))
@@ -202,7 +206,7 @@ 
  * Ecrire un contenu dans un fichier encapsule en php pour en empecher l'acces en l'absence
  * de htaccess
  * @param string $fichier
- * @param <type> $contenu
+ * @param string $contenu
  * @param <type> $ecrire_quand_meme
  * @param <type> $truncate 
  */
@@ -250,6 +254,9 @@ 
 //
 
 // http://doc.spip.org/@jeune_fichier
+/**
+ * @param integer $n
+ */
 function jeune_fichier($fichier, $n)
 {
 	if (!file_exists($fichier)) return false;
@@ -292,7 +299,7 @@ 
 /**
  * clearstatcache adapte a la version PHP
  * @param bool $clear_realpath_cache
- * @param null $filename
+ * @param string $filename
  */
 function spip_clearstatcache($clear_realpath_cache = false, $filename=null){
 	if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 50300) {

ecrire/inc/install.php

Doc Comments +11 added lines

@@ -252,6 +252,11 @@ 
 }
 
 // http://doc.spip.org/@info_progression_etape
+/**
+ * @param integer $en_cours
+ * @param string $phase
+ * @param string $dir
+ */
 function info_progression_etape($en_cours,$phase,$dir, $erreur = false){
 	//$en_cours = _request('etape')?_request('etape'):"";
 	$liste = find_all_in_path($dir,$phase.'(([0-9])+|fin)[.]php$');
@@ -361,6 +366,9 @@ 
 }
 
 // http://doc.spip.org/@install_connexion_form
+/**
+ * @param integer $etape
+ */
 function install_connexion_form($db, $login, $pass, $predef, $hidden, $etape, $jquery=true)
 {
 	$server_db = (is_string($predef[0])) ? $predef[0] : '';
@@ -521,6 +529,9 @@ 
 	return array($checked, $bases);
 }
 
+/**
+ * @param string[] $hidden
+ */
 function install_propager($hidden)
 {
 	$res = '';

ecrire/inc/invalideur.php

Doc Comments +6 added lines

@@ -24,6 +24,9 @@ 
 // Donne le nombre de fichiers dans un repertoire (plat, pour aller vite)
 // false si erreur
 // http://doc.spip.org/@nombre_de_fichiers_repertoire
+/**
+ * @param string $dir
+ */
 function nombre_de_fichiers_repertoire($dir,$nb_estim_taille = 20) {
 	$taille = 0; // mesurer la taille de N fichiers au hasard dans le repertoire
 	$nb = $nb_estim_taille;
@@ -249,6 +252,9 @@ 
 
 // Calcul des pages : noter dans la base les liens d'invalidation
 // http://doc.spip.org/@maj_invalideurs
+/**
+ * @param string $fichier
+ */
 function maj_invalideurs ($fichier, &$page) { }
 
 // les invalideurs sont de la forme "objet/id_objet"

ecrire/inc/lien.php

Doc Comments +6 added lines

@@ -45,6 +45,9 @@ 
 // Meme analyse mais pour eliminer les liens
 // et ne laisser que leur titre, a expliciter si ce n'est fait
 // http://doc.spip.org/@nettoyer_raccourcis_typo
+/**
+ * @param string|null $texte
+ */
 function nettoyer_raccourcis_typo($texte, $connect='')
 {
 
@@ -199,6 +202,9 @@ 
 }
 
 // Retourne le champ textuel associe a une cle primaire, et sa langue
+/**
+ * @param string $connect
+ */
 function traiter_raccourci_titre($id, $type, $connect=NULL)
 {
 	$trouver_table = charger_fonction('trouver_table', 'base');