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::pathHelper(3) User Contributed Perl Documentation Toader::pathHelper(3)

Toader::pathHelper - Various path related helpers.

Version 0.1.0

    use Toader::pathHelper;

    my $foo = Toader::pathHelper->new;

This initiates the object.

One argument is taken. That is the a Toader directory.

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

This checks if a directory is the root or not.

This returns relative path from specified directory, back to the Toader root directory.

One argument is taken and that is the Toader directory under the root Toader directory.

This cleans up the path for a Toader directory.

    my $cleandir=$foo->cleanup($dir);
    if($foo->error){
        warn('Error:'.$foo->error.': '.$foo->errorString);
    }

This finds the relative path between two toader directories.

Two arguments are accepted. Both are Toader directories. The first one is the directory to start in and the second is the directory to end in.

    my $relativePath=$foo->relative($fromDir, $toDir);
    if($foo->error){
        warn('Error:'.$foo->error.': '.$foo->errorString);
    }

This returns relative path from the root Toader directory.

One argument is taken and that is the Toader directory under the root Toader directory.

This checks if a specified Toader directory is under the Toader root directory.

One argument is taken and that is a directory. This directory must be a Toader directory.

The returned value is a boolean value.

    my $return=$self->underRoot($dir);
    if($foo->error){
        warn('Error:'.$foo->error.': '.$foo->errorString);
    }

This checks if a specified directory is under the Toader root directory. Unlike underRoot, no check is done on if it is a Toader directory or not.

One argument is taken and that is a directory.

The returned value is a boolean value.

This does not check if it exists or not.

    my $return=$self->underRootNT($dir);
    if($foo->error){
        warn('Error:'.$foo->error.': '.$foo->errorString);
    }

No directory specified.

The directory is not a Toader directory.

The Toader directory in question is not under the Toader directory root it was initialized with.

Unable to find the root Toader directory.

The directory is not under the root Toader directory.

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

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-04-27 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.