Fichier plugins-dist/svp/svp_fonctions.php

Déclarations de fonctions

Plugin

  • SVP pour SPIP

License

  • GPL

Source

Liste des fonctions

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.

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.

void critere_compatible_spip_dist( string $idb , array & $boucles , \Critere $crit )

Paramètres

  1. string $idb

    Identifiant de la boucle

  2. array & $boucles

    AST du squelette

  3. \Critere $crit

    Paramètres du critère dans cette boucle

Retour

  • void

Exemples

  • {compatible_spip} {compatible_spip 2.0.8} ou {compatible_spip 1.9} {compatible_spip #ENV{vers}} ou {compatible_spip #ENV{vers, 1.9.2}} {compatible_spip #GET{vers}} ou {compatible_spip #GET{vers, 2.1}} {compatible_spip '2.0,2.1'} {!compatible_spip 2.0} {!compatible_spip '2.0,2.1'} {!compatible_spip #ENV{vers}} ou {!compatible_spip #GET{vers}}

Package

Critere

  • compatible_spip

Source

denormaliser_version()

Retourne 'x.y.z' à partir de '00x.00y.00z'

Retourne la chaine de la version x.y.z sous sa forme initiale, sans remplissage à gauche avec des 0.

string denormaliser_version( string $version_normalisee = '' )

Paramètres

  1. string $version_normalisee = ''

    Numéro de version normalisée

Retour

  • string

    Numéro de version dénormalisée

Voir également

Package

Source

filtre_construire_recherche_plugins()

Retourne la liste des plugins trouvés par une recherche
array filtre_construire_recherche_plugins( string $phrase = '' , string $etat = '' , string | integer $depot = '' , boolean | string $afficher_exclusions = true , boolean | string $afficher_doublons = false )

Paramètres

  1. string $phrase = ''

    Texte de la recherche

  2. string $etat = ''

    État de plugin (stable, test...)

  3. string | integer $depot = ''

    Identifiant de dépot

  4. boolean | string $afficher_exclusions = true

    Afficher aussi les paquets déjà installés (true ou 'oui') ou ceux qui ne le sont pas (false) ?

  5. boolean | string $afficher_doublons = false

    Afficher toutes les versions de paquet (true ou 'oui') ou seulement la plus récente (false) ?

Retour

  • array

    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)

Package

Filtre

  • construire_recherche_plugins

Source

filtre_svp_diff_xyz()

Compare 2 numéros de versions et indique le composant principal qui change : X, Y ou Z.
string filtre_svp_diff_xyz( string $version1 , string $version2 )

Paramètres

  1. string $version1

    Numéro de version initial

  2. string $version2

    Numéro de version à comparer

Retour

  • string

    x | y | z ou une chaîne vide si pas de différence ou erreur.

Voir également

Package

Note

  • Ne regarde pas si une version est plus récente qu'une autre, donne juste la différence.
    • X = version majeure
    • Y = version mineure
    • Z = patch

Source

Filtre

  • svp_diff_xyz
filtre_svp_periode_actualisation_depots()

Retourne le nombre d'heures entre chaque actualisation si le cron est activé.
integer filtre_svp_periode_actualisation_depots( )

Retour

  • integer

    Nombre d'heures (sinon 0)

Package

Source

Filtre

  • svp_periode_actualisation_depots
svp_afficher_credits()

Retourne un texte HTML présentant les crédits d'un plugin

Des liens vers les crédits sont présents lorsqu'ils sont déclarés dans le paquet.xml.

string svp_afficher_credits( string $balise_serialisee , string $sep = ', ' )

Paramètres

  1. string $balise_serialisee

    Informations des crédits (tableau sérialisé) tel que stocké en base dans la table spip_paquets

  2. string $sep = ', '

    Séparateur entre les différents crédits

Retour

  • string

    Texte informant des crédits

Package

Source

svp_afficher_dependances()

Retourne un texte HTML présentant la liste des dépendances d'un plugin

Des liens vers les plugins dépendants sont présents lorsque les plugins en dépendance sont connus dans notre base.

string svp_afficher_dependances( string $balise_serialisee , string $dependance = 'necessite' , string $sep = '<br />' , string $lien = 'local' )

Paramètres

  1. string $balise_serialisee

    Informations des dépendances (tableau sérialisé) tel que stocké en base dans la table spip_paquets

  2. string $dependance = 'necessite'

    Type de dépendances à afficher (necessite ou utilise). Une autre valeur indique qu'on demande la liste des librairies dépendantes.

  3. string $sep = '<br />'

    Séparateur entre les noms de dépendances

  4. string $lien = '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é.

Retour

  • string

    Texte informant des dépendances

Utilise

Package

Source

svp_afficher_etat()

Traduit un type d'état de plugin

Si l'état n'existe pas, prendra par défaut 'developpement'

string svp_afficher_etat( string $etat )

Paramètres

  1. string $etat

    Le type d'état (stable, test, ...)

Retour

  • string

    Traduction de l'état dans la langue en cours

Voir également

Package

Source

svp_afficher_intervalle()

Retourne un texte expliquant l'intervalle de compatibilité avec un plugin ou SPIP

Retourne par exemple "2.0 <= SPIP < 3.1"

string svp_afficher_intervalle( string $intervalle , string $logiciel )

Paramètres

  1. string $intervalle

    L'intervalle tel que déclaré dans paquet.xml. Par exemple "[2.1;3.0.*]"

  2. string $logiciel

    Nom du plugin pour qui est cette intervalle

Retour

  • string

    Texte expliquant l'intervalle

Utilisé par

Package

Source

svp_afficher_langues()

Retourne un texte HTML présentant la liste des langues et traducteurs d'un plugin

Des liens vers les traducteurs sont présents lorsqu'ils sont connus.

string svp_afficher_langues( array $langues , string $sep = ', ' )

Paramètres

  1. array $langues

    Tableau code de langue => traducteurs

  2. string $sep = ', '

    Séparateur entre les différentes langues

Retour

  • string

    Texte informant des langues et traducteurs

Package

Source

svp_calculer_url_demo()

Calcule l'url exacte d'un lien de démo en fonction de son écriture
string svp_calculer_url_demo( string $url_demo , boolean $url_absolue = false )

Paramètres

  1. string $url_demo

    URL de démonstration telle que saisie dans le paquet.xml

  2. boolean $url_absolue = false

    Indique que seules les url absolues doivent être retournées par la fonction. Tous les autres types d'url renvoient une chaine vide

Retour

  • string

    URL calculée en fonction de l'URL d'entrée

Package

Source

svp_importer_charset()
void svp_importer_charset( $texte )

Paramètres

  1. $texte

Package

Source

svp_traduire_type_depot()

Traduit un type de dépot de plugin
string svp_traduire_type_depot( string $type )

Paramètres

  1. string $type

    Type de dépot (svn, git, manuel)

Retour

  • string

    Titre complet et traduit du type de dépot

Package

Source

test_plugins_auto()

Teste l'utilisation du répertoire auto des plugins.

Ce répertoire permet de télécharger dedans des plugins lorsqu'il est présent.

boolean test_plugins_auto( )

Retour

  • boolean

    Le répertoire de chargement des plugins auto est-il présent et utilisable ?

Package

Source

Liste des erreurs

GravitéLigneDescription
Erreur 11
  • Argument $texte is missing from the Docblock of svp_importer_charset
  • No summary for function \svp_importer_charset()
Notice 517
  • Référence de @see introuvable dans filtre_svp_diff_xyz : https://semver.org/