Documentation du code de SPIP et de ses plugins

Boussole

boussole_administrations.php

Ce fichier contient les fonctions de création, de mise à jour et de suppression du schéma de données propres au plugin (tables et configuration).

Table of Contents

Functions

boussole_upgrade()  : void
Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.
boussole_vider_tables()  : void
Suppression de l'ensemble du schéma de données propre au plugin, c'est-à-dire les tables et les variables de configuration.
maj02_boussole()  : void
Migration du schéma 0.1 au 0.2.
maj03_boussole()  : void
Migration du schéma 0.2 au 0.3.
maj04_boussole()  : void
Migration du schéma 0.3 au 0.4.
maj05_boussole()  : void
Migration du schéma 0.4 au 0.5.

Functions

boussole_upgrade()

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

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

Le schéma comprend des tables et des variables de configuration.

Parameters
$nom_meta_base_version : string

Nom de la meta dans laquelle sera rangée la version du schéma

$version_cible : string

Version du schéma de données en fin d'upgrade

Tags
see
boussole_declarer_tables_principales()
see
boussole_declarer_tables_interfaces()

boussole_vider_tables()

Suppression de l'ensemble du schéma de données propre au plugin, c'est-à-dire les tables et les variables de configuration.

boussole_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string

Nom de la meta dans laquelle sera rangée la version du schéma

maj02_boussole()

Migration du schéma 0.1 au 0.2.

maj02_boussole() : void

Ajout de la table spip_boussoles_extras et suppression des boussoles autres que la boussole "spip" car il n'est pas possible de les mettre à jour, leur serveur n'étant pas connu.

maj03_boussole()

Migration du schéma 0.2 au 0.3.

maj03_boussole(array<string|int, mixed> $defaut_config) : void

Les globales $serveur_boussoles_disponibles et $client_serveurs_disponibles sont transférées dans des variables de configuration

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

Configuration par défaut supplémentaire ajoutée pour ce schéma. Si le site a déjà personnalisé les globales la configuration par défaut sera écrasée par celle des globales migrées.

maj04_boussole()

Migration du schéma 0.3 au 0.4.

maj04_boussole(array<string|int, mixed> $defaut_config) : void

La constante _BOUSSOLE_ALIAS_SERVEUR est transformée en deux variables de configuration, l'une pour l'activité de la fonction serveur et l'autre pour le nom du serveur.

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

Configuration par défaut supplémentaire ajoutée pour ce schéma. Si le site est déjà un serveur, la configuration par défaut sera écrasée par celle de la constante migrée.

maj05_boussole()

Migration du schéma 0.4 au 0.5.

maj05_boussole(string $url_serveur_spip) : void

Le serveur de boussoles spip passe en https.

Parameters
$url_serveur_spip : string

URL du serveur spip


        
On this page

Search results