Toader::Entry::Manage - Manage entries.
Version 1.0.0
This initiates the object.
One argument is required and it is a Toader object.
After calling this, you should call setDir to set the directory to use.
my $foo = Toader::New->new( $toader );
This returns the Toader::Entry::Cache object.
There are no arguments taken.
my $cache=$foo->cacheGet; if($foo->error){ warn('error: '.$foo->error.":".$foo->errorString); }
This updates the cache for all entries.
$foo->cacheUpdateAll; if($foo->error){ warn('error: '.$foo->error.":".$foo->errorString); }
This lists the available entries.
my @entries=$foo->list; if($foo->error){ warn('error: '.$foo->error.":".$foo->errorString); }
This returns a list of published or unpublished entries.
One argument is accepted and that is the return value from Toader::Entry->publishGet. If that is not defined, then '1' is used.
This will throw a warning for entries that can not be read, it will not throw a error.
my @published=$foo->published; if ( $foo->error ){ warn( 'Error:'.$foo->error.': '.$foo->errorStrin ); }
This reads a entry.
One argument is taken and that is the entry name.
my $entry=$foo->read( $entryName ); if ( $foo->error ){ warn( 'Error:'.$foo->error.': '.$foo->errorStrin ); }
This removes a entry. It will remove it from VCS and the cache as well.
One argument is required and it is entry name.
$foo->remove($entry); if($foo->error){ warn('error: '.$foo->error.":".$foo->errorString); }
This 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); }
This updates the entry name to a newer one.
No directory specified.
isaToaderDir errored.
Is not a Toader directory.
No directory has been defined.
Failed to open the directory.
No entry specified.
The entry is not a valid name.
The entry does not exist.
Failed to unlink the entry.
Unable to open the entry file for reading.
Generating a Toader::Entry object from a alredy existing entry failed.
The object specified is not a Toader object.
Toader->getVCS errored.
Toader::VCS->usable errored.
Toader::VCS->underVCS errored.
Toader::VCS->delete errored.
No Toader object specified.
Toader::Entry::Helper->new errored.
Toader::Entry::Cache->new errored.
Toader::Entry::Cache->setDir errored.
Toader::Entry::Cache->updateAll errored.
Toader::Entry->entryNameSet errored.
Toader::Entry->write errored.
Toader::Entry::Cache->deleteEntry errored.
If this errors it means the cache is screwed in some manner and needs reinited via Toader::Entry::Cache->reinit.
Zane C. Bowers-Hadley, <vvelox at vvelox.net>
<vvelox at vvelox.net>
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.
bug-toader at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Toader::Entry::Manage
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Toader
CPAN Ratings
http://cpanratings.perl.org/d/Toader
Search CPAN
http://search.cpan.org/dist/Toader/
Copyright 2014 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.
To install Toader, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Toader
CPAN shell
perl -MCPAN -e shell install Toader
For more information on module installation, please visit the detailed CPAN module installation guide.