Free Press

• NAME
• SYNOPSIS
• DESCRIPTION
• Function read_config_file
  • Syntax
  • Arguments
  • Valor de retorno
  • Descripción
• NOTA
  • Función no exportada por defecto
  • Migrada de ConfigFile a Config::File
• AUTHOR
• VERSION

Config::File – Parse a un archivo de configuración simple

use Config::File;

my $config_hash = Config::File::read_config_file($configuration_file);

DESCRIPTION

read_config_file analiza un archivo de configuración simple y almacena sus valores en una referencia hash anónima. La sintaxis del archivo de configuración es la siguiente:

 # This is a comment VALUE_ONE = foo VALUE_TWO = $VALUE_ONE/bar VALUE_THREE = The value contains a \# (hash). # This is a comment.

Las opciones pueden agruparse al crear grupos:

Entonces los valores pueden obtenerse utilizando esta sintaxis:

 $hash_config->{CLUSTER_ONE}{data};

Puede haber tantas subopciones en un grupo como sea necesario.

 BIG_CLUSTER = data

Se obtiene mediante: $hash_config->{BIG_CLUSTER}{parte1}{parte2}{parte3};

Hay un par de restricciones en cuanto a los nombres de las claves. En primer lugar, todos los caracteres deben ser alfabéticos, numéricos, guiones bajos o guiones, con corchetes permitidos para la agrupación. Es decir, las claves deben ajustarse a /^+$/

Esto significa también que no se permite ningún espacio en la parte de la clave de la línea.

 CLUSTER_ONE = data cluster one # Right CLUSTER_ONE = data cluster one # Wrong

Función read_config_file

 Config::File::read_config_file($file);

Argumentos

$filees el fichero de configuración.

Valor de retorno

Esta función devuelve una referencia hash. Cada clave del hash es un valor definido en el fichero de configuración.

Descripción

read_config_filePercibe un fichero de configuración y establece algunos valores en una referencia hash.

Función no exportada por defecto

En las versiones hasta la 1.0, la función read_config_file se exportaba al espacio de nombres del programa llamante – A partir de la versión 1.1, no se exporta nada por defecto. Puede calificar completamente read_config_file o importarlo explícitamente a su espacio de nombres:

Calificando completamente read_config_file

 use Config::File; my $config_hash = Config::File::read_config_file($configuration_file);

Importando explícitamente read_config_file

 use Config::File qw(read_config_file); my $config_hash = read_config_file($configuration_file);

Se ha migrado de ConfigFile a Config::File

A partir de la versión 1.4, para poder incluir este módulo en el CPAN, decidí abandonar el nombre tan poco estándar de ConfigFile y renombrar el módulo a Config::File. Un pequeño módulo de redireccionamiento se pone en su lugar, por lo que el código actual que utiliza este módulo no se rompe, pero el uso del espacio de nombres ConfigFile es obsoleto (y por lo tanto emitirá una advertencia). Por favor, actualice su código.

AUTOR

El desarrollo fue iniciado por Sebastien J. Gross <[email protected]>. Mantenido por Gunnar Wolf <[email protected]> hasta 2018 cuando la Universidad de Estocolmo (Johan Wassberg y Mikael Nordin) se hizo cargo del mantenimiento.

Todos los derechos reservados. Este programa es software libre; puede redistribuirlo y/o modificarlo bajo los términos de la GPL.

VERSION

Versión 1.54 Copyright (c) 2002 Sebastien J. Gross. Todos los derechos reservados. Copyright (c) 2003-2018 Gunnar Wolf. Todos los derechos reservados. Copyright (c) 2018- Universidad de Estocolmo. Todos los derechos reservados. Este programa es software libre; puedes redistribuirlo y/o modificarlo bajo los términos de la GPL v2 (o posterior, a tu elección).

 cpanm Config::File 

 perl -MCPAN -e shell install Config::File