The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Toader-1.2.1
River stage zero No dependents
++
/ Toader::Entry::Manage

NAME

Toader::Entry::Manage - Manage entries.

VERSION

Version 1.0.0

METHODS

new

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 );

cacheGet

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);
    }

cacheUpdateAll

This updates the cache for all entries.

There are no arguments taken.

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

list

This lists the available entries.

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

published

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 );
    }

read

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 );
    }

remove

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);
    }

setDir

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);
    }

touch

This updates the entry name to a newer one.

ERROR CODES/Flags

1, noDirSpecified

No directory specified.

2, isaToaderDirErrored

isaToaderDir errored.

3, notAtoaderDir

Is not a Toader directory.

4, noDirDefined

No directory has been defined.

5, openDirFailed

Failed to open the directory.

6, noEntrySpecified

No entry specified.

7, invalidEntryName

The entry is not a valid name.

8, entryDoesNotExist

The entry does not exist.

9, unlinkFailed

Failed to unlink the entry.

10, openEntryFailed

Unable to open the entry file for reading.

11, entryObjCreationFailed

Generating a Toader::Entry object from a alredy existing entry failed.

12, notAtoaderObj

The object specified is not a Toader object.

13, getVCSerrored

Toader->getVCS errored.

14, VCSusableErrored

Toader::VCS->usable errored.

15, underVCSerrored

Toader::VCS->underVCS errored.

16, VCSdeleteErrored

Toader::VCS->delete errored.

17, noToaderObj

No Toader object specified.

18, helperNewErrored

Toader::Entry::Helper->new errored.

19, cacheNewErrored

Toader::Entry::Cache->new errored.

20, cacheDirSetErrored

Toader::Entry::Cache->setDir errored.

21, cacheUpdateAllErrored

Toader::Entry::Cache->updateAll errored.

22, entryNameSetErrored

Toader::Entry->entryNameSet errored.

23, entryWriteErrored

Toader::Entry->write errored.

24, cacheDeleteEntryErrored

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.

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::Entry::Manage

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

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.