- NAME
- SYNOPSIS
- BESKRIVNING
- Funktion read_config_file
- Syntax
- Argument
- Returvärde
- Beskrivning
- NOTER
- Funktionen exporteras inte som standard
- Migrerad från ConfigFile till Config::File
- AUTHOR
- VERSION
Config::File – analyserar en enkel konfigurationsfil
use Config::File;
my $config_hash = Config::File::read_config_file($configuration_file);
DESCRIPTION
read_config_file
analyserar en enkel konfigurationsfil och lagrar dess värden i en anonym hashreferens. Syntaxen för konfigurationsfilen är följande:
# This is a comment VALUE_ONE = foo VALUE_TWO = $VALUE_ONE/bar VALUE_THREE = The value contains a \# (hash). # This is a comment.
Optioner kan klubbas när man skapar grupper:
Därefter kan värden hämtas med hjälp av denna syntax:
$hash_config->{CLUSTER_ONE}{data};
Det kan finnas så många underalternativ i ett kluster som det behövs.
BIG_CLUSTER = data
hämtas av: $hash_config->{BIG_CLUSTER}{part1}{part2}{part3};
Det finns ett par begränsningar när det gäller namnen på nycklarna. För det första ska alla tecken vara alfabetiska, numeriska, understrykningar eller bindestreck, och hakparenteser är tillåtna för klusterbildningen. Det vill säga, nycklarna ska överensstämma med /^+$/
Detta innebär också att inget mellanslag är tillåtet i nyckeldelen av raden.
CLUSTER_ONE = data cluster one # Right CLUSTER_ONE = data cluster one # Wrong
Funktion read_config_file
Config::File::read_config_file($file);
Argument
$file
är konfigurationsfilen.
Returvärde
Denna funktion returnerar en hashreferens. Varje nyckel i hashreferensen är ett värde som definieras i konfigurationsfilen.
Beskrivning
read_config_file
analyserar en konfigurationsfil och ställer in vissa värden i en hashreferens.
Funktionen exporteras inte som standard
I versioner upp till 1.0 exporterades funktionen read_config_file till det anropande programmets namnområde – Från och med version 1.1 exporteras ingenting som standard. Du kan antingen fullständigt kvalificera read_config_file eller explicit importera den till ditt namespace:
Fullständigt kvalificera read_config_file
use Config::File; my $config_hash = Config::File::read_config_file($configuration_file);
Explicit importera read_config_file
use Config::File qw(read_config_file); my $config_hash = read_config_file($configuration_file);
Migrerat bort från ConfigFile till Config::File
Från och med version 1.4, för att kunna inkludera den här modulen i CPAN, bestämde jag mig för att flytta bort från det mycket ostandardiserade namnet ConfigFile och döpa om modulen till Config::File. En liten omdirigeringsmodul har införts, så nuvarande kod som använder den här modulen går inte sönder, men användningen av namnområdet ConfigFile är föråldrad (och kommer därför att utfärda en varning). Vänligen uppdatera din kod!
AUTHOR
Utvecklingen startades av Sebastien J. Gross <[email protected]>. Underhålls av Gunnar Wolf <[email protected]> fram till 2018 då Stockholms universitet (Johan Wassberg och Mikael Nordin) tog över underhållet.
Alla rättigheter förbehållna. Detta program är fri programvara; du kan distribuera det vidare och/eller ändra det enligt villkoren i GPL.
VERSION
Version 1.54 Copyright (c) 2002 Sebastien J. Gross. Alla rättigheter förbehållna. Copyright (c) 2003-2018 Gunnar Wolf. Alla rättigheter förbehållna. Copyright (c) 2018- Stockholms universitet. Alla rättigheter förbehållna. Det här programmet är fri programvara; du kan distribuera det vidare och/eller modifiera det enligt villkoren i GPL v2 (eller senare, efter eget val).
Instruktioner för installation av moduler
För att installera Config::File kopierar och klistrar du in det lämpliga kommandot i din terminal.
cpanm
cpanm Config::File
CPAN shell
perl -MCPAN -e shell install Config::File
För mer information om modulinstallation, besök den detaljerade CPAN-modulinstallationsguiden.