GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Toader::Entry::Helper(3) User Contributed Perl Documentation Toader::Entry::Helper(3)

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

Version 1.0.0

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

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

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

This generates a entry name.

    my $entryName=$foo->generateEntryName;

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

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

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.';
    }

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

Not a Toader directory.

No directory specified.

No entry specified.

No directory has been set yet.

The entry name is not valid.

Failed to initialize Toader::Entry::Manage.

Failed to list the entires.

Failed to read a entry.

No Toader object specified.

The object specified is not a Toader object.

Zane C. Bowers-Hadley, "<vvelox at vvelox.net>"

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.

You can find documentation for this module with the perldoc command.

    perldoc Toader::Entry::Helper

You can also look for information at:

  • RT: CPAN's request tracker

    <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader>

  • AnnoCPAN: Annotated CPAN documentation

    <http://annocpan.org/dist/Toader>

  • CPAN Ratings

    <http://cpanratings.perl.org/d/Toader>

  • Search CPAN

    <http://search.cpan.org/dist/Toader/>

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.

2013-05-13 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.