Config
Table of Contents
Functions
- inc_config_dist() : void
- Appliquer les valeurs par défaut pour les options non initialisées (pour les langues c'est fait)
- expliquer_config() : array<string|int, mixed>
- Expliquer une clé de configuration
- lire_config() : mixed
- Lecture de la configuration
- lire_config_metapack_dist() : mixed
- metapack est inclue dans lire_config, mais on traite le cas ou il est explicite metapack:: dans le $cfg de lire_config.
- ecrire_config() : bool
- Ecrire une configuration
- ecrire_config_metapack_dist() : bool
- metapack est inclue dans ecrire_config, mais on traite le cas ou il est explicite metapack:: dans le $cfg de ecrire_config.
- effacer_config() : bool
- Effacer une configuration : revient a ecrire une valeur null
- liste_metas() : array<string|int, mixed>
- Définir les `meta` de configuration
- actualise_metas() : void
- Mets les `meta` à des valeurs conventionnelles quand elles sont vides et recalcule les langues
- appliquer_modifs_config() : void
- Appliquer les modifications apportées aux `metas`
- appliquer_adresse_site() : string
- Mettre à jour l'adresse du site à partir d'une valeur saisie (ou auto détection si vide)
Functions
inc_config_dist()
Appliquer les valeurs par défaut pour les options non initialisées (pour les langues c'est fait)
inc_config_dist() : void
expliquer_config()
Expliquer une clé de configuration
expliquer_config(string $cfg) : array<string|int, mixed>
Analyser la clé de configuration pour déterminer
- la table (ex: spip_metas),
- le casier, la clé principale (ex: dada)
- et le sous-casier éventuel, chemin dans la clé principale (ex: truc/muche)
Parameters
- $cfg : string
-
Clé de configuration, tel que 'dada/truc/muche'
Return values
array<string|int, mixed> —Liste (table, casier, sous_casier)
lire_config()
Lecture de la configuration
lire_config([string $cfg = '' ][, mixed $def = null ][, bool $unserialize = true ]) : mixed
lire_config() permet de recuperer une config depuis le php
memes arguments que la balise (forcement)
$cfg: la config, lire_config('montruc') est un tableau
lire_config('/table/champ') lit le valeur de champ dans la table des meta 'spip_table'
lire_config('montruc/sub') est l'element "sub" de cette config equivalent a lire_config('/meta/montruc/sub')
lire_config('methode::montruc/sub') delegue la lecture a methode_lire_config_dist via un charger_fonction permet de brancher CFG ou autre outil externe qui etend les methodes de stockage de config
$unserialize est mis par l'histoire
Parameters
- $cfg : string = ''
-
Clé de configuration
- $def : mixed = null
-
Valeur par défaut
- $unserialize : bool = true
-
N'affecte que le dépôt 'meta' : True pour désérialiser automatiquement la valeur
Return values
mixed —Contenu de la configuration obtenue
lire_config_metapack_dist()
metapack est inclue dans lire_config, mais on traite le cas ou il est explicite metapack:: dans le $cfg de lire_config.
lire_config_metapack_dist([string $cfg = '' ][, mixed $def = null ][, bool $unserialize = true ]) : mixed
On renvoie simplement sur lire_config
Parameters
- $cfg : string = ''
- $def : mixed = null
- $unserialize : bool = true
ecrire_config()
Ecrire une configuration
ecrire_config(string $cfg, mixed $store) : bool
Parameters
- $cfg : string
- $store : mixed
Return values
boolecrire_config_metapack_dist()
metapack est inclue dans ecrire_config, mais on traite le cas ou il est explicite metapack:: dans le $cfg de ecrire_config.
ecrire_config_metapack_dist(string $cfg, mixed $store) : bool
On renvoie simplement sur ecrire_config
Parameters
- $cfg : string
- $store : mixed
Return values
booleffacer_config()
Effacer une configuration : revient a ecrire une valeur null
effacer_config(string $cfg) : bool
Parameters
- $cfg : string
Return values
boolliste_metas()
Définir les `meta` de configuration
liste_metas() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Couples nom de la meta => valeur par défaut
actualise_metas()
Mets les `meta` à des valeurs conventionnelles quand elles sont vides et recalcule les langues
actualise_metas(array<string|int, mixed> $liste_meta) : void
Parameters
- $liste_meta : array<string|int, mixed>
appliquer_modifs_config()
Appliquer les modifications apportées aux `metas`
appliquer_modifs_config([bool $purger_skel = false ]) : void
Si $purger_skel est à true, on purge le répertoire de cache des squelettes
Parameters
- $purger_skel : bool = false
Tags
appliquer_adresse_site()
Mettre à jour l'adresse du site à partir d'une valeur saisie (ou auto détection si vide)
appliquer_adresse_site(string $adresse_site) : string
Parameters
- $adresse_site : string