The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
ZConf-DevTemplate-0.1.1
River stage zero No dependents
++
/ ZConf::template

NAME

ZConf::template -

VERSION

Version 0.0.0

SYNOPSIS

Quick summary of what the module does.

Perhaps a little code snippet.

    use ZConf::template;

    my $foo = ZConf::template->new();
    ...

METHODS

new

This initializes it.

One arguement is taken and that is a hash.

hash values

zconf

If this is defined, it will be used instead of creating a new ZConf object.

    my $foo=ZConf::template->new;
    if($foo->error){
        warn('error '.$foo->error.': '.$foo->errorString);
    }

delSet

This removes the specified ZConf set.

    $foo->delSet('someSet');
    if($foo->{error}){
        warn('error '.$foo->error.': '.$foo->errorString);
    }

getZConf

This returns the ZConf object.

The only time this will error is if a permanent error is set.

    my $zconf=$foo->getZConf;
    if ($foo->error){
        warn('error '.$foo->error.': '.$foo->errorString);
    }

init

This initiates a new set. If a set already exists, it will be overwritten.

If the set specified is undefined, the default will be used.

The set is not automatically read.

    $foo->init($set);
    if($foo->{error}){
        warn('error '.$foo->error.': '.$foo->errorString);
    }

listSets

This lists the available sets for the ZConf config.

    my @sets=$foo->listSets;
    if($foo->{error}){
        warn('error '.$foo->error.': '.$foo->errorString);
    }

readSet

This reads a specified ZConf set.

If no set is specified, the default is used.

    $foo->readSet('someSet');
    if($foo->{error}){
        warn('error '.$foo->error.': '.$foo->errorString);
    }

ERROR RELATED METHODS

error

This returns the current error code if one is set. If undef/evaulates as false then no error is present. Other wise one is.

    if($foo->error){
        warn('error '.$foo->error.': '.$foo->errorString);
    }

errorString

This returns the current error string. A return of "" means no error is present.

    my $errorString=$foo->errorString;

errorblank

This blanks the error storage and is only meant for internal usage.

It does the following.

    $foo->{error}=undef;
    $foo->{errorString}="";

ERROR CODES

1

ZConf errored.

AUTHOR

%%%%AUTHOR%%%, <%%%EMAIL%%%>

BUGS

Please report any bugs or feature requests to bug-zconf-devtemplate at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=ZConf-template. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc ZConf::template

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2009 %%%AUTHOR%%%, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.