Documentation du code de SPIP et de ses plugins

Albums

Administrations

Table of Contents

Functions

albums_upgrade()  : void
Fonction d'installation et de mise à jour du plugin.
albums_vider_tables()  : void
Fonction de désinstallation du plugin.
albums_verifier_config_documents()  : array<string|int, mixed>
Vérifie que les albums figurent dans la config des objets des documents.
albums_ecrire_config_defaut()  : bool
Écrit les valeurs par défaut de la configuration des albums

Functions

albums_upgrade()

Fonction d'installation et de mise à jour du plugin.

albums_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)

albums_vider_tables()

Fonction de désinstallation du plugin.

albums_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

albums_verifier_config_documents()

Vérifie que les albums figurent dans la config des objets des documents.

albums_verifier_config_documents([array<string|int, mixed>|null $config = null ][, bool $ecrire = true ]) : array<string|int, mixed>
Parameters
$config : array<string|int, mixed>|null = null

valeurs sous forme de tableau (à défaut on prend la config actuelle)

$ecrire : bool = true

true pour enregistrer la nouvelle config (défaut)

Return values
array<string|int, mixed>

Valeurs complétées

albums_ecrire_config_defaut()

Écrit les valeurs par défaut de la configuration des albums

albums_ecrire_config_defaut() : bool
Return values
bool

        
On this page

Search results