Fichier plugins-dist/svp/svp_fonctions.php

Déclarations de fonctions

Plugin

  • SVP pour SPIP

License

  • GPL

Source

Proposer une amélioration

Liste des fonctions

balise_SVP_BRANCHES_SPIP()

Compile la balise #SVP_BRANCHES_SPIP

Cette balise retourne une liste des branches de SPIP

Avec un paramètre indiquant une branche, la balise retourne une liste des bornes mini et maxi de cette branche.

\Champ balise_SVP_BRANCHES_SPIP( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • SVP_BRANCHES_SPIP : array('1.9', '2.0', '2.1', ....)

    SVP_BRANCHES_SPIP{3.0} : array('3.0.0', '3.0.99')

Voir également

Package

Balise

  • SVP_BRANCHES_SPIP

Source

Proposer une amélioration
balise_SVP_CATEGORIES()

Compile la balise #SVP_CATEGORIES

Cette balise retourne un tableau listant chaque type de catégorie en index, associé à sa traduction en valeur.

Accepte 2 paramètres : 1) le type du tri (ordre_cle ou ordre_alpha) 2) une catégorie (dans ce cas, limite le tableau à cette seule catégorie si elle existe)

\Champ balise_SVP_CATEGORIES( \Champ $p )

Paramètres

  1. \Champ $p

    Pile au niveau de la balise

Retour

  • \Champ

    Pile complétée par le code à générer

Exemples

  • SVP_CATEGORIES #SVP_CATEGORIES{ordre_alpha}

    SVP_CATEGORIES{ordre_cle,auteur}

Voir également

Package

Balise

  • SVP_CATEGORIES

Source

Proposer une amélioration
calcul_svp_branches_spip()

Retourne une liste des branches de SPIP, ou les bornes mini et maxi d'une branche donnée
array calcul_svp_branches_spip( string $branche )

Paramètres

  1. string $branche

    Branche dont on veut récupérer les bornes mini et maxi

Retour

  • array

    Liste des branches array('1.9', '2.0', '2.1', ....) ou liste mini et maxi d'une branche array('3.0.0', '3.0.99')

Package

Source

Proposer une amélioration
calcul_svp_categories()

Retourne un tableau listant chaque type de catégorie en index, associé à sa traduction en valeur.
array calcul_svp_categories( string $tri = 'ordre_cle' , string $categorie = '' )

Paramètres

  1. string $tri = 'ordre_cle'

    Type de tri (ordre_cle ou ordre_alpha)

  2. string $categorie = ''

    Restreindre le tableau de retour à cette catégorie si elle existe

Retour

  • array

    Couples (type de catégorie => Texte de la catégorie)

Utilise

Package

Source

Proposer une amélioration
critere_compatible_spip_dist()

Critère de compatibilité avec une version précise ou une branche de SPIP.

Fonctionne sur les tables spip_paquets et spip_plugins

Si aucune valeur n'est explicité dans le critère, tous les enregistrements sont retournés.

Le ! (NOT) fonctionne sur le critère BRANCHE

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}}

Package

Critere

  • compatible_spip

Source

Proposer une amélioration
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

Proposer une amélioration
filtre_construire_recherche_plugins()

