Completed
Pull Request — master (#39)
by
unknown
09:06
created
ecrire/xml/sax.php 1 patch
Doc Comments   +9 added lines patch added patch discarded remove patch
@@ -102,6 +102,9 @@  discard block
 block discarded – undo
102 102
 		: xml_entites_html($data);
103 103
 }
104 104
 
105
+/**
106
+ * @param IndenteurXML $phraseur
107
+ */
105 108
 function xml_piElement($phraseur, $target, $data) {
106 109
 	$depth = $phraseur->depth;
107 110
 
@@ -118,6 +121,9 @@  discard block
 block discarded – undo
118 121
 
119 122
 
120 123
 // http://code.spip.net/@xml_defautElement
124
+/**
125
+ * @param IndenteurXML $phraseur
126
+ */
121 127
 function xml_defaultElement($phraseur, $data) {
122 128
 	$depth = $phraseur->depth;
123 129
 
@@ -149,6 +155,9 @@  discard block
 block discarded – undo
149 155
 }
150 156
 
151 157
 // http://code.spip.net/@coordonnees_erreur
158
+/**
159
+ * @param string $msg
160
+ */
152 161
 function coordonnees_erreur($phraseur, $msg) {
153 162
 	$entete_length = substr_count($phraseur->entete, "\n");
154 163
 	$phraseur->err[] = array(
Please login to merge, or discard this patch.
ecrire/inc/securiser_action.php 1 patch
Doc Comments   +1 added lines patch added patch discarded remove patch
@@ -304,6 +304,7 @@
 block discarded – undo
304 304
  * @param string $url Url à autoriser en prévisu
305 305
  * @param int|null id_auteur qui génère le token de prévisu. Null utilisera auteur courant.
306 306
  * @param string $alea Nom de l’alea à utiliser
307
+ * @param integer $id_auteur
307 308
  * @return string Token, de la forme "{id}*{hash}"
308 309
  */
309 310
 function calculer_token_previsu($url, $id_auteur = null, $alea = 'alea_ephemere') {
Please login to merge, or discard this patch.
ecrire/public/quete.php 1 patch
Doc Comments   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -28,9 +28,9 @@  discard block
 block discarded – undo
28 28
 /**
29 29
  * Retourne l'URL de redirection d'un article virtuel, seulement si il est publié
30 30
  *
31
- * @param $id_article
32
- * @param $connect
33
- * @return array|bool|null
31
+ * @param integer $id_article
32
+ * @param string $connect
33
+ * @return string
34 34
  */
35 35
 function quete_virtuel($id_article, $connect) {
36 36
 	return sql_getfetsel(
@@ -122,7 +122,7 @@  discard block
 block discarded – undo
122 122
  * @uses quete_parent_lang()
123 123
  *
124 124
  * @param int $id_article
125
- * @param $serveur
125
+ * @param string $serveur
126 126
  * @return int
127 127
  */
128 128
 function quete_rubrique($id_article, $serveur) {
@@ -293,7 +293,7 @@  discard block
 block discarded – undo
293 293
  *
294 294
  * @param int $id_document
295 295
  * @param string $serveur
296
- * @return array|bool|null
296
+ * @return string
297 297
  */
298 298
 function quete_fichier($id_document, $serveur = '') {
299 299
 	return sql_getfetsel('fichier', 'spip_documents', ('id_document=' . intval($id_document)), '', array(), '', '', $serveur);
Please login to merge, or discard this patch.
ecrire/inc/lien.php 1 patch
Doc Comments   +13 added lines, -1 removed lines patch added patch discarded remove patch
@@ -42,6 +42,9 @@  discard block
 block discarded – undo
42 42
 define('_RACCOURCI_LIEN', "/\[([^][]*?([[]\w*[]][^][]*)*)->(>?)([^]]*)\]/msS");
43 43
 
44 44
 // http://code.spip.net/@expanser_liens
45
+/**
46
+ * @return string
47
+ */
45 48
 function expanser_liens($t, $connect = '', $env = array()) {
46 49
 
47 50
 	$t = pipeline('pre_liens', $t);
@@ -56,6 +59,9 @@  discard block
 block discarded – undo
56 59
 // Meme analyse mais pour eliminer les liens
57 60
 // et ne laisser que leur titre, a expliciter si ce n'est fait
58 61
 // http://code.spip.net/@nettoyer_raccourcis_typo
62
+/**
63
+ * @param string $texte
64
+ */
59 65
 function nettoyer_raccourcis_typo($texte, $connect = '') {
60 66
 	return $texte;
61 67
 }
@@ -96,6 +102,9 @@  discard block
 block discarded – undo
96 102
 // 'url':   seulement U  (i.e. generer_url_RACCOURCI)
97 103
 
98 104
 // http://code.spip.net/@calculer_url
105
+/**
106
+ * @return string
107
+ */
99 108
 function calculer_url($ref, $texte = '', $pour = 'url', $connect = '', $echappe_typo = true) {
100 109
 	$r = traiter_lien_implicite($ref, $texte, $pour, $connect, $echappe_typo);
101 110
 
@@ -256,7 +265,7 @@  discard block
 block discarded – undo
256 265
  * @param int $id Identifiant de l'objet
257 266
  * @param string $type Type d'objet
258 267
  * @param string|null $connect Connecteur SQL utilisé
259
- * @return array {
268
+ * @return string {
260 269
  * @var string $titre Titre si présent, sinon ''
261 270
  * @var string $lang Langue si présente, sinon ''
262 271
  * }
@@ -302,6 +311,9 @@  discard block
 block discarded – undo
302 311
 define('_RACCOURCI_MODELE_DEBUT', '@^' . _RACCOURCI_MODELE . '@isS');
303 312
 
304 313
 // http://code.spip.net/@traiter_modeles
314
+/**
315
+ * @return string
316
+ */
305 317
 function traiter_modeles($texte, $doublons = false, $echap = '', $connect = '', $liens = null, $env = array()) {
306 318
 	// preserver la compatibilite : true = recherche des documents
307 319
 	if ($doublons === true) {
Please login to merge, or discard this patch.
ecrire/req/sqlite_fonctions.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -33,7 +33,7 @@
 block discarded – undo
33 33
  * @link http://www.sqlite.org/lang_corefunc.html Liste des fonctions natives
34 34
  * @link http://sqlite.org/changes.html Liste des évolutions
35 35
  * 
36
- * @param PDO|resource $sqlite Représente la connexion Sqlite
36
+ * @param PDO $sqlite Représente la connexion Sqlite
37 37
  * @return false|void
38 38
  */
39 39
 function _sqlite_init_functions(&$sqlite) {
Please login to merge, or discard this patch.
ecrire/req/sqlite_generique.php 1 patch
Doc Comments   +6 added lines, -6 removed lines patch added patch discarded remove patch
@@ -1528,8 +1528,8 @@  discard block
 block discarded – undo
1528 1528
  * @param string|array $select Champs sélectionnés
1529 1529
  * @param string|array $from Tables sélectionnées
1530 1530
  * @param string|array $where Contraintes
1531
- * @param string|array $groupby Regroupements
1532
- * @param string|array $orderby Tris
1531
+ * @param string $groupby Regroupements
1532
+ * @param string $orderby Tris
1533 1533
  * @param string $limit Limites de résultats
1534 1534
  * @param string|array $having Contraintes posts sélections
1535 1535
  * @param string $serveur Nom de la connexion
@@ -1687,7 +1687,7 @@  discard block
 block discarded – undo
1687 1687
  * @param string $nom_table Nom de la table SQL
1688 1688
  * @param string $serveur Nom de la connexion
1689 1689
  * @param bool $requeter Exécuter la requête, sinon la retourner
1690
- * @return array|string
1690
+ * @return string
1691 1691
  *     - chaîne vide si pas de description obtenue
1692 1692
  *     - string Texte de la requête si demandé
1693 1693
  *     - array description de la table sinon
@@ -2194,7 +2194,7 @@  discard block
 block discarded – undo
2194 2194
  * 4) Renommer la table B en A
2195 2195
  * 5) Remettre les index (qui sont supprimés avec la table A)
2196 2196
  *
2197
- * @param string|array $table
2197
+ * @param string $table
2198 2198
  *     - string : Nom de la table table,
2199 2199
  *     - array : couple (nom de la table => nom futur)
2200 2200
  * @param string|array $colonne
@@ -2597,7 +2597,7 @@  discard block
 block discarded – undo
2597 2597
  * stocke le resultat pour ne pas faire
2598 2598
  * de requetes showtable intempestives
2599 2599
  *
2600
- * @param  $table
2600
+ * @param  string $table
2601 2601
  * @param  $couples
2602 2602
  * @param string $desc
2603 2603
  * @param string $serveur
@@ -2789,7 +2789,7 @@  discard block
 block discarded – undo
2789 2789
 	 * Constructeur
2790 2790
 	 *
2791 2791
 	 * @param string $serveur
2792
-	 * @return bool
2792
+	 * @return false|null
2793 2793
 	 */
2794 2794
 	public function __construct($serveur = '') {
2795 2795
 		_sqlite_init();
Please login to merge, or discard this patch.
ecrire/inc/filtres_mini.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -147,7 +147,7 @@
 block discarded – undo
147 147
 /**
148 148
  * Verifier qu'une url est absolue et que son protocole est bien parmi une liste autorisee
149 149
  * @param string $url_absolue
150
- * @param array $protocoles_autorises
150
+ * @param string[] $protocoles_autorises
151 151
  * @return bool
152 152
  */
153 153
 function protocole_verifier($url_absolue, $protocoles_autorises = array('http','https')) {
Please login to merge, or discard this patch.
ecrire/inc/utils.php 1 patch
Doc Comments   +14 added lines, -5 removed lines patch added patch discarded remove patch
@@ -946,6 +946,9 @@  discard block
 block discarded – undo
946 946
 // Renvoie False si un fichier n'est pas plus vieux que $duree secondes,
947 947
 // sinon renvoie True et le date sauf si ca n'est pas souhaite
948 948
 // http://code.spip.net/@spip_touch
949
+/**
950
+ * @param string $fichier
951
+ */
949 952
 function spip_touch($fichier, $duree = 0, $touch = true) {
950 953
 	if ($duree) {
951 954
 		clearstatcache();
@@ -1023,7 +1026,7 @@  discard block
 block discarded – undo
1023 1026
  * @param string $description
1024 1027
  *     Une description humainement compréhensible de ce que fait la tâche
1025 1028
  *     (essentiellement pour l’affichage dans la page de suivi de l’espace privé)
1026
- * @param array $arguments
1029
+ * @param integer[] $arguments
1027 1030
  *     Facultatif, vide par défaut : les arguments qui seront passés à la fonction, sous forme de tableau PHP
1028 1031
  * @param string $file
1029 1032
  *     Facultatif, vide par défaut : nom du fichier à inclure, via `include_spip($file)`
@@ -1062,7 +1065,7 @@  discard block
 block discarded – undo
1062 1065
  *
1063 1066
  * @param int $id_job
1064 1067
  *  id of jonb to delete
1065
- * @return bool
1068
+ * @return boolean|string
1066 1069
  */
1067 1070
 function job_queue_remove($id_job) {
1068 1071
 	include_spip('inc/queue');
@@ -1378,6 +1381,9 @@  discard block
 block discarded – undo
1378 1381
 	return $themes;
1379 1382
 }
1380 1383
 
1384
+/**
1385
+ * @return string
1386
+ */
1381 1387
 function find_in_theme($file, $subdir = '', $include = false) {
1382 1388
 	static $themefiles = array();
1383 1389
 	if (isset($themefiles["$subdir$file"])) {
@@ -1792,6 +1798,9 @@  discard block
 block discarded – undo
1792 1798
 }
1793 1799
 
1794 1800
 // http://code.spip.net/@generer_url_entite_absolue
1801
+/**
1802
+ * @param boolean|string $connect
1803
+ */
1795 1804
 function generer_url_entite_absolue($id = '', $entite = '', $args = '', $ancre = '', $connect = null) {
1796 1805
 	if (!$connect) {
1797 1806
 		$connect = true;
@@ -2049,7 +2058,7 @@  discard block
 block discarded – undo
2049 2058
  *
2050 2059
  * @param string $script
2051 2060
  *     Nom de la page
2052
- * @param string|array $args
2061
+ * @param string $args
2053 2062
  *     Arguments à transmettre a l'URL,
2054 2063
  *      soit sous la forme d'un string tel que `arg1=yy&arg2=zz`
2055 2064
  *      soit sous la forme d'un array tel que array( `arg1` => `yy`, `arg2` => `zz` )
@@ -3224,7 +3233,7 @@  discard block
 block discarded – undo
3224 3233
 /**
3225 3234
  * Trouve un squelette dans le repertoire modeles/
3226 3235
  *
3227
- * @param  $nom
3236
+ * @param  string $nom
3228 3237
  * @return string
3229 3238
  */
3230 3239
 function trouve_modele($nom) {
@@ -3397,7 +3406,7 @@  discard block
 block discarded – undo
3397 3406
 		 *
3398 3407
 		 * @param array $input A multi-dimensional array (record set) from which to pull
3399 3408
 		 *                     a column of values.
3400
-		 * @param mixed $columnKey The column of values to return. This value may be the
3409
+		 * @param string $columnKey The column of values to return. This value may be the
3401 3410
 		 *                         integer key of the column you wish to retrieve, or it
3402 3411
 		 *                         may be the string key name for an associative array.
3403 3412
 		 * @param mixed $indexKey (Optional.) The column to use as the index/keys for
Please login to merge, or discard this patch.
ecrire/inc/documents.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -43,7 +43,7 @@  discard block
 block discarded – undo
43 43
  * @uses _DIR_IMG
44 44
  *
45 45
  * @param string $fichier
46
- * @return bool|string
46
+ * @return string|false
47 47
  */
48 48
 function get_spip_doc($fichier) {
49 49
 	// fichier distant
@@ -125,7 +125,7 @@  discard block
 block discarded – undo
125 125
  * @param string $ext
126 126
  * @param string $orig
127 127
  * @param string $source
128
- * @return bool|mixed|string
128
+ * @return string|false
129 129
  */
130 130
 function copier_document($ext, $orig, $source) {
131 131
 
@@ -162,7 +162,7 @@  discard block
 block discarded – undo
162 162
  * @uses sous_repertoire()
163 163
  *
164 164
  * @param string $type
165
- * @return bool|string
165
+ * @return string
166 166
  */
167 167
 function determine_upload($type = '') {
168 168
 	if (!function_exists('autoriser')) {
@@ -202,7 +202,7 @@  discard block
 block discarded – undo
202 202
  * @param bool $move
203 203
  *     - `true` : on déplace le fichier source vers le fichier de destination
204 204
  *     - `false` : valeur par défaut. On ne fait que copier le fichier source vers la destination.
205
- * @return bool|mixed|string
205
+ * @return string|false
206 206
  */
207 207
 function deplacer_fichier_upload($source, $dest, $move = false) {
208 208
 	// Securite
Please login to merge, or discard this patch.