From a1a95145400299e8e67e9f6854a4b5ee8ad01de5 Mon Sep 17 00:00:00 2001
From: Cerdic <cedric@yterium.com>
Date: Fri, 11 Jan 2013 13:56:13 +0000
Subject: [PATCH] report de r20037 : PHPDoc sur generer_url_entite pour
documenter le cas derogatoire ou appellee par nettoyer_raccourcis_typo elle
peut renvoyer un array() issu d'une fonction personalisee generer_url_xxx()
au lieu d'une chaine. Depuis le calcul generique des urls privees sur les
objets qui prend en charge tous les objets, il faut aussi definir une
fonction generer_url_ecrire_xxx() pour prendre le raccourci en charge dans
l'espace prive.
---
ecrire/inc/utils.php | 34 ++++++++++++++++++++++++----------
1 file changed, 24 insertions(+), 10 deletions(-)
diff --git a/ecrire/inc/utils.php b/ecrire/inc/utils.php
index bcccfa769e..3ab98c29f6 100644
--- a/ecrire/inc/utils.php
+++ b/ecrire/inc/utils.php
@@ -1060,16 +1060,30 @@ function autoriser_sans_cookie($nom)
return in_array($nom, $autsanscookie);
}
-// Fonction codant et decodant les URLS des objets SQL mis en page par SPIP
-// $id = numero de la cle primaire si nombre, URL a decoder si pas numerique
-// $entite = surnom de la table SQL (donne acces au nom de cle primaire)
-// $args = query_string a placer apres cle=$id&....
-// $ancre = ancre a mettre a la fin de l'URL a produire
-// $public = produire l'URL publique ou privee (par defaut: selon espace)
-// $type = fichier dans le repertoire ecrire/urls determinant l'apparence
-// @return string : url codee
-// @return string : fonction de decodage
-// http://doc.spip.org/@generer_url_entite
+/**
+ * Fonction codant et decodant les URLS des objets SQL mis en page par SPIP
+ *
+ * http://doc.spip.org/@generer_url_entite
+ *
+ *
+ * @param string $id
+ * numero de la cle primaire si nombre, URL a decoder si pas numerique
+ * @param string $entite
+ * surnom de la table SQL (donne acces au nom de cle primaire)
+ * @param string $args
+ * query_string a placer apres cle=$id&....
+ * @param string $ancre
+ * ancre a mettre a la fin de l'URL a produire
+ * @param bool|string $public
+ * produire l'URL publique ou privee (par defaut: selon espace)
+ * si string : serveur de base de donnee (nom du connect)
+ * @param string $type
+ * fichier dans le repertoire ecrire/urls determinant l'apparence
+ * @return string|array
+ * url codee ou fonction de decodage
+ * array : derogatoire, la fonction d'url retourne (objet,id_objet) utilises par nettoyer_raccourcis_typo() pour generer un lien titre
+ * (cas des raccourcis personalises [->spip20] : il faut implementer une fonction generer_url_spip et une fonction generer_url_ecrire_spip)
+ */
function generer_url_entite($id='', $entite='', $args='', $ancre='', $public=NULL, $type=NULL)
{
if ($public === NULL) $public = !test_espace_prive();
--
GitLab