Zane C. Bowers-Hadley > Toader > Toader::Page::Helper

Download:
Toader-1.1.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

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

NAME ^

Toader::Page::Helper - Misc helper methods for pages.

VERSION ^

Version 1.0.0

METHODS ^

new

This initializes this object.

This method will not error.

    my $foo = Toader::Page::FileHelper->new();

pageDirectory

This returns the page directory.

This requires setDir to be called previously.

If setDir has been successfully called, this will not error.

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

pageExists

This checks if the specified page exists.

One argument is accepted and it is the page in question.

This requires setDir to be called previously.

    my $retruned=$foo->pageExists($page);
    if($foo->error){
        warn('error: '.$foo->error.":".$foo->errorString);
    }
    if($returned){
        print "It exists.\n";
    }

setDir

This sets the directory to operate on.

One argument is required. It is the directory to use.

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

summary

This builds a summary of of the the pages.

validPageName

This verifies that the name is a valid file name.

One arguemnet is taken and that is the name of the page name to check.

This will not error. If the name is not defined, false, '0', will be returned as undefined is not a valid name.

    my $valid=$foo->validPageName($name);
    if($valid){
        print '"'.$name.'" is a valid name.';
    }

ERROR CODES ^

1, notAtoaderDir

Not a Toader directory.

2, noDirSpecified

No directory specified.

3, noPageSpecified

No page specified.

4, noDirSet

No directory has been set yet.

5, invalidPageName

The page name is not valid.

6, pageManageErrored

Failed to initialize Toader::Page::Manage.

7, noToaderObj

No Toader object specified.

8, notAtoaderObj

The object specified is not a Toader object.

AUTHOR ^

Zane C. Bowers, <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::Page::Helper

You can also look for information at:

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.

syntax highlighting: