Zane C. Bowers-Hadley > Toader-0.4.0 > Toader::Entry::Manage

Download:
Toader-0.4.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  1
View/Report Bugs
Module Version: 0.0.2   Source   Latest Release: Toader-1.1.1

NAME ^

Toader::Entry::Manage - Manage entries.

VERSION ^

Version 0.0.2

METHODS ^

new

This initiates the object.

After calling this, you should call setDir to set the directory to use.

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

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.

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

ERROR CODES ^

1

No directory specified.

2

isaToaderDir errored.

3

Is not a Toader directory.

4

No directory has been defined.

5

Failed to open the directory.

6

No entry specified.

7

The entry is not a valid name.

8

The entry does not exist.

9

Failed to unlink the entry.

10

Unable to open the entry file for reading.

11

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

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