Documentation du code de SPIP et de ses plugins

SVP

svp_rechercher.php

Gestion des recherches de plugins

Tags
plugin

SVP pour SPIP

license

GPL

Table of Contents

Functions

svp_rechercher_plugins_spip()  : array<string|int, mixed>
Calcule une liste des paquets en fonctions de critères de recherche
svp_lister_plugins_installes()  : array<string|int, mixed>
Récupère les identifiants des plugins déjà installés
svp_verifier_compatibilite_spip()  : bool
Teste la compatibilité d'un intervalle de compatibilité avec une version donnée de SPIP
svp_trier_par_score()  : int
Callback de tri pour trier les résultats de plugin par score décroissant.
svp_trier_par_nom()  : int
Callback de tri pour trier les résultats de plugin par nom (alphabétique).

Functions

svp_rechercher_plugins_spip()

Calcule une liste des paquets en fonctions de critères de recherche

svp_rechercher_plugins_spip(string $phrase, string $etat, string|int $depot[, string $version_spip = '' ][, array<string|int, mixed> $exclusions = [] ][, bool $afficher_exclusions = false ][, bool $doublon = false ][, string $tri = 'nom' ]) : array<string|int, mixed>

Cette liste :

  • est sans doublons, ie on ne garde que la version la plus récente
  • correspond aux critères
  • est compatible avec la version SPIP installée sur le site
  • ne liste pas ceux étant déjà installés (ces paquets peuvent toutefois être affichés)
  • est triée par nom ou score
Parameters
$phrase : string

Texte de la recherche

$etat : string

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

$depot : string|int

Identifiant de dépot

$version_spip : string = ''

Version de SPIP dont le paquet doit être compatible

$exclusions : array<string|int, mixed> = []

Liste d'identifiants de plugin à ne pas intégrer dans la liste

$afficher_exclusions : bool = false

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

$doublon : bool = false

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

$tri : string = 'nom'

Ordre du tri : nom | score

Tags
uses
liste_des_champs()
uses
recherche_en_base()
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)

svp_lister_plugins_installes()

Récupère les identifiants des plugins déjà installés

svp_lister_plugins_installes() : array<string|int, mixed>
Tags
uses
liste_plugin_actifs()
Return values
array<string|int, mixed>

Liste d'identifiants de plugins

svp_verifier_compatibilite_spip()

Teste la compatibilité d'un intervalle de compatibilité avec une version donnée de SPIP

svp_verifier_compatibilite_spip(string $intervalle[, string $version_spip = '' ]) : bool
Parameters
$intervalle : string

Intervalle de compatibilité, tel que [2.1;3.0]

$version_spip : string = ''

Version de SPIP, tel que 3.0.4 (par défaut la version de SPIP en cours)

Tags
uses
plugin_version_compatible()
Return values
bool

true si l'intervalle est compatible, false sinon

svp_trier_par_score()

Callback de tri pour trier les résultats de plugin par score décroissant.

svp_trier_par_score(array<string|int, mixed> $p1, array<string|int, mixed> $p2) : int

Cette fonction est appelée par un usort ou uasort

Parameters
$p1 : array<string|int, mixed>

Plugin à comparer

$p2 : array<string|int, mixed>

Plugin à comparer

Return values
int

svp_trier_par_nom()

Callback de tri pour trier les résultats de plugin par nom (alphabétique).

svp_trier_par_nom(array<string|int, mixed> $p1, array<string|int, mixed> $p2) : int

Si le nom est identique on classe par version decroissante Cette fonction est appelée par un usort ou uasort

Parameters
$p1 : array<string|int, mixed>

Plugin à comparer

$p2 : array<string|int, mixed>

Plugin à comparer

Return values
int

        
On this page

Search results