Toader::Gallery - Handle image galleries.
Version 0.0.0
This initiates the object.
my $foo = Toader::AutoDoc->new; if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
This gets Toader directory this entry is associated with.
This will only error if a permanent error is set.
This will return undef if no directory has been set.
my $dir=$foo->dirGet; if($foo->error){ warn('Error:'.$foo->error.': '.$foo->errorString); }
This sets Toader directory this entry is associated with.
One argument is taken and it is the Toader directory to set it to.
my $dir=$foo->dirSet($toaderDirectory); if($foo->error){ warn('Error:'.$foo->error.': '.$foo->errorString); }
This is initializes the config for a directory. This is automatically called if it has not been done so for a directory.
This returns the output path.
my $outputPath=$foo->outputPathGet; if ( $foo->error ){ warn( 'error:'.$foo->error.': '.$foo->errorString ); }
$foo->outputPathSet( $outputPath ); if ( $foo->error ){ warn( 'error:'.$foo->error.': '.$foo->errorString ); }
my $outputURL=$foo->outputURLget; if ( $foo->error ){ warn( 'error:'.$foo->error.': '.$foo->errorString ); }
This sets the output URL.
This returns the source path.
my $srcPath=$foo->srcPath; if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
This sets the that to search for images.
One argument is required and it is a path.
$foo->srcPathSet( $srcPath ); if ( $foo->error ){ warn( 'error:'.$foo->error.': '.$foo->errorString ); }
This gets the URL to use for the images.
my $srcURLget=$foo->srcURLget; if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
This sets the URL that is used for linking to the source images.
$foo->srcURLset( $url ); if ( $foo->error ){ warn( 'error:'.$foo->error.': '.$foo->errorString ); }
Returns if upon rendering it should update image details or not.
The return value is a Perl boolean.
my $update=$foo->renderUpdateDetailsGet; if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
This sets wether or note Toader::Render::Gallery->render should update the details or not.
This takes a Perl boolean.
$foo->renderUpdateDetailsGet( $update ); if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
Returns if upon rendering it should update the indexes or not.
my $update=$foo->renderUpdateIndexesGet; if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
This sets wether or note Toader::Render::Gallery->render should update the indexes or not.
$foo->renderUpdateIndexesGet( $update ); if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
Returns if upon rendering it should update the scaled images or not.
This sets wether or note Toader::Render::Gallery->render should update the scaled images or not.
Returns the small resolution.
my $smallRes=$foo->resolutionSmallGet; if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
Sets the small resolution.
One argument is taken and that is the maximum resolution for a image. If not specified, it resets it to 200.
my $smallRes=$foo->resolutionSmallSet( $resolution ); if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
Returns the larg resolution.
my $largeRes=$foo->resolutionLargeGet; if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
One argument is taken is the maximum resolution to use. If not specified, it resets it to the default, 1024.
$foo->resolutionLargeSet( $res ); if ( $foo->error ){ warn('error:'.$foo->error.': '.$foo->errorString); }
This checks if the this object is usable for rendering or not.
It does not check if the directories exist, other than the settings are specified.
if ( ! $foo->usable ){ print "This is not a renderable object currently... something is missing...\n"; }
This writes the config out.
The ones listed below are useless and are just included for compatibility reasons.
filesDir renderDir toDir
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.
This returns '' as it is not used by this module. As for rendering, fullURL is set for Toader::Render::General.
This returns the location ID.
This one requires the object to be initialized.
This is the directory that it will be rendered to.
The base directory that will be used for rendering.
This returns the module to use for rendering.
my $module=$foo->renderUsing;
This method returns true and marks it as being Toader renderable.
This returns the directory that will return the directory that contains where this object should be rendered to.
No directory specified.
The directory is not a Toader directory.
Failed to read the gallery config.
No config for this directory.
The specified resolution is non-numeric.
No source path specified.
No source URL specified.
No output path specified.
No output URL specified.
The directory has already been initialized.
Failed to initialize Toader::pathHelper.
Zane C. Bowers-Hadley, <vvelox at vvelox.net>
<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.
bug-toader at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Toader::AutoDoc
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.
To install Toader, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Toader
CPAN shell
perl -MCPAN -e shell install Toader
For more information on module installation, please visit the detailed CPAN module installation guide.