/ 
Toader-0.1.0
River stage zero No dependents
/ Toader::Directory

NAME

Toader::Directory - This the index file for a Toader directory.

VERSION

Version 0.0.1

SYNOPSIS

For information on the storage and rendering of entries, please see 'Documentation/Directory.pod'.

METHODS

new

If any of the new methods error, the error is permanent.

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

as_string

This returns the directory as a string.

my $mimeString=$foo->as_string;
if($foo->error)
    warn('Error:'.$foo->error.': '.$foo->errorString);
}

bodyGet

This gets body.

my $body=$foo->bodyGet;
if($foo->error){
    warn('Error:'.$foo->error.': '.$foo->errorString);
}

bodySet

This sets the body.

One argument is required and it is the body.

$foo->bodySet($body);
if($foo->error){
    warn('Error:'.$foo->error.': '.$foo->errorString);
}

dirGet

This gets Toader directory this entry is associated with.

This will only error if a permanent error is set.

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

dirSet

This sets Toader directory this entry is associated with.

One argument is taken and it is the Toader directory to set it to.

$foo->dirSet($toaderDirectory);
if($foo->error){
    warn('Error:'.$foo->error.': '.$foo->errorString);
}

listSubToaderDirs

This lists the sub Toader directories in the current Toader directory, ignoring items starting with a '.'.

The returned value is a array containing a list of relative directory names.

This method requires dirSet to have been used previously.

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

rendererGet

This returns the renderer type.

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

rendererSet

This sets the renderer type.

One argument is taken and it is the render type.

A value of undef sets it to the default, 'html'.

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

subpartsAdd

This adds a new file as a subpart.

One argument is required and it is the path to the file.

$foo->subpartsAdd( $file );
if ( $foo->error ){
    warn('Error:'.$foo->error.': '.$foo->errorString);
}

subpartsExtract

This extracts the subparts of a entry.

One argument is extracted, it is the directory to extract the files to.

$foo->subpartsExtract( $dir );
if ( $foo->error ){
    warn('Error:'.$foo->error.': '.$foo->errorString);
}

subpartsGet

This returns the results from the subparts methods from the internal Email::MIME object.

my @parts=$foo->subpartsGet;
if ( $foo->error ){
    warn('Error:'.$foo->error.': '.$foo->errorString);
}

subpartsList

This returns a list filenames for the subparts.

my @files=$foo->subpartsList;
if ( $foo->error ){
    warn('Error:'.$foo->error.': '.$foo->errorString);
}

subpartsRemove

This removes the specified subpart.

One argument is required and it is the name of the file to remove.

$foo->subpartsRemove( $filename );
if ( $foo->error ){
    warn('Error:'.$foo->error.': '.$foo->errorString);
}

summaryGet

This returns the summary.

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

summarySet

This sets the summary.

One argument is taken and it is the summary.

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

write

This saves the page file. It requires dirSet to have been called previously.

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

REQUIRED RENDERING METHODS

filesDir

This returns the file directory for the object.

This is not a full path, but a partial path that should be appended the directory current directory being outputted to.

locationID

This returns the location ID.

This one requires the object to be initialized.

renderDir

This is the directory that it will be rendered to.

The base directory that will be used for rendering.

renderUsing

This returns the module to use for rendering.

my $module=$foo->renderUsing;

toaderRenderable

This method returns true and marks it as being Toader renderable.

toDir

This returns the path to the object.

This is not a full path, but a partial path that should be appended the directory current directory being outputted to.

ERROR CODES

1

Unable to open the index file for the specified directory.

2

The specified directory is not a Toader directory.

3

No title specified.

4

No directory has been specified yet.

5

The directory is no longer a Toader directory.

6

Failed to open the file for writing.

7

Failed to open the directory.

8

No summary specified.

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

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.