svp_fonctions.php
Déclarations de fonctions
Tags
Table of Contents
Functions
- svp_importer_charset() : mixed
- svp_afficher_intervalle() : string
- Retourne un texte expliquant l'intervalle de compatibilité avec un plugin ou SPIP
- svp_afficher_etat() : string
- Traduit un type d'état de plugin
- svp_afficher_dependances() : string
- Retourne un texte HTML présentant la liste des dépendances d'un plugin
- svp_afficher_credits() : string
- Retourne un texte HTML présentant les crédits d'un plugin
- svp_afficher_langues() : string
- Retourne un texte HTML présentant la liste des langues et traducteurs d'un plugin
- svp_traduire_type_depot() : string
- Traduit un type de dépot de plugin
- svp_calculer_url_demo() : string
- Calcule l'url exacte d'un lien de démo en fonction de son écriture
- critere_compatible_spip_dist() : mixed
- Critère de compatibilité avec une version précise ou une branche de SPIP ou une liste de branches séparées par une virgule.
- filtre_construire_recherche_plugins() : array<string|int, mixed>
- Retourne la liste des plugins trouvés par une recherche
- filtre_svp_periode_actualisation_depots() : int
- Retourne le nombre d'heures entre chaque actualisation si le cron est activé.
- denormaliser_version() : string
- Retourne 'x.y.z' à partir de '00x.00y.00z'
- test_plugins_auto() : bool
- Teste l'utilisation du répertoire auto des plugins.
- filtre_svp_diff_xyz() : string
- Compare 2 numéros de versions et indique le composant principal qui change : X, Y ou Z.
- filtre_svp_affichage_filtrer_paquets_dist() : bool
- Appel a un pipeline pour filtrer eventuellement l'affichage de certains plugins (ie si on a zen-garden actif, les themes ne sont plus affiches dans la gestion des plugins, mais dans le zen garden)
Functions
svp_importer_charset()
svp_importer_charset(mixed $texte) : mixed
Parameters
- $texte : mixed
svp_afficher_intervalle()
Retourne un texte expliquant l'intervalle de compatibilité avec un plugin ou SPIP
svp_afficher_intervalle(string $intervalle, string $logiciel) : string
Retourne par exemple "2.0 <= SPIP < 3.1"
Parameters
- $intervalle : string
-
L'intervalle tel que déclaré dans paquet.xml. Par exemple "[2.1;3.0.*]"
- $logiciel : string
-
Nom du plugin pour qui est cette intervalle
Return values
string —Texte expliquant l'intervalle
svp_afficher_etat()
Traduit un type d'état de plugin
svp_afficher_etat(string $etat) : string
Si l'état n'existe pas, prendra par défaut 'developpement'
Parameters
- $etat : string
-
Le type d'état (stable, test, ...)
Tags
Return values
string —Traduction de l'état dans la langue en cours
svp_afficher_dependances()
Retourne un texte HTML présentant la liste des dépendances d'un plugin
svp_afficher_dependances(string $balise_serialisee[, string $dependance = 'necessite' ][, string $sep = '<br />' ][, string $lien = 'local' ]) : string
Des liens vers les plugins dépendants sont présents lorsque les plugins en dépendance sont connus dans notre base.
Parameters
- $balise_serialisee : string
-
Informations des dépendances (tableau sérialisé) tel que stocké en base dans la table spip_paquets
- $dependance : string = 'necessite'
-
Type de dépendances à afficher (necessite ou utilise). Une autre valeur indique qu'on demande la liste des librairies dépendantes.
- $sep : string = '<br />'
-
Séparateur entre les noms de dépendances
- $lien : string = 'local'
-
Type de lien affecté au plugin référencé dans la base locale. Prend les valeurs :- local : le lien pointe vers la page publique du plugin sur le site lui-même. Il faut donc que le site propose des pages publiques pour les plugins sinon une 404 sera affichée;
- pluginspip : le lien pointe vers la page du plugin sur le site de référence Plugins SPIP;
- non : aucun lien n'est affiché.
Tags
Return values
string —Texte informant des dépendances
svp_afficher_credits()
Retourne un texte HTML présentant les crédits d'un plugin
svp_afficher_credits(string $balise_serialisee[, string $sep = ', ' ]) : string
Des liens vers les crédits sont présents lorsqu'ils sont déclarés dans le paquet.xml.
Parameters
- $balise_serialisee : string
-
Informations des crédits (tableau sérialisé) tel que stocké en base dans la table spip_paquets
- $sep : string = ', '
-
Séparateur entre les différents crédits
Return values
string —Texte informant des crédits
svp_afficher_langues()
Retourne un texte HTML présentant la liste des langues et traducteurs d'un plugin
svp_afficher_langues(array<string|int, mixed> $langues[, string $sep = ', ' ]) : string
Des liens vers les traducteurs sont présents lorsqu'ils sont connus.
Parameters
- $langues : array<string|int, mixed>
-
Tableau code de langue => traducteurs
- $sep : string = ', '
-
Séparateur entre les différentes langues
Return values
string —Texte informant des langues et traducteurs
svp_traduire_type_depot()
Traduit un type de dépot de plugin
svp_traduire_type_depot(string $type) : string
Parameters
- $type : string
-
Type de dépot (svn, git, manuel)
Return values
string —Titre complet et traduit du type de dépot
svp_calculer_url_demo()
Calcule l'url exacte d'un lien de démo en fonction de son écriture
svp_calculer_url_demo(string $url_demo[, bool $url_absolue = false ]) : string
Parameters
- $url_demo : string
-
URL de démonstration telle que saisie dans le paquet.xml
- $url_absolue : bool = false
-
Indique que seules les url absolues doivent être retournées par la fonction. Tous les autres types d'url renvoient une chaine vide
Return values
string —URL calculée en fonction de l'URL d'entrée
critere_compatible_spip_dist()
Critère de compatibilité avec une version précise ou une branche de SPIP ou une liste de branches séparées par une virgule.
critere_compatible_spip_dist(string $idb, array<string|int, mixed> &$boucles, Critere $crit) : mixed
Fonctionne sur les tables spip_paquets et spip_plugins. Si aucune valeur n'est explicité dans le critère on interroge le contexte pour trouver une variable compatible_spip et sinon tous les objets sont retournés.
Le ! (NOT) ne fonctionne que sur une branche ou une liste de branches SPIP.
Parameters
- $idb : string
-
Identifiant de la boucle
- $boucles : array<string|int, mixed>
-
AST du squelette
- $crit : Critere
-
Paramètres du critère dans cette boucle
Tags
filtre_construire_recherche_plugins()
Retourne la liste des plugins trouvés par une recherche
filtre_construire_recherche_plugins([string $phrase = '' ][, string $etat = '' ][, string|int $depot = '' ][, bool|string $afficher_exclusions = true ][, bool|string $afficher_doublons = false ]) : array<string|int, mixed>
Parameters
- $phrase : string = ''
-
Texte de la recherche
- $etat : string = ''
-
État de plugin (stable, test...)
- $depot : string|int = ''
-
Identifiant de dépot
- $afficher_exclusions : bool|string = true
-
Afficher aussi les paquets déjà installés (true ou 'oui') ou ceux qui ne le sont pas (false) ?
- $afficher_doublons : bool|string = false
-
Afficher toutes les versions de paquet (true ou 'oui') ou seulement la plus récente (false) ?
Tags
Return values
array<string|int, mixed> —Tableau classé par pertinence de résultat
- 'prefixe' => tableau de description du paquet (si pas de doublons demandé)
- n => tableau de descriptions du paquet (si doublons autorisés)
filtre_svp_periode_actualisation_depots()
Retourne le nombre d'heures entre chaque actualisation si le cron est activé.
filtre_svp_periode_actualisation_depots() : int
Return values
int —Nombre d'heures (sinon 0)
denormaliser_version()
Retourne 'x.y.z' à partir de '00x.00y.00z'
denormaliser_version([string $version_normalisee = '' ]) : string
Retourne la chaine de la version x.y.z sous sa forme initiale, sans remplissage à gauche avec des 0.
Parameters
- $version_normalisee : string = ''
-
Numéro de version normalisée
Tags
Return values
string —Numéro de version dénormalisée
test_plugins_auto()
Teste l'utilisation du répertoire auto des plugins.
test_plugins_auto() : bool
Ce répertoire permet de télécharger dedans des plugins lorsqu'il est présent.
Return values
bool —Le répertoire de chargement des plugins auto est-il présent et utilisable ?
filtre_svp_diff_xyz()
Compare 2 numéros de versions et indique le composant principal qui change : X, Y ou Z.
filtre_svp_diff_xyz(string $version1, string $version2) : string
Parameters
- $version1 : string
-
Numéro de version initial
- $version2 : string
-
Numéro de version à comparer
Tags
Return values
string —x | y | z ou une chaîne vide si pas de différence ou erreur.
filtre_svp_affichage_filtrer_paquets_dist()
Appel a un pipeline pour filtrer eventuellement l'affichage de certains plugins (ie si on a zen-garden actif, les themes ne sont plus affiches dans la gestion des plugins, mais dans le zen garden)
filtre_svp_affichage_filtrer_paquets_dist(int $id_paquet) : bool
Parameters
- $id_paquet : int