PLUGIN
Table of Contents
Constants
- _SVPAPI_CONFIG_CHAMPS = ['plugin' => [ // SVP référentiel par défaut 'prefixe' => ['svp' => \true, 'type' => ''], 'nom' => ['svp' => \true, 'type' => 'multi'], 'slogan' => ['svp' => \true, 'type' => 'multi'], 'vmax' => ['svp' => \true, 'type' => 'version'], 'date_crea' => ['svp' => \false, 'type' => ''], 'date_modif' => ['svp' => \false, 'type' => ''], 'compatibilite_spip' => ['svp' => \true, 'type' => ''], 'branches_spip' => ['svp' => \true, 'type' => 'liste'], // SVP Statistiques 'nbr_sites' => ['svp' => \false, 'type' => ''], 'popularite' => ['svp' => \false, 'type' => ''], ], 'paquet' => [ // SVP référentiel par défaut 'prefixe' => ['svp' => \true, 'type' => ''], 'logo' => ['svp' => \true, 'type' => ''], 'version' => ['svp' => \true, 'type' => 'version'], 'version_base' => ['svp' => \true, 'type' => 'version'], 'compatibilite_spip' => ['svp' => \true, 'type' => ''], 'branches_spip' => ['svp' => \true, 'type' => 'liste'], 'description' => ['svp' => \true, 'type' => 'multi'], 'auteur' => ['svp' => \true, 'type' => 'serial'], 'credit' => ['svp' => \false, 'type' => 'serial'], 'licence' => ['svp' => \false, 'type' => 'serial'], 'copyright' => ['svp' => \false, 'type' => 'serial'], 'lien_doc' => ['svp' => \true, 'type' => ''], 'lien_demo' => ['svp' => \true, 'type' => ''], 'lien_dev' => ['svp' => \false, 'type' => ''], 'etat' => ['svp' => \true, 'type' => ''], 'etatnum' => ['svp' => \true, 'type' => ''], 'dependances' => ['svp' => \false, 'type' => 'serial'], 'procure' => ['svp' => \false, 'type' => 'serial'], 'date_crea' => ['svp' => \false, 'type' => ''], 'date_modif' => ['svp' => \false, 'type' => ''], 'nom_archive' => ['svp' => \true, 'type' => ''], 'nbo_archive' => ['svp' => \true, 'type' => ''], 'maj_archive' => ['svp' => \true, 'type' => ''], 'src_archive' => ['svp' => \true, 'type' => ''], 'traductions' => ['svp' => \false, 'type' => 'serial'], ]]
- Liste des champs des objets plugin ou paquet contenue dans la réponse à l'API et type de normalisation à effectuer sur chaque champ le cas échéant.
Functions
- plugin_normaliser_champs() : array<string|int, mixed>
- Transforme, pour un objet plugin ou paquet, les champs sérialisés, multi et liste (chaine d'éléments séparés par une virgule) en tableau et supprime des champs de type version les 0 à gauche des numéros.
- plugin_lister_champs() : array<string|int, mixed>
- Renvoie la liste des champs à renvoyer suite à une requête sur les collections paquets ou plugins.
Constants
_SVPAPI_CONFIG_CHAMPS
Liste des champs des objets plugin ou paquet contenue dans la réponse à l'API et type de normalisation à effectuer sur chaque champ le cas échéant.
public
mixed
_SVPAPI_CONFIG_CHAMPS
= ['plugin' => [
// SVP référentiel par défaut
'prefixe' => ['svp' => \true, 'type' => ''],
'nom' => ['svp' => \true, 'type' => 'multi'],
'slogan' => ['svp' => \true, 'type' => 'multi'],
'vmax' => ['svp' => \true, 'type' => 'version'],
'date_crea' => ['svp' => \false, 'type' => ''],
'date_modif' => ['svp' => \false, 'type' => ''],
'compatibilite_spip' => ['svp' => \true, 'type' => ''],
'branches_spip' => ['svp' => \true, 'type' => 'liste'],
// SVP Statistiques
'nbr_sites' => ['svp' => \false, 'type' => ''],
'popularite' => ['svp' => \false, 'type' => ''],
], 'paquet' => [
// SVP référentiel par défaut
'prefixe' => ['svp' => \true, 'type' => ''],
'logo' => ['svp' => \true, 'type' => ''],
'version' => ['svp' => \true, 'type' => 'version'],
'version_base' => ['svp' => \true, 'type' => 'version'],
'compatibilite_spip' => ['svp' => \true, 'type' => ''],
'branches_spip' => ['svp' => \true, 'type' => 'liste'],
'description' => ['svp' => \true, 'type' => 'multi'],
'auteur' => ['svp' => \true, 'type' => 'serial'],
'credit' => ['svp' => \false, 'type' => 'serial'],
'licence' => ['svp' => \false, 'type' => 'serial'],
'copyright' => ['svp' => \false, 'type' => 'serial'],
'lien_doc' => ['svp' => \true, 'type' => ''],
'lien_demo' => ['svp' => \true, 'type' => ''],
'lien_dev' => ['svp' => \false, 'type' => ''],
'etat' => ['svp' => \true, 'type' => ''],
'etatnum' => ['svp' => \true, 'type' => ''],
'dependances' => ['svp' => \false, 'type' => 'serial'],
'procure' => ['svp' => \false, 'type' => 'serial'],
'date_crea' => ['svp' => \false, 'type' => ''],
'date_modif' => ['svp' => \false, 'type' => ''],
'nom_archive' => ['svp' => \true, 'type' => ''],
'nbo_archive' => ['svp' => \true, 'type' => ''],
'maj_archive' => ['svp' => \true, 'type' => ''],
'src_archive' => ['svp' => \true, 'type' => ''],
'traductions' => ['svp' => \false, 'type' => 'serial'],
]]
Functions
plugin_normaliser_champs()
Transforme, pour un objet plugin ou paquet, les champs sérialisés, multi et liste (chaine d'éléments séparés par une virgule) en tableau et supprime des champs de type version les 0 à gauche des numéros.
plugin_normaliser_champs(string $type_objet, array<string|int, mixed> $objet) : array<string|int, mixed>
Parameters
- $type_objet : string
-
Type d'objet à normaliser, soit
plugin
oupaquet
. - $objet : array<string|int, mixed>
-
Tableau des champs de l'objet
plugin
oupaquet
à normaliser.
Tags
Return values
array<string|int, mixed> —Tableau des champs de l'objet plugin
ou paquet
normalisés.
plugin_lister_champs()
Renvoie la liste des champs à renvoyer suite à une requête sur les collections paquets ou plugins.
plugin_lister_champs(string $type_objet[, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $type_objet : string
-
Type d'objet à normaliser, soit
plugin
oupaquet
. - $options : null|array<string|int, mixed> = []
-
Permet d'indiquer si la demande est pour SVP (gestion de l'installation des plugins) et le format de la liste souhaitée:
- pour_svp : true/false (par défaut true)
- avec_type : true, valeur par défaut, renvoie un tableau [champ] = type, false renvoie juste la liste des champs.
Return values
array<string|int, mixed> —Liste des champs de l'objet plugin
ou paquet
utiles.