array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'fr', ), 'this' => array ( 0 => 'yaconf.get.php', 1 => 'Yaconf::get', 2 => 'Récupère une valeur de configuration par son nom', ), 'up' => array ( 0 => 'class.yaconf.php', 1 => 'Yaconf', ), 'prev' => array ( 0 => 'yaconf.debug-info.php', 1 => 'Yaconf::__debug_info', ), 'next' => array ( 0 => 'yaconf.has.php', 1 => 'Yaconf::has', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'fr', 'path' => 'reference/yaconf/yaconf/get.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

Yaconf::get

(PECL yaconf >= 1.0.0)

Yaconf::get — Récupère une valeur de configuration par son nom

Description

public static function Yaconf::get(string $name, mixed $default = null): mixed

Récupère la valeur de configuration stockée sous name. Les noms utilisent la notation pointée pour traverser les clés imbriquées : "app" adresse le fichier app.ini entier, "app.name" une clé à l'intérieur, et depuis Yaconf 1.2.0 "users.database.master" une clé dans le fichier database.ini placé dans le sous-répertoire users/. La notation pointée supporte jusqu'à 64 niveaux d'imbrication.

Liste de paramètres

name

Le nom de configuration à rechercher, en utilisant la notation pointée pour traverser les clés imbriquées, par exemple "app.name", "app.features.1" ou, depuis Yaconf 1.2.0, "users.database.master" pour les fichiers dans des sous-répertoires.

default

La valeur à retourner lorsque name n'est pas trouvé. Lorsqu'omis, null est retourné.

Valeurs de retour

La valeur de configuration stockée, une chaîne de caractères ou un tableau, lorsque name existe ; sinon la valeur default (ou null lorsqu'aucun défaut n'a été fourni).

Exemples

Les exemples ci-dessous supposent les deux fichiers suivants placés dans le répertoire configuré avec yaconf.directory. 

; app.ini
name="shop"                     ; valeur scalaire
debug=0                         ; nombre
features[]="checkout"           ; entrées de tableau, les deux notations
features.1="wishlist"
; users/database.ini, dans un sous-répertoire (Yaconf 1.2.0+)
master="192.168.0.10"
replica="192.168.0.20"

Exemple #1 Exemple avec Yaconf::get()

<?php
// récupérer un fichier analysé entier sous forme de tableau
var_dump(Yaconf::get("app"));

// la notation pointée traverse les clés imbriquées
var_dump(Yaconf::get("app.name"));           // string(4) "shop"
var_dump(Yaconf::get("app.features.1"));     // string(8) "wishlist"

// depuis 1.2.0 : les fichiers dans les sous-répertoires sont nommés
// par le nom du répertoire
var_dump(Yaconf::get("users.database.master")); // string(12) "192.168.0.10"

// lorsque la clé est absente, la valeur par défaut est retournée
var_dump(Yaconf::get("app.missing"));             // NULL
var_dump(Yaconf::get("app.missing", "fallback")); // string(8) "fallback"
?>

Voir aussi