parse_ini_file

(PHP 4, PHP 5)

parse_ini_file — Procesar un archivo de configuración

Descripción

array parse_ini_file ( string $nombre_archivo [, bool $procesar_secciones ] )

parse_ini_file() lee el contenido del archivo ini especificado en nombre_archivo , y devuelve los parámetros que incluye en una matriz asociativa.

La estructura del archivo ini es la misma que la de php.ini.

Lista de parámetros

nombre_archivo: El nombre del archivo ini para procesar.
procesar_secciones: Al definir el último parámetro procesar_secciones como TRUE, usted recibe una matriz multidimensional, con los nombres de secciones y parámetros incluidos. El valor predeterminado para procesar_secciones es FALSE

Valores retornados

Los parámetros son devueltos en un array asociativo.

Registro de cambios

Versión	Descripción
5.2.4	Las claves y nombres de sección que consisten de números son evaluados ahora como valores integer de PHP, de modo que los números que comienzan por 0 son evaluados como octales y los números que comienzan por 0x son evaluados como hexadecimales.
5.0.0	Los valores entre comillas dobles pueden contener saltos de línea.
4.2.1	Esta función se ve afectada ahora por safe mode y open_basedir.

Ejemplos

Example#1 Contenidos de ejemplo.ini

; Este es un archivo de configuración de ejemplo
; Los comentarios comienzan con ';', como en php.ini

[primera_seccion]
uno = 1
cinco = 5
animal = PAJARO

[segunda_seccion]
ruta = "/usr/local/bin"
URL = "https://www.example.com/~nombreusuario"

Example#2 Ejemplo de parse_ini_file()

También pueden procesarse Constantes en el archivo ini, de tal modo que si define una constante como un valor ini antes de ejecutar parse_ini_file(), ésta será integrada en los resultados. Solo son evaluados los valores ini. Por ejemplo:


<?php

define('PAJARO', 'Ave Dodo');

// Procesar sin secciones
$matriz_ini = parse_ini_file("ejemplo.ini");
print_r($matriz_ini);

// Procesar con secciones
$matriz_ini = parse_ini_file("ejemplo.ini", true);
print_r($matriz_ini);

?>

El resultado del ejemplo seria algo similar a:

Array
(
    [uno] => 1
    [cinco] => 5
    [animal] => Ave Dodo
    [ruta] => /usr/local/bin
    [URL] => https://www.example.com/~nombreusuario
)
Array
(
    [primera_seccion] => Array
        (
            [uno] => 1
            [cinco] => 5
            [animal] = Ave Dodo
        )

    [segunda_seccion] => Array
        (
            [ruta] => /usr/local/bin
            [URL] => https://www.example.com/~nombreusuario
        )

)

Notes

Note: Esta función no tiene relación alguna con el archivo php.ini. Éste ya ha sido procesado al momento de ejecutar su script. Esta función puede ser usada para leer los archivos de configuración de su propia aplicación.

Note: Si un valor en el archivo ini contiene caracteres no-alfanuméricos, éste necesita ser rodeado por comillas dobles (").

Note: Existen palabras reservadas que no deben ser usadas como claves en archivos ini. Entre estas se encuentran: null, yes, no, true, y false. Los valores null, no y false resultan en "", yes y true resultan en "1". Los caracteres {}|&~![()" no deben ser usados en ninguna parte de la clave, y tienen un significado especial en el valor.