svp_outiller.php
Fichier de fonctions
Tags
Table of Contents
Constants
- _SVP_VERSION_SPIP_MAX = '4.2.999'
- Version SPIP maximale
- _SVP_VERSION_SPIP_MIN = '1.9.0'
- Version SPIP minimale quand un plugin ne le precise pas
Functions
- fusionner_intervalles() : string
- Fusionne 2 intervalles de compatibilité
- extraire_bornes() : array<string|int, mixed>
- Extrait les valeurs d'un intervalle de compatibilité.
- construire_intervalle() : string
- Contruit un intervalle de compatibilité
- compiler_branches_spip() : string
- Retourne la liste des branches de SPIP comprises dans un intervalle de compatibilité donné.
- entite2charset() : string
- Transforme un texte écrit en entités HTML, dans le charset du site
- balise_identique() : bool
- Teste si 2 balises XML sont identiques
- definir_licence() : array<string|int, mixed>
- Déterminer la licence exacte avec un nom et un lien de doc standardisé
- svp_lister_librairies() : array<string|int, mixed>
- Liste les librairies présentes
- normaliser_version() : string
- Retourne '00x.00y.00z' à partir de 'x.y.z'
Constants
_SVP_VERSION_SPIP_MAX
Version SPIP maximale
public
mixed
_SVP_VERSION_SPIP_MAX
= '4.2.999'
Pour l'instant on ne connait pas la borne sup exacte
_SVP_VERSION_SPIP_MIN
Version SPIP minimale quand un plugin ne le precise pas
public
mixed
_SVP_VERSION_SPIP_MIN
= '1.9.0'
Version SPIP correspondant à l'apparition des plugins
Functions
fusionner_intervalles()
Fusionne 2 intervalles de compatibilité
fusionner_intervalles(string $intervalle_a, string $intervalle_b) : string
Soit '[1.9;2.1]' et '[2.1;3.0.]', la fonction retourne '[1.9;3.0.]'
En gros la fonction est utilisé pour calculer l'intervalle de validité d'un plugin ayant plusieurs paquets avec des compatibilités différentes. La compatibilité du plugin est le total de toutes les compatibilités.
Parameters
- $intervalle_a : string
-
Intervalle de compatibilité
- $intervalle_b : string
-
Intervalle de compatibilité
Tags
Return values
string —Intervalle de compatibilité
extraire_bornes()
Extrait les valeurs d'un intervalle de compatibilité.
extraire_bornes(string $intervalle[, bool $initialiser = false ]) : array<string|int, mixed>
Calcule les valeurs min, max et si ces valeurs sont intégrées ou non à l'intervalle. Les bornes vides sont initialisées avec la borne min ou max de SPIP. Les caractères * sont renvoyés tels quels.
Parameters
- $intervalle : string
-
Intervalle de compatibilité, tel que '[2.1;3.0]'
- $initialiser : bool = false
-
- True pour mettre les valeurs connues mini et maxi de SPIP lorsque les bornes ne sont pas renseignées dans l'intervalle.
- False pour ne rien mettre sinon.
Tags
Return values
array<string|int, mixed> —Tableau avec les index :
- min : la borne inférieure, qui contient les index 'valeur' et 'incluse'
- max : la borne supérieure, qui contient les index 'valeur' et 'incluse' Le sous index 'incluse' vaut true si cette borne est incluse dans l'intervalle.
construire_intervalle()
Contruit un intervalle de compatibilité
construire_intervalle(array<string|int, mixed> $bornes[, string $dtd = 'paquet' ]) : string
Parameters
- $bornes : array<string|int, mixed>
-
L'intervalle décrit sous forme de tableau avec pour index :
- min : la borne inférieure, qui contient les index 'valeur' et 'incluse'
- max : la borne supérieure, qui contient les index 'valeur' et 'incluse' Le sous index 'incluse' vaut true si cette borne est incluse dans l'intervalle.
- $dtd : string = 'paquet'
-
DTD de destination (paquet ou plugin) qui influera sur l'écriture à faire en utilisant des parenthèses ou des crochets pour définir l'exclusion d'une intervalle tel que ']2.1.2,3.0.1[' (paquet) ou '(2.1.2,3.0.1)' (plugin)
Tags
Return values
string —Intervalle de compatibilité tel que '[2.1;3.0]'
compiler_branches_spip()
Retourne la liste des branches de SPIP comprises dans un intervalle de compatibilité donné.
compiler_branches_spip(string $intervalle) : string
La borne inférieure ne peut pas posséder le caractère * et peut être libellée x, x.y ou x.y.z (écriture recommandée).
La borne supérieure peut posséder des étoiles en y ou z.
Parameters
- $intervalle : string
-
Intervalle de compatibilité, tel que [2.0.0;3.0.0]
Tags
Return values
string —Branches de SPIP séparées par des virgules, tel que 2.0,2.1,3.0
entite2charset()
Transforme un texte écrit en entités HTML, dans le charset du site
entite2charset(string $texte[, string $charset = null ]) : string
Parameters
- $texte : string
-
Texte avec des entités HTML
- $charset : string = null
Return values
string —$texte Texte dans le charset du site
balise_identique()
Teste si 2 balises XML sont identiques
balise_identique(array<string|int, mixed>|string $balise1, array<string|int, mixed>|string $balise2) : bool
Parameters
- $balise1 : array<string|int, mixed>|string
-
Balise à comparer
- $balise2 : array<string|int, mixed>|string
-
Balise à comparer
Return values
bool —True si elles sont identiques, false sinon.
definir_licence()
Déterminer la licence exacte avec un nom et un lien de doc standardisé
definir_licence(string $prefixe, string $nom, string $suffixe, string $version) : array<string|int, mixed>
Parameters
- $prefixe : string
-
Préfixe de la licence tel que gnu, free, cc, creative common
- $nom : string
-
Nom de la licence tel que gpl, lgpl, agpl, fdl, mit, bsd...
- $suffixe : string
-
Suffixe de la licence tel que licence, -sharealike, -nc-nd ...
- $version : string
-
Version de la licence tel que 3.0
Return values
array<string|int, mixed> —Si la licence est connu, retourne 2 index :
- nom : le nom le la licence
- url : lien vers la licence
svp_lister_librairies()
Liste les librairies présentes
svp_lister_librairies() : array<string|int, mixed>
Cherche des librairie dans tous les dossiers 'lib' présents dans chaque chemin déclaré (plugins, squelettes, SPIP). Un répertoire dans un dossier 'lib' est considéré comme une librairie, et le nom de ce répertoire est utilisé comme nom de la librairie.
Return values
array<string|int, mixed> —Tableau de couples (nom de la librairie => répertoire de la librairie)
normaliser_version()
Retourne '00x.00y.00z' à partir de 'x.y.z'
normaliser_version([string $version = '' ]) : string
Retourne la chaine de la version x.y.z sous une forme normalisée permettant le tri naturel. On complète à gauche d'un nombre de zéro manquant pour aller à 3 caractères entre chaque point.
Parameters
- $version : string = ''
-
Numéro de version dénormalisée
Tags
Return values
string —Numéro de version normalisée