- NAME
- SYNOPSIS
- OPIS
- Funkcja read_config_file
- Syntax
- Argumenty
- Wartość zwracana
- Opis
.
- UWAGI
- Funkcja domyślnie nie eksportowana
- Migrowana z ConfigFile do Config::File
- AUTHOR
- VERSION
Config::File – Parsowanie prostego pliku konfiguracyjnego
use Config::File;
my $config_hash = Config::File::read_config_file($configuration_file);
DESCRIPTION
read_config_file
parsuje prosty plik konfiguracyjny i przechowuje jego wartości w anonimowej referencji hash. Składnia pliku konfiguracyjnego jest następująca:
# This is a comment VALUE_ONE = foo VALUE_TWO = $VALUE_ONE/bar VALUE_THREE = The value contains a \# (hash). # This is a comment.
Opcje mogą być grupowane podczas tworzenia grup:
Wtedy wartości mogą być pobierane przy użyciu tej składni:
$hash_config->{CLUSTER_ONE}{data};
W klastrze może być tyle podopcji, ile potrzeba.
BIG_CLUSTER = data
jest pobierane przez: $hash_config->{BIG_CLUSTER}{part1}{part2}{part3};
Istnieje kilka ograniczeń co do nazw kluczy. Po pierwsze, wszystkie znaki powinny być alfabetyczne, numeryczne, podkreślniki lub myślniki, przy czym nawiasy kwadratowe są dozwolone w przypadku grupowania. Czyli klucze powinny być zgodne z /^+$/
To oznacza również, że w kluczowej części wiersza nie jest dozwolona spacja.
CLUSTER_ONE = data cluster one # Right CLUSTER_ONE = data cluster one # Wrong
Funkcja read_config_file
Config::File::read_config_file($file);
Argumenty
$file
jest plikiem konfiguracyjnym.
Wartość zwracana
Ta funkcja zwraca referencję hash. Każdy klucz hasza jest wartością zdefiniowaną w pliku konfiguracyjnym.
Opis
read_config_file
parsuje plik konfiguracyjny i umieszcza pewne wartości w referencji haszowej.
Funkcja nie jest domyślnie eksportowana
W wersjach do 1.0, funkcja read_config_file była eksportowana do przestrzeni nazw programu wywołującego – Począwszy od wersji 1.1, nic nie jest domyślnie eksportowane. Możesz albo w pełni zakwalifikować read_config_file, albo jawnie zaimportować ją do swojej przestrzeni nazw:
W pełni kwalifikując read_config_file
use Config::File; my $config_hash = Config::File::read_config_file($configuration_file);
Jawnie importując read_config_file
use Config::File qw(read_config_file); my $config_hash = read_config_file($configuration_file);
Migracja z ConfigFile do Config::File
Od wersji 1.4, w celu włączenia tego modułu do CPAN, zdecydowałem się odejść od wysoce niestandardowej nazwy ConfigFile i zmienić nazwę modułu na Config::File. Wprowadzono mały moduł przekierowujący, więc obecny kod korzystający z tego modułu nie zostanie uszkodzony, ale użycie przestrzeni nazw ConfigFile jest zdeprecjonowane (i w związku z tym pojawi się ostrzeżenie). Proszę zaktualizować swój kod!
AUTOR
Rozwój rozpoczął Sebastien J. Gross <[email protected]>. Utrzymywany przez Gunnara Wolfa <[email protected]>do roku 2018, kiedy to Uniwersytet Sztokholmski (Johan Wassberg i Mikael Nordin) przejął utrzymanie.
Wszystkie prawa zastrzeżone. Ten program jest wolnym oprogramowaniem; możesz go redystrybuować i/lub modyfikować na warunkach licencji GPL.
WERSJA
Wersja 1.54 Copyright (c) 2002 Sebastien J. Gross. Wszelkie prawa zastrzeżone. Copyright (c) 2003-2018 Gunnar Wolf. Wszelkie prawa zastrzeżone. Copyright (c) 2018- Stockholm University. All rights reserved. Ten program jest wolnym oprogramowaniem; możesz go redystrybuować i/lub modyfikować na warunkach licencji GPL v2 (lub nowszej, według własnego wyboru).
Instrukcje instalacji modułów
Aby zainstalować Config::File, skopiuj i wklej do terminala odpowiednie polecenie.
cpanm
cpanm Config::File
powłoka CPAN
perl -MCPAN -e shell install Config::File
Więcej informacji na temat instalacji modułów można znaleźć w szczegółowym przewodniku instalacji modułów CPAN.
.