Zane C. Bowers-Hadley > Toader-1.1.2 > Toader

Download:
Toader-1.1.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  1
View/Report Bugs
Module Version: 1.1.2   Source  

NAME ^

Toader - A CMS meant to be integrated with a versioning system.

VERSION ^

Version 1.1.2

SYNOPSIS ^

    use Toader;

    my $foo = Toader->new({dir=>$toaderDir});
    if ( $foo->error ){
        warn('Error:'.$foo->error.': '.$foo->errorString);
    }

METHODS ^

new

args hash ref

dir

This is the directory to intiate in.

This is required and needs to be a Toader directory.

outputdir

This is the output directory to use when rendering.

    my $toader=Toader->new(\%args);
    if ( $toader->error ){
        warn('Error:'.$toader->error.':'.$toader->errorFlag.': '.$toader->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=$toader->getConfig;
    if ( $toader->error ){
        warn('Error:'.$toader->error.':'.$toader->errorFlag.': '.$toader->errorString);
    }

getConfigObj

This returns the Toader::Config object that was created when this module was created.

    my $configObj=$toader->getConfigObj;
    if ( $toader->error ){
        warn('Error:'.$toader->error.':'.$toader->errorFlag.': '.$toader->errorString);
    }

getDirObj

This returns a Toader::Directory object with the directory set to the Toader root.

    my $dirobj=$toader->getDirObj;
    if ( $toader->error ){
        warn('Error:'.$toader->error.':'.$toader->errorFlag.': '.$toader->errorString);
    }

getOutputDir

This returns the output directory.

If none is specified, undef is returned.

There is no reason for check for errors if new succeeded with out error.

    my $outputdir=$toader->getOutputDir;
    if( defined( $outputdir ) ){
        print "outputdir='".$outputdir."'\n";
    }else{
        print "No output directory defined.\n";
    }

getPathHelper

This returns a Toader::pathHelper object for this Toader object.

If the Toader object initialized with out issue, then there is no reason to check for an error.

    my $pathHelper=$toader->getPathHelper;
    if ( $toader->error ){
        warn('Error:'.$toader->error.':'.$toader->errorFlag.': '.$toader->errorString);
    }

getRootDir

This returns the root directory for what Toader is using.

If the returned value is not defined, one has not been set yet.

    my $rootdir=$toader->getRootDir;
    if ( $foo->error ){
        warn('Error:'.$foo->error.':'.$toader->errorFlag.': '.$foo->errorString);
    }

setOutputDir

This sets the output directory.

    $foo->setOutputDir( $dir );
    if ( $foo->error ){
        warn('Error:'.$foo->error.':'.$toader->errorFlag.': '.$foo->errorString);
    }

getVCS

This returns to the Toader::VCS object.

    my $vcs=$toader->getVCS;
    if ( $toader->error ){
        warn('Error:'.$toader->error.':'.$toader->errorFlag.': '.$toader->errorString);
    }

ERROR CODES ^

1, noDirSpecified

No directory specified.

2, isaToaderDirError

Toader::isaToaderDir->isaToaderDir errored.

3, notAtoaderDir

The specified directory is not a Toader directory.

4, outputIsAtoaderDir

The specified output directory is a Toader directory.

5, DirectoryInitError

Could initialize the Toader::Directory object.

6, ConfigInitError

Failed to initialize Toader::Config.

7, PathHerlerInitError

Failed to initiate the path helper.

8, VCSinitError

Failed to initiate VCS integration.

9, VCSusableError

Toader::VCS->usable 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

You can also look for information at:

ACKNOWLEDGEMENTS ^

LICENSE AND COPYRIGHT ^

Copyright 2013 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.

syntax highlighting: