Free Press

• NAME
• SYNOPSIS
• DESCRIPTION
• Functie read_config_file
  • Syntax
  • Arguments
  • Waarde
  • Beschrijving
• NOTEN
  • Functie wordt niet standaard geëxporteerd
  • Verwijderd van ConfigFile naar Config::File
• AUTHOR
• VERSION

Config::File – Parseer een eenvoudig configuratiebestand

use Config::File;

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

OMSCHRIJVING

read_config_file parseert een eenvoudig configuratiebestand en slaat de waarden op in een anonieme hash-referentie. De syntaxis van het configuratiebestand is als volgt:

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

Opties kunnen worden geclusterd bij het maken van groepen:

Dan kunnen waarden worden opgehaald met deze syntaxis:

 $hash_config->{CLUSTER_ONE}{data};

Er kunnen zo veel subopties in een cluster zitten als nodig is.

 BIG_CLUSTER = data

wordt opgehaald door: $hash_config->{BIG_CLUSTER}{part1}{part2}{part3};

Er zijn een paar beperkingen wat betreft de namen van de sleutels. Allereerst moeten alle tekens alfabetisch, numeriek, onderstrepingstekens of koppeltekens zijn, waarbij vierkante haken zijn toegestaan voor de clustering. Dat wil zeggen, de sleutels moeten voldoen aan /^+$/

Dit betekent ook dat er geen spaties zijn toegestaan in het sleutelgedeelte van de regel.

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

Functie read_config_file

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

Argumenten

$file is het configuratie bestand.

Return waarde

Deze functie retourneert een hash verwijzing. Elke sleutel van de hash is een waarde die in het configuratiebestand is gedefinieerd.

Beschrijving

read_config_file ontleedt een configuratiebestand en zet enkele waarden in een hash-referentie.

Functie standaard niet geëxporteerd

In versies tot en met 1.0 werd de functie read_config_file geëxporteerd naar de namespace van het aanroepende programma – Vanaf versie 1.1 wordt standaard niets geëxporteerd. Je kan read_config_file volledig kwalificeren of expliciet importeren in je namespace:

Volledig kwalificeren van read_config_file

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

Expliciet importeren van read_config_file

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

Weggegaan van ConfigFile naar Config::File

Om deze module in de CPAN op te nemen, besloot ik vanaf versie 1.4 om weg te gaan van de zeer onstandaard naam ConfigFile en de module te hernoemen naar Config::File. Een kleine omleidingsmodule is geplaatst, zodat huidige code die deze module gebruikt niet breekt, maar het gebruik van de ConfigFile namespace is deprecated (en zal dus een waarschuwing geven). Gelieve uw code te updaten!

AUTHOR

De ontwikkeling werd gestart door Sebastien J. Gross <[email protected]>. Onderhouden door Gunnar Wolf <[email protected]> tot 2018 toen de Universiteit van Stockholm (Johan Wassberg en Mikael Nordin) het onderhoud overnam.

Alle rechten voorbehouden. Dit programma is vrije software; u kunt het opnieuw distribueren en/of wijzigen onder de voorwaarden van de GPL.

VERSIE

Versie 1.54 Copyright (c) 2002 Sebastien J. Gross. Alle rechten voorbehouden. Copyright (c) 2003-2018 Gunnar Wolf. Alle rechten voorbehouden. Copyright (c) 2018- Universiteit van Stockholm. Alle rechten voorbehouden. Dit programma is vrije software; u kunt het opnieuw distribueren en/of wijzigen onder de voorwaarden van de GPL v2 (of later, naar uw keuze).

 cpanm Config::File 

 perl -MCPAN -e shell install Config::File