view release on metacpan or  search on metacpan

lib/Config/Manager/Conf.pm  view on Meta::CPAN

Der dritte Wert enthaelt entweder den Wert der Konfigurationskonstanten
oder eine Fehlermeldung.

Der vierte Wert des Tupels gibt die Quelle an, aus dem die betreffende
Konfigurationskonstante stammt.

Der fuenfte Wert gibt die Zeilennummer in der Quelle an. Dieser kann
den Wert Null haben, falls es sich bei der Quelle nicht um eine Datei
gehandelt hat (sondern zum Beispiel um einen expliziten Aufruf der
Methode "set()").

Die Liste ist alphabetisch (ASCII) nach den Namen der Sections und
darin nach den Namen der Konfigurationskonstanten sortiert.

=item *

C<get_section(section)>

Ich gebe saemtliche Konfigurationswerte einer Section des gegebenen
Konfigurationsobjekts zurueck.

 Parameter: Name der Section (optional)
 Rueckgabe: Referenz auf Hash von Schluessel/Wert-Paaren

Falls keine Section angegeben ist, wird der Inhalt der
"DEFAULT"-Section zurueckgegeben.

Falls ein Wert in der Section nicht ermittelt werden kann
(z.B. weil er von anderen Werten abhaengt, deren Ermittlung
nicht moeglich ist), wird er nicht in den Ausgabe-Hash
kopiert.

=item *

C<get_files()>

Ich gebe die Liste der eingelesenen Konfigurationsdateien fuer
ein Konfigurationsobjekt zurueck, in der Reihenfolge in der sie
eingelesen wurden.

 Parameter: -
 Rueckgabe: Referenz auf Array von Dateinamen

=back

=head1 PRIVATE METHODEN

=over 4

=item *

C<_init()>

Ich initialisiere jedes neue Konfigurations-Objekt.

 Parameter: -
            (wie bei allen Objektmethoden;
             eine Objekt-Referenz "$self")
 Rueckgabe: Die Objekt-Referenz "$self"

Ich erledige die grundlegende Initialisierung eines jeden
Konfigurations-Objekts ("SPECIAL"-Variablen).

=item *

C<_add(file, [ line1, line2, ... ])>

Ich merke mir die angegebenen Zeilen

 Parameter: Dateiname
            Referenz auf Array mit Zeileninhalten
            ...
 Rueckgabe: <OK> || undef

Ich speichere die Konfigurationsdaten aus den angegebenen Zeilen; diese stammen
aus der angegebenen Datei.

=item *

C<_error(text, description, section, source, line)>

Ich setze meinen Fehlertext

 Parameter: Fehlertext
            Ergaenzender Fehlertext (optional)
            Section, in der der Fehler auftritt (optional)
            Datenquelle, in der der Fehler auftritt (optional)
            Zeilennummer, in der der Fehler auftritt (optional)
 Rueckgabe: undef

=item *

C<_set(source, line, section, key, value, override)>

Ich setze den Wert zu einem Schluessel

 Parameter: Datenquelle
            Zeilennummer in der Datenquelle
            Section
            Schluessel
            Wert
            Bestehenden Wert ueberschreiben?
 Rueckgabe: <OK> || undef

Ich setze den Wert zu einem Schluessel in einer Section.

Es ist nicht zulaessig, in der gleichen Datei in der gleichen Section einen
Schluessel zweimal zu definieren. In diesem Fall setze ich einen Fehler und
gebe undef zurueck.

Es ist unzulaessig, einen Wert in die Section ENV zu schreiben (diese ist fuer
Werte, die aus Umgebungsvariablen stammen). Weiterhin ist unzulaessig, die
Werte SCOPE, OS, HOME und WHOAMI aus der Section SPECIAL zu schreiben. In
diesen Faellen setze ich einen Fehler und gebe undef zurueck.

=back

=head1 PRIVATE FUNKTIONEN

=over 4