Zane C. Bowers-Hadley > Toader > Toader::Render::Gallery

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::Render::Gallery - This renders a Toader::Gallery object.

VERSION ^

Version 0.1.0

SYNOPSIS ^

METHODS ^

new

This initiates the object.

args hash ref

obj

This is the Toader::Gallery object to render.

toader

This is the Toader object to use.

        my $foo=Toader::Render::Gallery->new(\%args);
    if($foo->error){
        warn('error: '.$foo->error.":".$foo->errorString);
    }

render

This is just here for compatibiltiy reasons. It returns true.

updateDetails

updateIndexes

This updates the index.html file for a gallery directory.

Two arguments are taken. The first and required is the directory act upon. The second and optional is if it should be recursive or not, which defaults to false.

updateScaled

This updates scaled images. If a scaled image is found to already exist, it does not rerocess it.

Two arguments are taken. The first and required is the directory act upon. The second and optional is if it should be recursive or not, which defaults to false.

ERROR CODES ^

1, noObj

No Toader::Gallery object specified.

2, noToaderObj

No Toader object specified.

3, objPerror

The Toader::Gallery object has a permanent error set.

4, toaderPerror

The Toader object has a permanent error set.

5, noDirSet

The Toader::Gallery object does not have a directory set

6, pathhalperInitErrored

Failed to initialize a Toader::pathHelper.

7, realative2rootErrored

Failed to get relative to root.

9, notUnderSrcPath

The specified directory does not appear to be under the source path.

10, dirStartsWithPeriod

The specified directory contains a directory that starts with a period.

11, srcPathDoesNotExit

The source directory does not exist.

12, outputDirDoesNotExist

The output directory does not exist.

13, srcDirOpenFailed

Could not open the source directory.

14, smallThumbFileOpenFailed

Failed to open the small thumbnail file.

15, smallThumbPathCreationFailed

Failed to create the new path for the small thumbnails.

16, largeThumbPathCreationFailed

Failed to create the new path for the large thumbnails.

17, generalInitErrored

Failed to initialize Toader::Render::General.

18, renderTemplateErrored

Failed to render a template.

19, pathCreationFailed

Failed to create the new path for the index.html.

20, pathCleanupFailed

Path cleanup failed.

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

You can also look for information at:

ACKNOWLEDGEMENTS ^

LICENSE AND COPYRIGHT ^

Copyright 2014. 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: