/ 
VLGal-Directory-0.01
River stage zero No dependents
/ VLGal::Directory

NAME

VLGal::Directory - Vincenzo's little gallery direcrory

SYNOPSIS

TODO

ABSTRACT

Vincenzo's little gallery direcrory

DESCRIPTION

VLGal::Directory describes properties of Vincenzo's little gallery directories.

CONSTRUCTOR

new( [ OPT_HASH_REF ] )

Creates a new VLGal::Directory object. OPT_HASH_REF is a hash reference used to pass initialization options. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

file

Passed to set_file(). Must be an ARRAY reference.

Options for OPT_HASH_REF inherited through package VLGal::File may include:

basename

Passed to set_basename().

dirname

Passed to set_dirname().

super_dir

Passed to set_super_dir().

new_from_fs(OPT_HASH_REF)

Creates a new VLGal::Directory object from the specified dirname and basename options in OPT_HASH_REF. OPT_HASH_REF is a hash reference used to pass initialization options for VLGal::File objects. On error an exception Error::Simple is thrown.

METHODS

add_file( [ VALUE ... ] )

Add additional values on the list of files in the directory. Each VALUE is an object out of which the id is obtained through method get_basename(). The obtained key is used to store the value and may be used for deletion and to fetch the value. 0 or more values may be supplied. Multiple occurrences of the same key yield in the last occurring key to be inserted and the rest to be ignored. Each key of the specified values is allowed to occur only once. On error an exception Error::Simple is thrown.

The values in ARRAY must be a (sub)class of:
VLGal::File
delete_file(ARRAY)

Delete elements from the list of files in the directory. Returns the number of deleted elements. On error an exception Error::Simple is thrown.

exists_file(ARRAY)

Returns the count of items in ARRAY that are in the list of files in the directory.

generate()

This method is an implementation from package VLGal::File. Generates the HTML files and image files that implement the gallery.

The file organisation leaves the original organisation as intact as possible. That is, in each directory one file index-vlgal.html and one directory .vlgal are claimed. The file index-vlgal.html is the entry point for the gallery. Directory .vlgal contains generated images in lower resolution and quality and HTML files required by the gallery.

get_basename()

This method is inherited from package VLGal::File. Returns the file's base name.

get_dirname()

This method is inherited from package VLGal::File. Returns the file's directory name.

get_super_dir()

This method is inherited from package VLGal::File. Returns the super directory in the file system.

keys_file()

Returns an ARRAY containing the keys of the list of files in the directory.

mk_fs_name()

This method is inherited from package VLGal::File. Makes the file systemn name of the object usinf dirname and basename.

mk_vlgal_dir_name()

This method is overloaded from package VLGal::File. Makes the name of the .vlgal directory.

set_basename(VALUE)

This method is inherited from package VLGal::File. Set the file's base name. VALUE is the value. On error an exception Error::Simple is thrown.

set_dirname(VALUE)

This method is inherited from package VLGal::File. Set the file's directory name. VALUE is the value. On error an exception Error::Simple is thrown.

set_file( [ VALUE ... ] )

Set the list of files in the directory absolutely using values. Each VALUE is an object out of which the id is obtained through method get_basename(). The obtained key is used to store the value and may be used for deletion and to fetch the value. 0 or more values may be supplied. Multiple occurrences of the same key yield in the last occurring key to be inserted and the rest to be ignored. Each key of the specified values is allowed to occur only once. On error an exception Error::Simple is thrown.

The values in ARRAY must be a (sub)class of:
VLGal::File
set_super_dir(VALUE)

This method is inherited from package VLGal::File. Set the super directory in the file system. VALUE is the value. On error an exception Error::Simple is thrown.

VALUE must be a (sub)class of:
VLGal::Directory
values_file( [ KEY_ARRAY ] )

Returns an ARRAY containing the values of the list of files in the directory. If KEY_ARRAY contains one or more KEYs the values related to the KEYs are returned. If no KEYs specified all values are returned.

SEE ALSO

VLGal::File, VLGal::File::Factory, VLGal::File::MMagic, VLGal::Size, VLGal::Style

BUGS

None known (yet.)

HISTORY

First development: September 2003 Last update: October 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2003 by Vincenzo Zocca

LICENSE

This file is part of the VLGal module hierarchy for Perl by Vincenzo Zocca.

The VLGal module hierarchy is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

The VLGal module hierarchy is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with the VLGal module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA