|
NAMEToader::Page::Helper - Misc helper methods for pages.VERSIONVersion 1.0.0METHODSnewThis initializes this object.This method will not error. my $foo = Toader::Page::FileHelper->new(); pageDirectoryThis 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); } pageExistsThis 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"; } setDirThis 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); } summaryThis builds a summary of of the the pages.validPageNameThis 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 CODES1, notAtoaderDirNot a Toader directory.2, noDirSpecifiedNo directory specified.3, noPageSpecifiedNo page specified.4, noDirSetNo directory has been set yet.5, invalidPageNameThe page name is not valid.6, pageManageErroredFailed to initialize Toader::Page::Manage.7, noToaderObjNo Toader object specified.8, notAtoaderObjThe object specified is not a Toader object.AUTHORZane C. Bowers, "<vvelox at vvelox.net>"BUGSPlease 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.SUPPORTYou can find documentation for this module with the perldoc command.perldoc Toader::Page::Helper You can also look for information at:
ACKNOWLEDGEMENTSLICENSE AND COPYRIGHTCopyright 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.
Visit the GSP FreeBSD Man Page Interface. |