array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'es', ), 'this' => array ( 0 => 'yaconf.get.php', 1 => 'Yaconf::get', 2 => 'Recupera un valor de configuración por su nombre', ), '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' => 'es', '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 — Recupera un valor de configuración por su nombre

Descripción

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

Recupera el valor de configuración almacenado bajo name. Los nombres emplean la notación de punto para recorrer las claves anidadas: "app" hace referencia al archivo app.ini analizado por completo, "app.name" a una clave dentro de él y, desde Yaconf 1.2.0, "users.database.master" a una clave del archivo database.ini situado en el subdirectorio users/. La notación de punto admite hasta 64 niveles de anidamiento.

Parámetros

name

El nombre de configuración a buscar, empleando la notación de punto para recorrer las claves anidadas, por ejemplo "app.name", "app.features.1" o, desde Yaconf 1.2.0, "users.database.master" para los archivos en subdirectorios.

default

El valor a devolver cuando no se encuentra name. Si se omite, se devuelve null.

Valores devueltos

El valor de configuración almacenado, un string o un array, cuando name existe; en caso contrario, default (o null si no se indicó ningún valor por defecto).

Ejemplos

Los ejemplos siguientes suponen los dos archivos mostrados a continuación, situados en el directorio configurado con yaconf.directory. 

; app.ini
name="shop"                     ; valor escalar
debug=0                         ; número
features[]="checkout"           ; entradas de array, ambas notaciones
features.1="wishlist"
; users/database.ini, en un subdirectorio (Yaconf 1.2.0+)
master="192.168.0.10"
replica="192.168.0.20"

Ejemplo #1 Ejemplo de Yaconf::get()

<?php
// recupera un archivo analizado completo como un array
var_dump(Yaconf::get("app"));

// la notación de punto recorre las claves anidadas
var_dump(Yaconf::get("app.name"));           // string(4) "shop"
var_dump(Yaconf::get("app.features.1"));     // string(8) "wishlist"

// desde 1.2.0: los archivos en subdirectorios quedan bajo el espacio de
// nombres del nombre del directorio
var_dump(Yaconf::get("users.database.master")); // string(12) "192.168.0.10"

// cuando la clave no existe, se devuelve el valor por defecto
var_dump(Yaconf::get("app.missing"));             // NULL
var_dump(Yaconf::get("app.missing", "fallback")); // string(8) "fallback"
?>

Véase también