- NAME
- SYNOPSIS
- DESCRIÇÃO
- Função read_config_file
- Syntax
- Argumentos
- Valor de retorno
- Descrição
- NOTAS
- Função não exportada por padrão
- Migrado de ConfigFile para Config::Ficheiro
>
>
- AUTOR
- VERSÃO
Config::File – Analisar um ficheiro de configuração simples
usar Config::File;
my $config_hash = Config::File::read_config_file($configuration_file);
DESCRIPTION
read_config_file
analisa um simples arquivo de configuração e armazena seus valores em uma referência hash anônima. A sintaxe do arquivo de configuração é a seguinte:
# This is a comment VALUE_ONE = foo VALUE_TWO = $VALUE_ONE/bar VALUE_THREE = The value contains a \# (hash). # This is a comment.
Options can be clustered when creating groups:
Then values can be get getched using this syntax:
$hash_config->{CLUSTER_ONE}{data};
There can be as many suboptions in a cluster as needed.
BIG_CLUSTER = data
is fetched by: $hash_config->{BIG_CLUSTER}{part1}{part2}{part3};
Existem algumas restrições como para os nomes das chaves. Primeiro de tudo, todos os caracteres devem ser alfabéticos, numéricos, sublinhados ou hífens, com parênteses rectos permitidos para o agrupamento. Isto é, as chaves devem estar de acordo com /^+$/
Isto significa também que nenhum espaço é permitido na parte chave da linha.
CLUSTER_ONE = data cluster one # Right CLUSTER_ONE = data cluster one # Wrong
Função read_config_file
Config::File::read_config_file($file);
Argumentos
$file
é o arquivo de configuração.
Valor de retorno
Esta função retorna uma referência de hash. Cada chave do hash é um valor definido no arquivo de configuração.
Description
read_config_file
analisa um arquivo de configuração e configura alguns valores em uma referência de hash.
Função não exportada por padrão
Nas versões até 1.0, a função read_config_file foi exportada para o namespace do programa chamador – A partir da versão 1.1, nada é exportado por padrão. Você pode qualificar totalmente read_config_file ou importá-lo explicitamente para o seu namespace:
Completamente qualificado read_config_file
use Config::File; my $config_hash = Config::File::read_config_file($configuration_file);
Importar explicitamente read_config_file
use Config::File qw(read_config_file); my $config_hash = read_config_file($configuration_file);
Migrado do ConfigFile para o Config::File
As da versão 1.4, a fim de incluir este módulo no CPAN, eu decidi me afastar do nome altamente fora do padrão do ConfigFile e renomear o módulo para Config::File. Um pequeno módulo de redirecionamento é colocado no lugar, assim o código atual usando este módulo não quebra, mas o uso do espaço de nomes do ConfigFile é depreciado (e assim emitirá um aviso). Por favor atualize seu código!
AUTOR
Development was started by Sebastien J. Gross <[email protected]>. Mantido por Gunnar Wolf <[email protected]> até 2018 quando a Universidade de Estocolmo (Johan Wassberg e Mikael Nordin) assumiu a manutenção.
Todos os direitos reservados. Este programa é software livre; você pode redistribuí-lo e/ou modificá-lo nos termos da GPL.
VERSÃO
Versão 1.54 Copyright (c) 2002 Sebastien J. Gross. Todos os direitos reservados. Copyright (c) 2003-2018 Gunnar Wolf. Todos os direitos reservados. Copyright (c) 2018- Universidade de Estocolmo. Todos os direitos reservados. Este programa é software livre; você pode redistribuí-lo e/ou modificá-lo sob os termos da GPL v2 (ou mais tarde, à sua escolha).
Instruções de instalação do módulo
Para instalar Config::File, copie e cole o comando apropriado no seu terminal.
cpanm
cpanm Config::File
CPAN shell
perl -MCPAN -e shell install Config::File
Para mais informações sobre a instalação do módulo, visite o guia detalhado de instalação do módulo CPAN.