Documentation du code de SPIP et de ses plugins

Palette Factory

Application

Table of Contents

Functions

action_recharger_palette_collections_dist()  : void
Cette action permet à l'utilisateur de recharger en base de données, de façon sécurisée, les collections de palettes standard à partir de leur fichier JSON.
ezpalette_declarer_tables_interfaces()  : array<string|int, mixed>
Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.
ezpalette_declarer_tables_objets_sql()  : array<string|int, mixed>
Déclaration des nouvelles tables de la base de données propres au plugin.
ezpalette_upgrade()  : void
Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.
ezpalette_vider_tables()  : void
Suppression de l'ensemble du schéma de données propre au plugin.
ezpalette_configurer()  : array<string|int, mixed>
Renvoie la configuration statique (non éditable) du plugin.

Functions

action_recharger_palette_collections_dist()

Cette action permet à l'utilisateur de recharger en base de données, de façon sécurisée, les collections de palettes standard à partir de leur fichier JSON.

action_recharger_palette_collections_dist() : void

Cette action est réservée aux utilisateurs pouvant manipuler les collections de Palette Factory. Elle ne nécessite aucun argument.

Tags
uses
palette_collection_charger()
throws
Exception

ezpalette_declarer_tables_interfaces()

Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.

ezpalette_declarer_tables_interfaces(array<string|int, mixed> $interface) : array<string|int, mixed>

Le plugin se contente de déclarer les alias des tables et quelques traitements.

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

Tableau global des informations tierces sur les tables de la base de données

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed>

Tableau fourni en entrée et mis à jour avec les nouvelles informations

ezpalette_declarer_tables_objets_sql()

Déclaration des nouvelles tables de la base de données propres au plugin.

ezpalette_declarer_tables_objets_sql(array<string|int, mixed> $tables) : array<string|int, mixed>

Le plugin déclare une nouvelle table :

  • spip_palettes, qui contient les éléments descriptifs des palettes de couleurs.
Parameters
$tables : array<string|int, mixed>

Tableau global décrivant la structure des tables de la base de données

Tags
pipeline

declarer_tables_objets_sql

Return values
array<string|int, mixed>

Tableau fourni en entrée et mis à jour avec les nouvelles déclarations

ezpalette_upgrade()

Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.

ezpalette_upgrade(string $nom_meta_base_version, string $version_cible) : void

Le plugin crée la table des palettes et charge la configuration des palettes standard.

Parameters
$nom_meta_base_version : string
$version_cible : string
Tags
throws
Exception

ezpalette_vider_tables()

Suppression de l'ensemble du schéma de données propre au plugin.

ezpalette_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string
Tags
throws
Exception

ezpalette_configurer()

Renvoie la configuration statique (non éditable) du plugin.

ezpalette_configurer() : array<string|int, mixed>
Return values
array<string|int, mixed>

Tableau de la configuration demandée.


        
On this page

Search results