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

NAME

Toader::Entry::Helper - Misc helper methods for entries.

VERSION

Version 1.0.0

METHODS

new

This initializes this object.

On argument is required and it is a Toader object.

    my $foo = Toader::Entry::Helper->new( $toader );
    if($foo->error){
        warn('error: '.$foo->error.":".$foo->errorString);
    }

entryDirectory

This returns the entry directory.

This requires setDir to be called previously.

If setDir has been successfully called, this will not error.

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

entryExists

This checks if the specified helper exists.

One argument is accepted and it is

This requires setDir to be called previously.

    my $retruned=$foo->entryExists($entry);
    if($foo->error){
        warn('error: '.$foo->error.":".$foo->errorString);
    }
    if($returned){
        print "It exists.\n";
    }

generateEntryName

This generates a entry name.

    my $entryName=$foo->generateEntryName;

setDir

This sets the directory to operate on.

One argument is required. It is the directory to use.

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

summary

This builds a summary of the of the entries in the directory.

returned hash

The key values are the entry IDs. Each subhash then contains the following keys.

    from
    renderer
    title
    summary

validEntryName

This verifies that the name is a valid file name.

One arguemnet is taken and that is the name of the entry name to check.

This will not error. If the name is not defined, false, '0', will be returned as undefined is not a valid name.

    my $valid=$foo->validEntryName($name);
    if($valid){
        print '"'.$name.'" is a valid name.';
    }

validEntryNameRegex

This returns the regular expression for validating a entry name.

This method does not call errorBlank for ease simplicity. This means a error check should not be done on this message as if any error was set previously then one will still be set.

    my $regex=$foo->validEntryNameRegex($name);

ERROR CODES

1, notAtoaderDir

Not a Toader directory.

2, noDirSpecified

No directory specified.

3, noEntrySpecified

No entry specified.

4, noDirSet

No directory has been set yet.

5, invalidEntryName

The entry name is not valid.

6, entryManageErrored

Failed to initialize Toader::Entry::Manage.

7, listEntriesErrored

Failed to list the entires.

8, readEntryErrored

Failed to read a entry.

9, noToaderObj

No Toader object specified.

10, notAtoaderObj

The object specified is not a Toader object.

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

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.