SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

utils.php

Table of Contents

Functions

test_plugin_actif()  : bool
Vérifie la présence d'un plugin actif, identifié par son préfixe
joli_repertoire()  : string
Retourne un joli chemin de répertoire
spip_timer()  : float|int|string|void
Débute ou arrête un chronomètre et retourne sa valeur
spip_touch()  : mixed
http_script()  : string
Produit une balise `<script>` valide
texte_script()  : string
Sécurise du texte à écrire dans du PHP ou du Javascript.
test_valeur_serveur()  : bool
Tester qu'une variable d'environnement est active
exec_info_dist()  : mixed
Page `exec=info` : retourne le contenu de la fonction php `phpinfo()`
html5_permis()  : bool
Indique si le code HTML5 est permis sur le site public
formats_image_acceptables()  : array<string|int, mixed>
Lister les formats image acceptes par les lib et fonctions images
spip_getimagesize()  : array<string|int, mixed>|bool
Extension de la fonction getimagesize pour supporter aussi les images SVG
avertir_auteurs()  : mixed
Poser une alerte qui sera affiche aux auteurs de bon statut ('' = tous) au prochain passage dans l'espace prive chaque alerte doit avoir un nom pour eviter duplication a chaque hit les alertes affichees une fois sont effacees
spip_version_compare()  : int|bool
Compare 2 numéros de version entre elles.

Functions

test_plugin_actif()

Vérifie la présence d'un plugin actif, identifié par son préfixe

test_plugin_actif(string $plugin) : bool
Parameters
$plugin : string
Return values
bool

joli_repertoire()

Retourne un joli chemin de répertoire

joli_repertoire(string $rep) : string

Pour afficher ecrire/action/ au lieu de action/ dans les messages ou tmp/ au lieu de ../tmp/

Parameters
$rep : string

Chemin d’un répertoire

Return values
string

spip_timer()

Débute ou arrête un chronomètre et retourne sa valeur

spip_timer([string $t = 'rien' ][, bool $raw = false ]) : float|int|string|void

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

Parameters
$t : string = 'rien'

Nom du chronomètre

$raw : bool = false
  • false : retour en texte humainement lisible
  • true : retour en millisecondes
Tags
example 
spip_timer('papoter');
// actions
$duree = spip_timer('papoter');
Return values
float|int|string|void

spip_touch()

spip_touch(mixed $fichier[, mixed $duree = 0 ][, mixed $touch = true ]) : mixed
Parameters
$fichier : mixed
$duree : mixed = 0
$touch : mixed = true

http_script()

Produit une balise `<script>` valide

http_script(string $script[, string $src = '' ][, string $noscript = '' ]) : string
Parameters
$script : string

Code source du script

$src : string = ''

Permet de faire appel à un fichier javascript distant

$noscript : string = ''

Contenu de la balise <noscript>

Tags
example 
echo http_script('alert("ok");');
echo http_script('','js/jquery.js');
Return values
string —

Balise HTML <script> et son contenu

texte_script()

Sécurise du texte à écrire dans du PHP ou du Javascript.

texte_script(string|null $texte) : string

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.

Parameters
$texte : string|null

texte à échapper

Tags
link
https://www.spip.net/4281
example

PHP dans un squelette

$x = '[(#TEXTE|texte_script)]';

JS dans un squelette (transmettre une chaîne de langue)

$x = '<:afficher_calendrier|texte_script:>';
filtre
Return values
string —

texte échappé

test_valeur_serveur()

Tester qu'une variable d'environnement est active

test_valeur_serveur(string|bool $truc) : bool

Sur certains serveurs, la valeur 'Off' tient lieu de false dans certaines variables d'environnement comme $_SERVER['HTTPS'] ou ini_get('display_errors')

Parameters
$truc : string|bool

La valeur de la variable d'environnement

Return values
bool —

true si la valeur est considérée active ; false sinon.

exec_info_dist()

Page `exec=info` : retourne le contenu de la fonction php `phpinfo()`

exec_info_dist() : mixed

Si l’utiliseur est un webmestre.

html5_permis()

Indique si le code HTML5 est permis sur le site public

html5_permis() : bool
Return values
bool —

true si la constante _VERSION_HTML n'est pas définie ou égale à html5

formats_image_acceptables()

Lister les formats image acceptes par les lib et fonctions images

formats_image_acceptables([bool|null $gd = null ][, bool $svg_allowed = true ]) : array<string|int, mixed>
Parameters
$gd : bool|null = null
$svg_allowed : bool = true
Return values
array<string|int, mixed>

spip_getimagesize()

Extension de la fonction getimagesize pour supporter aussi les images SVG

spip_getimagesize(string $fichier) : array<string|int, mixed>|bool

Lorsque la fonction renvoie un tableau, celui-ci peut contenir jusqu'à 7 entrées (cf. https://www.php.net/manual/en/function.getimagesize.php) :

  • 0 : largeur ;
  • 1 : hauteur ;
  • 2 : constante indiquant le type de l'image ;
  • 3 : chaîne avec les hauteur et largeur utilisable sur un tag <img> ;
  • 'bits' (pas toujours présente, en fonction du type d'image) ;
  • 'channels' (pas toujours présente, en fonction du type d'image) ;
  • 'mime'.
Parameters
$fichier : string
Return values
array<string|int, mixed>|bool

avertir_auteurs()

Poser une alerte qui sera affiche aux auteurs de bon statut ('' = tous) au prochain passage dans l'espace prive chaque alerte doit avoir un nom pour eviter duplication a chaque hit les alertes affichees une fois sont effacees

avertir_auteurs(string $nom, string $message[, string $statut = '' ]) : mixed
Parameters
$nom : string
$message : string
$statut : string = ''

spip_version_compare()

Compare 2 numéros de version entre elles.

spip_version_compare(string $v1, string $v2[, string $op = null ]) : int|bool

Cette fonction est identique (arguments et retours) a la fonction PHP version_compare() qu'elle appelle. Cependant, cette fonction reformate les numeros de versions pour ameliorer certains usages dans SPIP ou bugs dans PHP. On permet ainsi de comparer 3.0.4 à 3.0.* par exemple.

Parameters
$v1 : string

Numero de version servant de base a la comparaison. Ce numero ne peut pas comporter d'etoile.

$v2 : string

Numero de version a comparer. Il peut posseder des etoiles tel que 3.0.*

$op : string = null

Un operateur eventuel (<, >, <=, >=, =, == ...)

Return values
int|bool —

Sans operateur : int. -1 pour inferieur, 0 pour egal, 1 pour superieur Avec operateur : bool.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results