GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  TOADER::CONFIG (3)

.ds Aq ’

NAME

Toader::Config - Represents the Toader config.

CONTENTS

VERSION

Version 1.0.0

METHODS

    new

This initiates the object.

One argument is required and it is a Toader object.



    my $foo = Toader::Config->new( $toader );
    if ( $foo->error ){
        warn(error:.$foo->error.: .$foo->errorString);
    }



    getConfig

This returns the Config::Tiny object storing the Toader config.

There is no need to do any error checking as long as Toader new suceeded with out issue.



    my $config=$foo->getConfig;



    getConfigFile

This returns the config file for Toader.



    my $configFile=$foo->getConfigFile;



    listSections

This returns a list of sections.



    my @sections=$foo->listSections;



    listVariables

This returns a list of variables for a section.



    my @variables=$foo->listVariables( $section );
    if ( $foo->error ){
        warn( error:.$foo->error.: .$foo->errorString );
    }



    valueDel

This deletes a specified value.

Two arguments are taken. The first is the section. If not specified, _ is used. The second and required one is the variable name.

As long as the section exists, which it always will for ’_’, and a variable name is specified, this won’t error.



        $foo->valueDel( $section, $variable );



    valueGet

This returns a value that has been set for a variable.

Two arguments are taken. The first is the section. If not specified, _ is used. The second and required one is the variable name.

As long as the section exists, which it always will for ’_’, and a variable name is specified, this won’t error.

If a value does not exist, undef is returned.



    my $value=$foo->valueGet( $section, $variable );



    valueSet

This sets a new value for the config.

Third arguments are taken. The first is the section. If not specified, _ is used. The second and required one is the variable name. The third and required is the the value.

If the specified section does not exist, a new one will be created.

Neither the section or variable name can match /[\t \n\=\#\;]/.



    my $value=$foo->valueSet( $section, $variable, $value );



    write

Writes the config out to the Toader config file.



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



ERROR CODES/FLAGS

    1, noToaderObj

No Toader object specified.

    2, notAtoaderObj

The specified object is not a Toader object.

    3, noDirSet

The Toader object did not return a directory.

    4, configReadFailed

Failed to read the config file.

    5, sectionDoesNotExist

The section does not exist.

    6, noVariableSpecified

No variable name specified.

    7, invalidVariableOrSection

Variable or section matched /[\t \n\=\#\;]/.

    8, configWriteFailed

Failed to write the config out.

    9, getVCSerrored

Toader->getVCS errored.

    10, VCSusableErrored

Toader::VCS->usable errored.

    11, underVCSerrored

Toader::VCS->underVCS errored.

    12, VCSaddErrored

Toader::VCS->add errored.

AUTHOR

Zane C. Bowers-Hadley, <vvelox at vvelox.net>

BUGS

Please report any bugs or feature requests to bug-toader at rt.cpan.org, or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Toader>. 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 Toader::Config



You can also look for information at:
o RT: CPAN’s request tracker

<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader>

o AnnoCPAN: Annotated CPAN documentation

<http://annocpan.org/dist/Toader>

o CPAN Ratings

<http://cpanratings.perl.org/d/Toader>

o Search CPAN

<http://search.cpan.org/dist/Toader/>

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2011 Zane C. Bowers-Hadley.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 TOADER::CONFIG (3) 2013-05-11

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.