Zane C. Bowers-Hadley > Toader-0.4.0 > Toader::Page::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.1   Source   Latest Release: Toader-1.1.1

NAME ^

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

VERSION ^

Version 0.0.1

SYNOPSIS ^

    use Toader::Page::Manage;

METHODS ^

new

This initiates the object.

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

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

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 ^

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 page file for reading.

11

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

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: