Index
- NAME
- SYNOPSIS
- ABSTRACT
- DESCRIPTION
new(backend) --> Confset(var,val) --> voidget(var [, default]) --> stringdel(var) --> voidmove(fromvar,tovar) --> voidexists(var) --> booleanset_prop(var,prop,val) --> voidset_prop(var,prop,val) --> voidget_prop(var,prop [,default]) --> stringdel_prop(var,prop) --> voidmove_prop(var,fromprop,toprop) --> voidexists_prop(var,prop) --> booleanvariables() --> list of stored variablesproperties(var) --> list of stored propertiescache(cache_on) --> voidclear_cache() --> void
- SEE ALSO
- AUTHOR
- COPYRIGHT AND LICENSE
NAME
Config::Frontend - Configuration module with flexible backends
SYNOPSIS
use Config::Frontend;
use Config::Frontend::String;
open my $in,"<conf.cfg";
my $string=<$in>;
close $in;
my $cfg=new Conf(new Config::Frontend::String(\$string))
print $cfg->get("config item 1");
$cfg->set("config item 1","Hi There!");
$cfg->set("cfg2","config 2");
$cfg->del("config item 1");
open my $out,">conf.cfg";
print $out $string;
close $out;
ABSTRACT
This module can be used to put configuration items in.
It's build up by using a backend and an interface. The
interface is through the Config::Frontend module. A
Config::Frontend object is instantiated with a backend.
DESCRIPTION
new(backend) --> Conf
Should be called with a pre-instantiated backend.
Returns a Config::Frontend object.
set(var,val) --> void
Sets a variable with value val in the backend.
get(var [, default]) --> string
Returns the value for var as stored in the backend.
Returns undef, if var does not exist in the backend and
default has not been given. Otherwise, returns default, if
var does not exist in the backend.
del(var) --> void
Deletes a variable from the backend. All properties for the variable are also removed.
move(fromvar,tovar) --> void
Rename a variable fromvar with all it's properties to tovar.
Note. If tovar already exists, it will be overwritten.
exists(var) --> boolean
Returns true, if var exists. Returns false, otherwise.
set_prop(var,prop,val) --> void
Sets property prop for variable var to value val.
set_prop(var,prop,val) --> void
Sets property prop for variable var to value val.
get_prop(var,prop [,default]) --> string
Returns property prop for variable var, or undef cq. default
if the property doesn't exist.
del_prop(var,prop) --> void
Deletes property prop for variable var.
move_prop(var,fromprop,toprop) --> void
Renames a property withing the bounds of a variable from fromprop
to toprop. Note. If toprop already exists, it will be
overwritten.
exists_prop(var,prop) --> boolean
Returns true if property prop exists for variable var.
False, otherwise.
variables() --> list of stored variables
Returns a list all variables (not properties) stored in the backend.
properties(var) --> list of stored properties
Returns a list of all properties for a variable in the backend.
cache(cache_on) --> void
If cache_on = true, this will turn on caching for
the get() method. If caching is on, the get() method
will only go to the backend if a variable does not exist
in it's cache. The set() function will delete a
variable from cache if it is updated. The del() function
will delete a variable from cache.
clear_cache() --> void
Clears the cache.
SEE ALSO
AUTHOR
Hans Oesterholt-Dijkema, <oesterhol@cpan.org>
COPYRIGHT AND LICENSE
Copyright 2004 by Hans Oesterholt-Dijkema
This library is free software; you can redistribute it and/or modify it under Artistic License.