Fichier ecrire/inc/utils.php
Utilitaires indispensables autour du serveur Http.
Source
Liste des constantes
Valeur
-
(isset($_SERVER['HTTP_X_REQUESTED_WITH']) or !empty($_REQUEST['var_ajax_redir']) or !empty($_REQUEST['var_ajaxcharset']) or !empty($_REQUEST['var_ajax'])) and empty($_REQUEST['var_noajax'])
Package
Source
Valeur
-
_DIR_CACHE . "charger_pipelines.php"
Package
Source
Valeur
-
_DIR_CACHE . "charger_plugins_fonctions.php"
Package
Source
Valeur
-
_DIR_CACHE . "charger_plugins_options.php"
Package
Source
Valeur
-
_DIR_CACHE . "charger_plugins_chemins.php"
Package
Source
Valeur
-
_DIR_TMP . 'menu-rubriques-cache.txt'
Package
Source
Valeur
-
_DIR_CACHE . "aide/"
Utilisé par
Package
Source
Valeur
-
$pa
Package
Source
Valeur
-
$ti . "upload/"
Utilisé par
Package
Source
Valeur
-
"<!DOCTYPE html PUBLIC '-//W3C//DTD HTML 4.01 Frameset//EN' 'http://www.w3.org/TR/1999/REC-html401-19991224/frameset.dtd'>"
Package
Source
Valeur
-
'html'
Utilisé par
Package
Source
Valeur
-
@is_readable($f = _DIR_CHMOD . _FILE_CHMOD_INS . '.php') ? $f : false
Package
Source
Valeur
-
_DIR_CHMOD . _FILE_CHMOD_INS . _FILE_TMP_SUFFIX
Package
Source
Valeur
-
@is_readable($f = _DIR_CONNECT . _FILE_CONNECT_INS . '.php') ? $f : (@is_readable($f = _DIR_RESTREINT . 'inc_connect.php') ? $f : false)
Package
Source
Valeur
-
_DIR_CONNECT . _FILE_CONNECT_INS . _FILE_TMP_SUFFIX
Package
Source
Valeur
-
(isset($GLOBALS['meta']['max_taille_vignettes']) and $GLOBALS['meta']['max_taille_vignettes']) ? $GLOBALS['meta']['max_taille_vignettes'] : 0
Package
Source
Valeur
-
_ROOT_RACINE . str_replace(_DIR_RACINE, '', _DIR_PLUGINS_SUPPL)
Package
Source
Valeur
-
!isset($_COOKIE['spip_accepte_ajax']) ? 1 : ($_COOKIE['spip_accepte_ajax'] != -1 ? 1 : 0)
Package
Source
Liste des fonctions
APIs
Paramètres
-
string $var
Clé souhaitée
-
boolean | array $c = false
Tableau transmis (sinon cherche dans GET ou POST)
Retour
-
mixed | null
- null si la clé n'a pas été trouvée
- la valeur de la clé sinon.
API
Package
Source
Traduit une clé de traduction en l'obtenant dans les fichiers de langues.
Paramètres
-
string $texte
Clé de traduction
-
array $args = array()
Couples (variable => valeur) pour passer des variables à la chaîne traduite. la variable spip_lang permet de forcer la langue
-
array $options = array()
- string class : nom d'une classe a ajouter sur un span pour encapsuler la chaine
- bool force : forcer un retour meme si la chaine n'a pas de traduction
- bool sanitize : nettoyer le html suspect dans les arguments
Retour
-
string
Texte
API
Exemples
-
_T('bouton_enregistrer') _T('medias:image_tourner_droite') _T('medias:erreurs', array('nb'=>3)) _T("email_sujet", array('spip_lang'=>$lang_usager))
Utilise
Package
Source
Charge un fichier (suivant les chemins connus) et retourne si elle existe
le nom de la fonction homonyme $dir_$nom
, ou suffixé $dir_$nom_dist
Peut être appelé plusieurs fois, donc optimisé.
Paramètres
-
string $nom
Nom de la fonction (et du fichier)
-
string $dossier = 'exec'
Nom du dossier conteneur
-
boolean $continue = false
true pour ne pas râler si la fonction n'est pas trouvée
Retour
-
string
Nom de la fonction, ou false.
API
Exemples
-
$envoyer_mail = charger_fonction('envoyer_mail', 'inc'); $envoyer_mail($email, $sujet, $texte);
Utilisé par
Package
Source
Pour un nom de fichier donné, ne retourne que le premier qui sera trouvé
par un find_in_path()
Paramètres
-
string $dir
-
string $pattern
-
boolean $recurs = false
Retour
-
array
API
Utilise
Utilisé par
Package
Source
Retournera le premier fichier trouvé (ayant la plus haute priorité donc), suivant l'ordre des chemins connus de SPIP.
Paramètres
-
string $file
Fichier recherché
-
string $dirname = ''
Répertoire éventuel de recherche (est aussi extrait automatiquement de $file)
-
boolean | string $include = false
- false : ne fait rien de plus
- true : inclut le fichier (include_once)
- 'require' : idem, mais tue le script avec une erreur si le fichier n'est pas trouvé.
Retour
-
string | boolean
- string : chemin du fichier trouvé
- false : fichier introuvable
API
Exemples
-
$f = find_in_path('css/perso.css'); $f = find_in_path('perso.css', 'css');
Voir également
Utilisé par
Package
Source
Paramètres
-
string $id = ''
numero de la cle primaire si nombre, URL a decoder si pas numerique
-
string $entite = ''
surnom de la table SQL (donne acces au nom de cle primaire)
-
string $args = ''
query_string a placer apres cle=$id&....
-
string $ancre = ''
ancre a mettre a la fin de l'URL a produire
-
boolean | string $public = null
produire l'URL publique ou privee (par defaut: selon espace) si string : serveur de base de donnee (nom du connect)
-
string $type = null
fichier dans le repertoire ecrire/urls determinant l'apparence
Retour
-
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)
API
Package
Source
Paramètres
-
string $f
Nom du fichier (sans l'extension)
-
boolean $include = true
- true pour inclure le fichier,
- false ne fait que le chercher
Retour
-
string | boolean
- false : fichier introuvable
- string : chemin du fichier trouvé
API
Exemples
-
include_spip('inc/texte');
Utilise
Utilisé par
Package
Source
La fonction de base de SPIP : un squelette + un contexte => une page. $fond peut etre un nom de squelette, ou une liste de squelette au format array. Dans ce dernier cas, les squelettes sont tous evalues et mis bout a bout $options permet de selectionner les options suivantes :
- trim => true (valeur par defaut) permet de ne rien renvoyer si le fond ne produit que des espaces ;
- raw => true permet de recuperer la strucure $page complete avec entetes et invalideurs pour chaque $fond fourni.
Paramètres
-
$fond
-
array $contexte = array()
- Informations de contexte envoyées au squelette, {@example array('id_rubrique' => 8)}
- La langue est transmise automatiquement (sauf option étoile).
-
array $options = array()
Options complémentaires :
- trim : applique un trim sur le résultat (true par défaut) - raw : retourne un tableau d'information sur le squelette (false par défaut) - etoile : ne pas transmettre la langue au contexte automatiquement (false par défaut), équivalent de INCLURE* - ajax : gere les liens internes du squelette en ajax (équivalent du paramètre {ajax})
-
string $connect = ''
Non du connecteur de bdd a utiliser
Retour
-
string | array
- Contenu du squelette calculé
- ou tableau d'information sur le squelette.
API
Package
Source
Signature : spip_log(message[,niveau|type|type.niveau])
Le niveau de log par défaut est la valeur de la constante _LOG_INFO
Les différents niveaux possibles sont :
_LOG_HS
: écrira 'HS' au début de la ligne logguée_LOG_ALERTE_ROUGE
: 'ALERTE'_LOG_CRITIQUE
: 'CRITIQUE'_LOG_ERREUR
: 'ERREUR'_LOG_AVERTISSEMENT
: 'WARNING'_LOG_INFO_IMPORTANTE
: '!INFO'_LOG_INFO
: 'info'_LOG_DEBUG
: 'debug'
Paramètres
-
string $message = null
Message à loger
-
string | integer $name = null
- int indique le niveau de log, tel que
_LOG_DEBUG
- string indique le type de log
string.int
indique les 2 éléments. Cette dernière notation est controversée mais le 3ème paramètre est planté pour cause de compatibilité ascendante.
- int indique le niveau de log, tel que
API
Exemples
-
spip_log($message) spip_log($message, 'recherche') spip_log($message, _LOG_DEBUG) spip_log($message, 'recherche.'._LOG_DEBUG)
Documentation externe
Utilise
Utilisé par
Package
Source
Internes
Empile de nouveaux chemins (à la suite de ceux déjà présents, mais avant
le répertoire squelettes
ou les dossiers squelettes), si un répertoire
(ou liste de répertoires séparés par :
) lui est passé en paramètre.
Ainsi, si l'argument est de la forme dir1:dir2:dir3
, ces 3 chemins sont placés
en tête du path, dans cet ordre (hormis squelettes
& la globale
$dossier_squelette
si définie qui resteront devant)
Retourne dans tous les cas la liste des chemins.
Paramètres
-
string $dir_path = null
- Répertoire(s) à empiler au path
- '' provoque un recalcul des chemins.
Retour
-
array
Liste des chemins, par ordre de priorité.
Utilisé par
Package
Note
-
Cette fonction est appelée à plusieurs endroits et crée une liste de chemins finale à peu près de la sorte :
- dossiers squelettes (si globale précisée) - squelettes/ - plugins (en fonction de leurs dépendances) : ceux qui dépendent d'un plugin sont devant eux (ils peuvent surcharger leurs fichiers) - racine du site - squelettes-dist/ - prive/ - ecrire/
Source
..@` par leur valeur dans une chaîne de langue.
Cette fonction est également appelée dans le code source de SPIP quand une chaîne n'est pas encore dans les fichiers de langue.
Paramètres
-
string $text
Texte
-
array $args = array()
Couples (variable => valeur) à transformer dans le texte
-
array $options = array()
- string class : nom d'une classe a ajouter sur un span pour encapsuler la chaine
- bool sanitize : nettoyer le html suspect dans les arguments
Retour
-
string
Texte
Exemples
-
_L('Texte avec @nb@ ...', array('nb'=>3)
Voir également
Utilisé par
Package
Source
Voir également
Utilise
Package
Source
Aide, aussi depuis l'espace privé à présent. Surchargeable mais pas d'erreur fatale si indisponible.
Paramètres
-
string $aide = ''
Cle d'identification de l'aide desiree
-
boolean $distante = false
Generer une url locale (par defaut) ou une url distante [directement sur spip.net]
Retour
-
\Lien
sur une icone d'aide
Package
Source
L’ancre est nettoyée : on translitère, vire les non alphanum du début,
et on remplace ceux à l'interieur ou au bout par -
Paramètres
-
string $url
-
string $ancre
Retour
-
string
Exemples
-
- `$url = ancre_url($url, 'navigation'); // => mettra l’ancre #navigation
- `$url = ancre_url($url, ''); // => enlèvera une éventuelle ancre
Utilise
Package
Source
Optionally, you may provide an $indexKey to index the values in the returned array by the values from the $indexKey column in the input array.
Paramètres
-
array $input = null
A multi-dimensional array (record set) from which to pull a column of values.
-
mixed $columnKey = null
The column of values to return. This value may be the integer key of the column you wish to retrieve, or it may be the string key name for an associative array.
-
mixed $indexKey = null
(Optional.) The column to use as the index/keys for the returned array. This value may be the integer key of the column, or it may be the string key name.
Retour
-
array
Documentation externe
Package
Copyright
-
Copyright (c) Ben Ramsey (http://benramsey.com)
License
Source
Paramètres
-
string $nom
-
string $message
-
string $statut = ''
Package
Source
Paramètres
-
string $module
Nom du module à charger
Retour
-
boolean
true si le module est chargé
Exemples
-
$ok = charger_php_extension('sqlite');
Package
Deprected
-
Utiliser directement la fonction native
extension_loaded($module)
Source
Cherche en priorité dans les thèmes d'image (prive/themes/X/images) et si la fonction n'en trouve pas, gère le renommage des icones (ex: 'supprimer' => 'del') de facon temporaire le temps de la migration, et cherche de nouveau.
Si l'image n'est toujours pas trouvée, on la cherche dans les chemins,
dans le répertoire défini par la constante _NOM_IMG_PACK
Paramètres
-
string $icone
Nom de l'icone cherchée
Retour
-
string
Chemin complet de l'icone depuis la racine si l'icone est trouée, sinon chaîne vide.
Voir également
Package
Source
Utilisé par
Package
Source
Recalcule la liste si le nom ou liste de dossier squelettes a changé.
Retour
-
array
Liste de chemins
Utilise
Utilisé par
Package
Source
Paramètres
-
array $taches = array()
Tâches forcées
-
array $taches_old = array()
Tâches forcées, pour compat avec ancienne syntaxe
Retour
-
boolean
True si la tache a pu être effectuée
Utilise
Utilisé par
Package
Source
Génère une erreur de squelette qui sera bien visible par un administrateur authentifié lors d'une visite de la page en erreur
Paramètres
-
boolean | string | array $message = ''
- Message d'erreur (string|array)
- false pour retourner le texte des messages d'erreurs
- vide pour afficher les messages d'erreurs
-
string | array | object $lieu = ''
Lieu d'origine de l'erreur
Retour
-
null | string
- Rien dans la plupart des cas
- string si $message à false.
Package
Source
Si l’utiliseur est un webmestre.
Package
Source
Paramètres
-
$file
-
$subdir = ''
-
$include = false
Utilisé par
Package
Source
Paramètres
-
boolean $gd = false
-
boolean $svg_allowed = true
Retour
-
array
Package
Source
Attention, JS/Ajax n'aime pas le melange de param GET/POST On n'applique pas la recommandation ci-dessus pour les scripts publics qui ne sont pas destines a etre mis en signets
Paramètres
-
string $script
-
string $corps
-
string $atts = ''
-
boolean $public = false
Retour
-
string
Utilisé par
Package
Source
Paramètres
-
string $script
Nom de la page exec
-
string $corps
Contenu du formulaire
-
string $atts = ''
Si présent, remplace les arguments par défaut (method=post) par ceux indiqués
-
string $submit = ''
Si indiqué, un bouton de soumission est créé avec texte sa valeur.
Retour
-
string
Code HTML du formulaire
Package
Source
Paramètres
-
string $script
Nom du script à exécuter
-
string $args = ""
Arguments à transmettre a l'URL sous la forme
arg1=yy&arg2=zz
-
boolean $no_entities = false
Si false : transforme les & en &
-
boolean $public = false
URL relative ? false : l’URL sera complète et contiendra l’URL du site. true : l’URL sera relative.
Retour
-
string
URL
Package
Source
Paramètres
-
string $script = ''
Nom de la page privée (xx dans exec=xx)
-
string $args = ""
Arguments à transmettre, tel que
arg1=yy&arg2=zz
-
boolean $no_entities = false
Si false : transforme les
&
en&
-
boolean | string $rel = false
URL relative ?
- false : l’URL sera complète et contiendra l’URL du site - true : l’URL sera relavive. - string : on transmet l'url à la fonction
Retour
-
string
URL
Exemples
-
generer_url_ecrire('admin_plugin')
Package
Source
Paramètres
-
$id
-
$entite
-
$args = ''
-
$ancre = ''
Package
Source
Paramètres
-
$id = ''
-
$entite = ''
-
$args = ''
-
$ancre = ''
-
$connect = null
Package
Source
Paramètres
-
$script
-
$args = ""
-
$no_entities = false
Package
Source
Paramètres
-
string $script = ''
Nom de la page
-
string | array $args = ""
Arguments à transmettre a l'URL, soit sous la forme d'un string tel que
arg1=yy&arg2=zz
soit sous la forme d'un array tel que array(arg1
=>yy
,arg2
=>zz
) -
boolean $no_entities = false
Si false : transforme les
&
en&
-
boolean $rel = true
URL relative ?
- false : l’URL sera complète et contiendra l’URL du site - true : l’URL sera relavive.
-
string $action = ''
- Fichier d'exécution public (spip.php par défaut)
Retour
-
string
URL
Exemples
-
generer_url_public("rubrique","id_rubrique=$id_rubrique")
Package
Source
Paramètres
-
string $default = ''
Script par défaut
Retour
-
string
Nom du fichier (constante _SPIP_SCRIPT), sinon nom par défaut
Voir également
Package
Note
-
Detecter le fichier de base, a la racine, comme etant spip.php ou '' dans le cas de '', un $default = './' peut servir (comme dans urls/page.php)
Source
Retour
-
boolean
true si et seulement si la configuration autorise le code HTML5 sur le site public
Utilisé par
Package
Source
Paramètres
-
string $script
Code source du script
-
string $src = ''
Permet de faire appel à un fichier javascript distant
-
string $noscript = ''
Contenu de la balise
<noscript>
Retour
-
string
Balise HTML
<script>
et son contenu
Exemples
-
echo http_script('alert("ok");'); echo http_script('','js/jquery.js');
Package
Source
Paramètres
-
string $file
Retour
-
boolean
Package
Source
Le paramètre d'URL var_mode
permet de
modifier la pérennité du cache, recalculer des urls
ou d'autres petit caches (trouver_table, css et js compactes ...),
d'afficher un écran de débug ou des traductions non réalisées.
En fonction de ces paramètres dans l'URL appelante, on définit
da constante _VAR_MODE
qui servira ensuite à SPIP.
Le paramètre var_mode
accepte ces valeurs :
calcul
: force un calcul du cache de la page (sans forcément recompiler les squelettes)recalcul
: force un calcul du cache de la page en recompilant au préabable les squelettesinclure
: modifie l'affichage en ajoutant visuellement le nom de toutes les inclusions qu'elle contientdebug
: modifie l'affichage activant le mode "debug"preview
: modifie l'affichage en ajoutant aux boucles les éléments prévisualisablestraduction
: modifie l'affichage en affichant des informations sur les chaînes de langues utiliséesurls
: permet de recalculer les URLs des objets appelés dans la page par les balises#URL_xx
images
: permet de recalculer les filtres d'images utilisés dans la page
En dehors des modes calcul
et recalcul
, une autorisation 'previsualiser' ou 'debug' est testée.
Package
Note
-
Il éxiste également le paramètre
var_profile
qui modifie l'affichage pour incruster le nombre de requêtes SQL utilisées dans la page, qui peut se compléter avec le paramètrevar_mode
(calcul ou recalcul).
Source
Paramètres
-
string $function
Le nom de la fonction PHP qui doit être appelée.
-
string $description
Une description humainement compréhensible de ce que fait la tâche (essentiellement pour l’affichage dans la page de suivi de l’espace privé)
-
array $arguments = array()
Facultatif, vide par défaut : les arguments qui seront passés à la fonction, sous forme de tableau PHP
-
string $file = ''
Facultatif, vide par défaut : nom du fichier à inclure, via
include_spip($file)
exemple :'inc/mail'
: il ne faut pas indiquer .php Si le nom finit par un '/' alors on considère que c’est un répertoire et SPIP fera uncharger_fonction($function, $file)
-
boolean $no_duplicate = false
Facultatif,
false
par défaut- si `true` la tâche ne sera pas ajoutée si elle existe déjà en file d’attente avec la même fonction et les mêmes arguments. - si `function_only` la tâche ne sera pas ajoutée si elle existe déjà en file d’attente avec la même fonction indépendamment de ses arguments
-
integer $time
Facultatif,
0
par défaut : indique la date sous forme de timestamp à laquelle la tâche doit être programmée. Si0
ou une date passée, la tâche sera exécutée aussitôt que possible (en général en fin hit, en asynchrone). -
integer $priority
Facultatif,
0
par défaut : indique un niveau de priorité entre -10 et +10. Les tâches sont exécutées par ordre de priorité décroissante, une fois leur date d’exécution passée. La priorité est surtout utilisée quand une tâche cron indique qu’elle n’a pas fini et doit être relancée : dans ce cas SPIP réduit sa priorité pour être sûr que celle tâche ne monopolise pas la file d’attente.
Retour
-
integer
Le numéro de travail ajouté ou
0
si aucun travail n’a été ajouté.
Package
Source
Paramètres
-
integer $id_job
id of job to link
-
array $objets
can be a simple array('objet'=>'article', 'id_objet'=>23) or an array of simple array to link multiples objet in one time
Package
Source
Paramètres
-
integer $id_job
id of jonb to delete
Retour
-
boolean
Package
Source
Pour afficher ecrire/action/
au lieu de action/
dans les messages
ou tmp/
au lieu de ../tmp/
Paramètres
-
\stirng $rep
Chemin d’un répertoire
Retour
-
string
Package
Source
Paramètres
-
string $phrase
Texte du journal
-
array $opt = array()
Tableau d'options
Utilise
Package
Source
Restaure l'ancienne langue si appellée sans argument.
Paramètres
-
null | string $lang = null
- string : Langue à appliquer,
- null : Pour restituer la dernière langue mémorisée.
Retour
-
string
- string Langue utilisée.
Utilise
Utilisé par
Package
Note
-
On pourrait économiser l'empilement en cas de non changemnt et lui faire retourner
False
pour prevenir l'appelant Le noyau de Spip sait le faire, mais pour assurer la compatibilité cette fonction retourne toujours nonFalse
Source
Un pipeline est lie a une action et une valeur chaque element du pipeline est autorise a modifier la valeur le pipeline execute les elements disponibles pour cette action, les uns apres les autres, et retourne la valeur finale
Cf. compose_filtres dans references.php, qui est la version compilee de cette fonctionnalite appel unitaire d'une fonction du pipeline utilisee dans le script pipeline precompile
on passe $val par reference pour limiter les allocations memoire
Paramètres
-
string $fonc
Nom de la fonction appelée par le pipeline
-
string | array & $val
Les paramètres du pipeline, son environnement
Retour
-
string | array
$val Les paramètres du pipeline modifiés
Package
Source
Paramètres
-
string | null $reset = null
Retour
-
string
Package
Source
Attention, la regexp doit suivre _CONTEXTE_IGNORE_VARIABLES défini au début de public/assembler.php
Paramètres
-
$request_uri
Retour
-
string
Package
Source
Paramètres
-
string $url
URL
-
string $c
Nom du paramètre
-
string | array | null $v = null
Valeur du paramètre
-
string $sep = '&'
Séparateur entre les paramètres
Retour
-
string
URL
Exemples
-
[(#SELF|parametre_url{suite,18})] (ajout) [(#SELF|parametre_url{suite,''})] (supprime) [(#SELF|parametre_url{suite[],1})] (tableaux valeurs multiples)
Documentation externe
Package
Filtre
-
parametre_url
Source
Exécute le pipeline souhaité, éventuellement avec des données initiales. Chaque plugin qui a demandé à voir ce pipeline vera sa fonction spécifique appelée. Les fonctions (des plugins) appelées peuvent modifier à leur guise le contenu.
Deux types de retours. Si $val
est un tableau de 2 éléments, avec une clé data
on retourne uniquement ce contenu ($val['data']
) sinon on retourne tout $val
.
Paramètres
-
string $action
Nom du pipeline
-
null | string | array $val = null
Données à l’entrée du pipeline
Retour
-
mixed | null
Résultat
Exemples
-
Appel du pipeline
pre_insertion
$champs = pipeline('pre_insertion', array( 'args' => array('table' => 'spip_articles'), 'data' => $champs ));
Package
Source
Paramètres
-
integer | boolean $force = null
Utilisée par
queue_set_next_job_time()
pour mettre à jour la valeur :- si
true
, force la relecture depuis le fichier - si int, affecte la static directement avec la valeur
- si
Retour
-
integer
0
si un job est à traiternull
si la queue n'est pas encore initialisée
Voir également
Utilisé par
Package
Staticvar
-
int $queue_next_job_time
Source
Paramètres
-
string $u
Retour
-
string
Traversée par le pipeline
Package
Source
Paramètres
-
string $f
Nom du fichier (sans l'extension)
Retour
-
string | boolean
- false : fichier introuvable
- string : chemin du fichier trouvé
Exemples
-
require_spip('inc/texte');
Voir également
Utilise
Package
Source
Paramètres
-
string $amp = '&'
Style des esperluettes
-
boolean $root = false
Retour
-
string
URL vers soi-même
Package
Source
Paramètres
-
string $var
Nom de la clé
-
string $val = null
Valeur à affecter
-
boolean | array $c = false
Tableau de données (sinon utilise
$_GET
et$_POST
)
Retour
-
array | boolean
- array $c complété si un $c est transmis,
- false sinon
Voir également
Package
Note
-
Attention au cas ou l'on fait
set_request('truc', NULL);
Source
Paramètres
-
& $t
-
$deep = true
Package
Source
Paramètres
-
string $fichier
Retour
-
array | boolean
Package
Source
Paramètres
-
string $pi = null
Répertoire permanent inaccessible
-
string $pa = null
Répertoire permanent accessible
-
string $ti = null
Répertoire temporaire inaccessible
-
string $ta = null
Répertoire temporaire accessible
Package
Source
Elle définit les répertoires et fichiers non partageables et indique dans $test_dirs ceux devant être accessibles en écriture mais ne touche pas à cette variable si elle est déjà définie afin que mes_options.php puisse en spécifier d'autres.
Elle définit ensuite les noms des fichiers et les droits. Puis simule un register_global=on sécurisé.
Paramètres
-
string $pi = null
Répertoire permanent inaccessible
-
string $pa = null
Répertoire permanent accessible
-
string $ti = null
Répertoire temporaire inaccessible
-
string $ta = null
Répertoire temporaire accessible
Package
Source
Paramètres
-
string | array<mixed,string> $classes
Retour
-
string | array<mixed,string>
Package
Note
-
les classes CSS acceptent théoriquement tous les caractères sauf NUL. Ici, on limite (enlève) les caractères autres qu’alphanumérique, espace, - + _ @
Source
On peut sanitizer
- une valeur simple :
$where = spip_sanitize_from_request($value, 'where')
- un tableau en partie :
$env = spip_sanitize_from_request($env, ['key1','key2'])
- un tableau complet :
$env = spip_sanitize_from_request($env, '*')
Paramètres
-
string | array $value
-
string | array $key
-
string $sanitize_function = 'entites_html'
Retour
-
array | mixed | string
Package
Source
Permet de savoir si on peut utiliser un cache enregistré pour cette session. Cette chaîne est courte (8 cars) pour pouvoir être utilisée dans un nom de fichier cache.
Paramètres
-
boolean $force = false
Retour
-
string
Identifiant de la session
Utilisé par
Appelle le pipeline
Package
Source
On exécute 2 fois la fonction, la première fois pour démarrer le chrono, la seconde fois pour l’arrêter et récupérer la valeur
Paramètres
-
string $t = 'rien'
Nom du chronomètre
-
boolean $raw = false
- false : retour en texte humainement lisible
- true : retour en millisecondes
Retour
-
float | integer | string | void
Exemples
-
spip_timer('papoter'); // actions $duree = spip_timer('papoter');
Package
Source
Paramètres
-
$fichier
-
$duree
-
$touch = true
Package
Source
Retour
-
boolean
true si c'est le cas, false sinon.
Package
Source
Paramètres
-
string $plugin
Retour
-
boolean
Package
Source
Sur certains serveurs, la valeur 'Off' tient lieu de false dans certaines
variables d'environnement comme $_SERVER['HTTPS']
ou ini_get('display_errors')
Paramètres
-
string | boolean $truc
La valeur de la variable d'environnement
Retour
-
boolean
true si la valeur est considérée active ; false sinon.
Package
Source
On est sur le web, on exclut certains protocoles, notamment 'file://', 'php://' et d'autres…
Paramètres
-
string $url
Retour
-
boolean
Utilisé par
Package
Source
Dans ce cas, on retourne la fonction d'exécution correspondante à utiliser
(du répertoire ecrire/exec
). Deux cas particuliers et prioritaires :
fond
ou fond_monobloc
sont retournés si des squelettes existent.
-
fond
: pour des squelettes deprive/squelettes/contenu
ou pour des objets éditoriaux dont les suqelettes seront échaffaudés -
fond_monobloc
(compatibilité avec SPIP 2.1) : pour des squelettes deprive/exec
Paramètres
-
string $nom
Nom de la page
Retour
-
string
Nom de l'exec, sinon chaîne vide.
Package
Source
Transforme n'importe quel texte en une chaîne utilisable
en PHP ou Javascript en toute sécurité, à l'intérieur d'apostrophes
simples ('
uniquement ; pas "
)
Utile particulièrement en filtre dans un squelettes pour écrire un contenu dans une variable JS ou PHP.
Échappe les apostrophes (') du contenu transmis.
Paramètres
-
string $texte
Texte à échapper
Retour
-
string
Texte échappé
Exemples
-
PHP dans un squelette $x = '[(#TEXTE|texte_script)]'; JS dans un squelette (transmettre une chaîne de langue) $x = '<:afficher_calendrier|texte_script:>';
Documentation externe
Package
Filtre
-
texte_script
Source
Paramètres
-
$nom
Retour
-
string
Package
Source
Paramètres
-
string $nom
-
string $dir = ''
-
boolean $pathinfo = false
Retour
-
array | string
Package
Source
Paramètres
-
string $http
-
string $host
-
string $request
-
integer $prof
Retour
-
string
Package
Source
Calcule l'URL de base du site, en priorité sans se fier à la méta (adresse_site) qui peut être fausse (sites avec plusieurs noms d’hôtes, déplacements, erreurs). En dernier recours, lorsqu'on ne trouve rien, on utilise adresse_site comme fallback.
Paramètres
-
integer | \boo | array $profondeur = null
- si non renseignée : retourne l'url pour la profondeur $GLOBALS['profondeur_url']
- si int : indique que l'on veut l'url pour la profondeur indiquée
- si bool : retourne le tableau static complet
- si array : réinitialise le tableau static complet avec la valeur fournie
Retour
-
string | array
Utilisé par
Package
Note
-
La globale
$profondeur_url
doit être initialisée de manière à indiquer le nombre de sous-répertoires de l'url courante par rapport à la racine de SPIP : par exemple, sur ecrire/ elle vaut 1, sur sedna/ 1, et à la racine 0. Sur url/perso/ elle vaut 2
Source
Paramètres
-
string $url
Retour
-
string
Package
Source
Paramètres
-
$i
-
& $entite
-
$args = ''
-
$ancre = ''
-
$public = null
Package
Source
Utilisé par
Package
Source
Dépréciées
Paramètres
-
string $nom
Clé de meta à lire
Retour
-
mixed
Valeur de la meta.
Voir également
Package
Deprecated
-
Utiliser
$GLOBALS['meta'][$nom]
oulire_config('nom')
Source
Liste des erreurs
Gravité | Ligne | Description |
---|---|---|
Erreur | 988 |
|
Erreur | 1391 |
|
Erreur | 1420 |
|
Erreur | 1612 |
|
Erreur | 1617 |
|
Erreur | 1647 |
|
Erreur | 1815 |
|
Erreur | 1831 |
|
Erreur | 1864 |
|
Erreur | 2167 |
|
Erreur | 2954 |
|
Erreur | 2970 |
|