Config::Model::BackendUseryContributed Perl DocuConfig::Model::Backend::Any(3)NAMEConfig::Model::Backend::Any - Virtual class for other backends
VERSION
version 1.235
SYNOPSIS
package Config::Model::Backend::Foo ;
use Moose ;
use Log::Log4perl qw(get_logger :levels);
extends 'Config::Model::Backend::Any';
# optional
sub suffix {
return '.foo';
}
# mandatory
sub read {
my $self = shift ;
my %args = @_ ;
# args are:
# root => './my_test', # fake root directory, userd for tests
# config_dir => /etc/foo', # absolute path
# file => 'foo.conf', # file name
# file_path => './my_test/etc/foo/foo.conf'
# io_handle => $io # IO::File object
# check => yes|no|skip
return 0 unless defined $args{io_handle} ; # or die?
foreach ($args{io_handle}->getlines) {
chomp ;
s/#.*/ ;
next unless /\S/; # skip blank line
# $data is 'foo=bar' which is compatible with load
$self->node->load(step => $_, check => $args{check} ) ;
}
return 1 ;
}
# mandatory
sub write {
my $self = shift ;
my %args = @_ ;
# args are:
# root => './my_test', # fake root directory, userd for tests
# config_dir => /etc/foo', # absolute path
# file => 'foo.conf', # file name
# file_path => './my_test/etc/foo/foo.conf'
# io_handle => $io # IO::File object
# check => yes|no|skip
my $ioh = $args{io_handle} ;
foreach my $elt ($self->node->get_element_name) {
my $obj = $self->node->fetch_element($elt) ;
my $v = $self->node->grab_value($elt) ;
# write value
$ioh->print(qq!$elt="$v"\n!) if defined $v ;
$ioh->print("\n") if defined $v ;
}
return 1;
}
no Moose ;
__PACKAGE__->meta->make_immutable ;
DESCRIPTION
This Moose class is to be inherited by other backend plugin classes
See "read callback" in Config::Model::AutoRead and "write callback" in
Config::Model::AutoRead for more details on the method that must be
provided by any backend classes.
CONSTRUCTOR
new ( node => $node_obj, name => backend_name )
The constructor should be used only by Config::Model::Node.
Methods to override
annotation
Whether the backend supports to read and write annotation. Default is
0. Override if your backend supports annotations
Methods
read_global_comments( lines , comment_char)
Read the global comments (i.e. the first block of comments until the
first blank or non comment line) and store them as root node
annotation. The first parameter ("lines")
is an array ref containing file lines.
associates_comments_with_data ( lines , comment_char)
This method will extract comments from the passed lines and associate
them with actual data found in the file lines. Data is associated with
comments preceding or on the same line as the data. Returns a list of [
data, comment ] .
Example:
# Foo comments
foo= 1
Baz = 0 # Baz comments
will return
( [ 'foo= 1', 'Foo comments' ] , [ 'Baz = 0' , 'Baz comments' ] )
write_global_comments( io_handle , comment_char)
Write global comments from configuration root annotation into the
io_handle (if defined). Returns the string written to the io_handle.
write_data_and_comments( io_handle , comment_char , data1, comment1, data2,
comment2 ...)
Write data and comments in the "io_handle" (if defined). Comments are
written before the data. Returns the string written to the io_handle.
If a data is undef, the comment will be written on its own line.
AUTHOR
Dominique Dumont, (ddumont at cpan dot org)
SEE ALSO
Config::Model, Config::Model::AutoRead, Config::Model::Node,
Config::Model::Backend::Yaml,
perl v5.14.1 2011-07-22 Config::Model::Backend::Any(3)