rainette_administrations.php
Fichier gérant l'installation et désinstallation du plugin Rainette.
Table of Contents
Functions
- rainette_upgrade() : void
- Fonction d'installation de Rainette limitée à la création de la configuration en meta.
- rainette_vider_tables() : void
- Fonction de désinstallation du plugin Rainette (suppression des metas).
- rainette_configurer() : void
- Enregistre en meta la configuration générale de Rainette ainsi que celle de tous les services disponibles.
- configuration_technique_charger() : array<string|int, mixed>
- Renvoie la configuration générale de Rainette extraite de son fichier YAML.
- configuration_service_charger() : array<string|int, mixed>
- Normalise et renvoie la configuration d'un service donné extraite de son fichier YAML.
- configuration_service_initialiser() : array<string|int, mixed>
- Initialise la configuration d'un service donné.
Functions
rainette_upgrade()
Fonction d'installation de Rainette limitée à la création de la configuration en meta.
rainette_upgrade(string $nom_meta_base_version, string $version_cible) : void
Parameters
- $nom_meta_base_version : string
-
Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
- $version_cible : string
-
Version du schéma de données dans ce plugin (déclaré dans paquet.xml)
rainette_vider_tables()
Fonction de désinstallation du plugin Rainette (suppression des metas).
rainette_vider_tables(string $nom_meta_base_version) : void
Parameters
- $nom_meta_base_version : string
-
Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
rainette_configurer()
Enregistre en meta la configuration générale de Rainette ainsi que celle de tous les services disponibles.
rainette_configurer() : void
configuration_technique_charger()
Renvoie la configuration générale de Rainette extraite de son fichier YAML.
configuration_technique_charger([null|string $fichier_config = '' ]) : array<string|int, mixed>
Parameters
- $fichier_config : null|string = ''
-
Fichier de configuration YAML de Rainette pour optimiser le traitement. Si vide on le cherche dans le path.
Return values
array<string|int, mixed> —Tableau de configuration de Rainette.
configuration_service_charger()
Normalise et renvoie la configuration d'un service donné extraite de son fichier YAML.
configuration_service_charger(string $service[, null|string $fichier_config = '' ]) : array<string|int, mixed>
Parameters
- $service : string
-
Le nom abrégé du service
- $fichier_config : null|string = ''
-
Fichier de configuration YAML de Rainette pour optimiser le traitement. Si vide on le cherche dans le path.
Return values
array<string|int, mixed>configuration_service_initialiser()
Initialise la configuration d'un service donné.
configuration_service_initialiser(string $service) : array<string|int, mixed>
Parameters
- $service : string
-
Le nom abrégé du service