Zane C. Bowers-Hadley > Toader > Toader::Page::Manage

Download:
Toader-1.1.1.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  1
View/Report Bugs
Module Version: 0.1.0   Source  

NAME ^

Toader::Page::Manage - Manage pages for a specified Toader directory.

VERSION ^

Version 0.1.0

SYNOPSIS ^

    use Toader::Page::Manage;

METHODS ^

new

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

list

This lists the available pages.

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

published

read

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

remove

This removes a page.

One argument is required and it is page name.

    $foo->remove($page);
    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/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, pageDoesNotExist

The entry does not exist.

9, unlinkFailed

Failed to unlink the entry.

10, openPageFailed

Unable to open the page file for reading.

11, pageObjCreationFailed

Unable to generate a Toader::Page object from the file.

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::Page::Helper->new errored.

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