Retourne la liste des plugins trouvés par une recherche
array filtre_construire_recherche_plugins( string $phrase = '' , string $categorie = '' , 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 $categorie = ''

    Type de catégorie de plugin (auteur, date...)

  3. string $etat = ''

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

  4. string | integer $depot = ''

    Identifiant de dépot

  5. boolean | string $afficher_exclusions = true

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

  6. 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

Proposer une amélioration
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
Proposer une amélioration
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

Proposer une amélioration
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

Proposer une amélioration
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

Proposer une amélioration
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

Proposer une amélioration
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

Proposer une amélioration
svp_afficher_statistiques_globales()

Retourne un texte HTML présentant des statistiques d'un dépot

Liste le nombre de plugins et de paquets d'un dépot Indique aussi le nombre de dépots si l'on ne demande pas de dépot particulier.

string svp_afficher_statistiques_globales( integer $id_depot )

Paramètres

  1. integer $id_depot

    Identifiant du dépot

Retour

  • string

    Code HTML présentant les statistiques du dépot

Utilise

Package

Source

Proposer une amélioration
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

Proposer une amélioration
svp_compter()

Compte le nombre de plugins, paquets ou autres contributions en fonction de l'entité demandée et de contraintes

Calcule, pour un type d'entité demandé (depot, plugin, paquet, catégorie) leur nombre en fonction de certaines contraintes, tel que l'appartenance à un certain dépot, une certaine catégorie ou une certaine branche de SPIP.

Lorsque l'entité demandée est un dépot, le tableau des totaux possède, en plus du nombre de dépots, le nombre de plugins et paquets.

array svp_compter( string $entite , integer $id_depot , string $categorie = '' , string $compatible_spip = '' )

Paramètres

  1. string $entite

    De quoi veut-on obtenir des comptes. Peut être 'depot', 'plugin', 'paquet' ou 'categorie'

  2. integer $id_depot

    Identifiant du dépot Zéro (par défaut) signifie ici : «dans tous les dépots distants» (id_dépot>0) et non «dans le dépot local»

  3. string $categorie = ''

    Type de catégorie (auteur, communication, date...)

  4. string $compatible_spip = ''

    Numéro de branche de SPIP. (3.0, 2.1, ...)

Retour

  • array

    Couples (entite => nombre).

Utilisé par

Package

Note

  • Attention le critère de compatibilite SPIP pris en compte est uniquement celui d'une branche SPIP

Source

Proposer une amélioration
svp_compter_depots()

Retourne un texte indiquant un nombre total de contributions pour un dépot

Calcule différents totaux pour un dépot donné et retourne un texte de ces différents totaux. Les totaux correspondent par défaut aux plugins et paquets, mais l'on peut demander le total des autres contributions avec le second paramètre.

string svp_compter_depots( integer $id_depot , string $contrib = 'plugin' )

Paramètres

  1. integer $id_depot

    Identifiant du dépot Zéro (par défaut) signifie ici : «dans tous les dépots distants» (id_dépot>0) et non «dans le dépot local»

  2. string $contrib = 'plugin'

    Type de total demandé ('plugin' ou autre) Si 'plugin' : indique le nombre de plugins et de paquets du dépot Si autre chose : indique le nombre des autres contributions, c'est à dire des zips qui ne sont pas des plugins, comme certaines libraires ou certains jeux de squelettes.

Retour

  • string

    Texte indiquant certains totaux tel que nombre de plugins, nombre de paquets...

Utilise

Package

Source

Proposer une amélioration
svp_compter_plugins()

Retourne un texte indiquant un nombre total de plugins

Calcule le nombre de plugins correspondant à certaines contraintes, tel que l'appartenance à un certain dépot, une certaine catégorie ou une certaine branche de SPIP et retourne une phrase traduite tel que «64 plugins disponibles»

string svp_compter_plugins( integer $id_depot , string $categorie = '' , string $compatible_spip = '' )

Paramètres

  1. integer $id_depot

    Identifiant du dépot Zéro (par défaut) signifie ici : «dans tous les dépots distants» (id_dépot>0) et non «dans le dépot local»

  2. string $categorie = ''

    Type de catégorie (auteur, communication, date...)

  3. string $compatible_spip = ''

    Numéro de branche de SPIP. (3.0, 2.1, ...)

Retour

  • string

    Texte indiquant un nombre total de paquets

Utilise

Package

Source

Proposer une amélioration
svp_compter_telechargements()

Retourne un texte indiquant un nombre total de paquets

Calcule le nombre de paquets correspondant à certaines contraintes, tel que l'appartenance à un certain dépot, une certaine catégorie ou une certaine branche de SPIP et retourne une phrase traduite tel que «78 paquets disponibles»

string svp_compter_telechargements( integer $id_depot , string $categorie = '' , string $compatible_spip = '' )

Paramètres

  1. integer $id_depot

    Identifiant du dépot Zéro (par défaut) signifie ici : «dans tous les dépots distants» (id_dépot>0) et non «dans le dépot local»

  2. string $categorie = ''

    Type de catégorie (auteur, communication, date...)

  3. string $compatible_spip = ''

    Numéro de branche de SPIP. (3.0, 2.1, ...)

Retour

  • string

    Texte indiquant un nombre total de paquets

Utilise

Package

Source

Proposer une amélioration
svp_dependances_existe()

Teste si un plugin possède des dépendances
boolean svp_dependances_existe( string $balise_serialisee )

Paramètres

  1. string $balise_serialisee

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

Retour

  • boolean

    Le plugin possède t'il des dépendances ?

Package

Source

Proposer une amélioration
svp_importer_charset()
void svp_importer_charset( $texte )

Paramètres

  1. $texte

Package

Source

Proposer une amélioration
svp_traduire_categorie()

Traduit un type de catégorie de plugin
string svp_traduire_categorie( string $alias )

Paramètres

  1. string $alias

    Type de catégorie (auteur, communication, date...)

Retour

  • string

    Titre complet et traduit de la catégorie

Utilisé par

Package

Source

Proposer une amélioration
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

Proposer une amélioration
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

Proposer une amélioration

Liste des erreurs

GravitéLigneDescription
Erreur 11
  • No summary for function \svp_importer_charset()
  • Argument $texte is missing from the Docblock of svp_importer_charset