Zane C. Bowers-Hadley > Toader-1.1.2 > Toader::findToaderDirs

Download:
Toader-1.1.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

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

NAME ^

Toader::findToaderDirs - Finds all Toader directories under a specified Toader directory.

VERSION ^

Version 0.1.0

SYNOPSIS ^

    use Toader::findToaderDirs;

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

    my @dirs=$foo->findToaderDirs($directory);
    if($foo->error){
        warn('Error '.$foo->error.': '.$foo->errorString);
    }else{
        print join("\n", @dirs)."\n";
    }

METHODS ^

new

This initiates the object.

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

findToaderDirs

This returns all found Toader directories under the path.

One argument is taken and it a Toader directory.

The returned array will also include the one it started in.

    my @dirs=$foo->findToaderDirs($directory);
    if($foo->error){
        warn('Error '.$foo->error.': '.$foo->errorString);
    }else{
        print join("\n", @dirs)."\n";
    }

findToaderSubDirs

This lists all sub Toader directories under a specified Toader directory.

This only returns the found directory names under the directory.

    my @sub=$foo->findToaderSubDirs($dir);
    if($foo->error){
        warn('Error '.$foo->error.': '.$foo->errorString);
    }else{
        print join("\n", @dirs)."\n";
    }

ERROR CODES ^

1, noDirSpecified

No directory specified.

2, notAdir

Not a directory.

3, notAtoaderDir

Not a Toader directory.

4, isaToaderDirErrored

Toader::isaToaderDir->isaToaderDir errored.

5, rootIsAtoaderDir

"/" is the directory and it appears to be a Toader directory.

This is a major WTF and should not be even if '/.toader' exists.

6, dirOpenFailed

Could not open one of the directories.

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

You can also look for information at:

ACKNOWLEDGEMENTS ^

LICENSE AND COPYRIGHT ^

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