|
NAMEToader::Page::Manage - Manage pages for a specified Toader directory.VERSIONVersion 0.1.0SYNOPSISuse Toader::Page::Manage; METHODSnewThis initiates the object.One argument is required and that is a Toader object. After calling this, you should call setDir to set the directory to use. my $foo = Toader::Page::Manage->new( $toader ); listThis lists the available pages.my @pages=$foo->list; if($foo->error){ warn('error: '.$foo->error.":".$foo->errorString); } publishedreadThis reads a page.One argument is required and it is entry name. The returned value is a Toader::Page object. my $page=$foo->read($pageName); if($foo->error){ warn('error: '.$foo->error.":".$foo->errorString); } removeThis removes a page.One argument is required and it is page name. $foo->remove($page); if($foo->error){ warn('error: '.$foo->error.":".$foo->errorString); } setDirThis sets the directory the module will work on.One argument is taken and that is the path for the Toader directory in question. $foo->setDir($toaderDirectory) if($foo->error){ warn('error: '.$foo->error.":".$foo->errorString); } ERROR CODES/FLAGS1, noDirSpecifiedNo directory specified.2, isaToaderDirErroredisaToaderDir errored.3, notAtoaderDirIs not a Toader directory.4, noDirDefinedNo directory has been defined.5, openDirFailedFailed to open the directory.6, noEntrySpecifiedNo entry specified.7, invalidEntryNameThe entry is not a valid name.8, pageDoesNotExistThe entry does not exist.9, unlinkFailedFailed to unlink the entry.10, openPageFailedUnable to open the page file for reading.11, pageObjCreationFailedUnable to generate a Toader::Page object from the file.12, notAtoaderObjThe object specified is not a Toader object.13, getVCSerroredToader->getVCS errored.14, VCSusableErroredToader::VCS->usable errored.15, underVCSerroredToader::VCS->underVCS errored.16, VCSdeleteErroredToader::VCS->delete errored.17, noToaderObjNo Toader object specified.18, helperNewErroredToader::Page::Helper->new errored.AUTHORZane C. Bowers-Hadley, "<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::Manage 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. |