Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

Album Class Reference

Inheritance diagram for Album:

Album_gallery Album_XML List of all members.

Public Member Functions

 Album ($source=null, $module=null)
 loadData ()
 ID ()
 attribute ($name)
 logo ()
 thumbnail ($photo)
 photo ($photo)
 caption ($photo)
 visited ($photo)
 photoID ($photo)
 mergeVars ()

Public Attributes

 prefix
 attributes
 photos
 thumbnails
 visited
 captions
 title
 logo
 _modulesrc
 _source
 _class
 _module
 _init

Constructor & Destructor Documentation

Album::Album source = null,
module = null
 

Determines a correct album's data module by examining album data source.

See also:
generateModule()
Parameters:
string $source Source of album's data (file or URI)
string £module Force to use this module (only for Setup!)

Definition at line 71 of file Album.php.

References generateModule(), and module.


Member Function Documentation

Album::attribute name  ) 
 

Returns wanted attribute

Parameters:
$name Attribute's name
Returns:
mixed If named attribute was founded, return it.

Definition at line 134 of file Album.php.

Referenced by logo().

Album::caption photo  ) 
 

If photo has an caoption, this method can be used to return that caption.

Parameters:
integer $photo Photo ID
Returns:
string Caption

Definition at line 195 of file Album.php.

Album::ID  ) 
 

Returns currect album's ID

Returns:
string Current ID

Definition at line 123 of file Album.php.

Referenced by logo(), photo(), and thumbnail().

Album::loadData  ) 
 

Loads album's data

If album module was successfully loaded, this method calls module's loadData-method and loads that way all album's datas. If module was not loaded, this method does nothing. Module must fill its variables correctly, because after module's loadData()-method was called, method calls mergeVars()-method to merge module's and $this variables, i.e. copies e.g. attributes from module to current object.

See also:
Album_XML::loadData()

mergeVars()

Definition at line 106 of file Album.php.

References mergeVars().

Album::logo  ) 
 

Return HTML IMG tag to load album's logo.

Returns:
HTML code containing IMG tag to album's logo

Definition at line 144 of file Album.php.

References attribute(), and ID().

Album::mergeVars  ) 
 

This method merges all needed variables from album data module and current object.

See also:
loadData()

Definition at line 228 of file Album.php.

Referenced by loadData().

Album::photo photo  ) 
 

Return HTML IMG tag to display selected photo (resized version)

Parameters:
integer $photo Photo ID
Returns:
string HTML Code

Definition at line 178 of file Album.php.

References ID().

Referenced by Album_XML::loadData(), Album_gallery::loadData(), and thumbnail().

Album::photoID photo  ) 
 

Return photo's ID from filename.

Parameters:
string $photo Photo's filename
Returns:
integer Photo ID (i.e. array index of $this->photos)
See also:
$this->photos

Definition at line 218 of file Album.php.

Referenced by thumbnail().

Album::thumbnail photo  ) 
 

Returns HTML IMG tag to display thumbnail of photo photo

Parameters:
string $photo Filename of photo
Returns:
HTML code containg IMG tag to photo's thumbnail

Definition at line 159 of file Album.php.

References ID(), photo(), and photoID().

Album::visited photo  ) 
 

Shows how many times photo has been viewed (and since when?)

Parameters:
integer $photo Photo ID
Returns:
array Visited timestamp and count of clicks

Definition at line 206 of file Album.php.


Member Data Documentation

Album::_class
 

Definition at line 56 of file Album.php.

Album::_init
 

Definition at line 61 of file Album.php.

Album::_module
 

Definition at line 60 of file Album.php.

Album::_modulesrc
 

Definition at line 54 of file Album.php.

Album::_source
 

Definition at line 55 of file Album.php.

Album::attributes
 

Definition at line 42 of file Album.php.

Referenced by Album_XML::loadData(), and Album_gallery::loadData().

Album::captions
 

Definition at line 46 of file Album.php.

Referenced by Album_XML::loadData(), and Album_gallery::loadData().

Album::logo
 

Definition at line 53 of file Album.php.

Referenced by Album_gallery::loadData().

Album::photos
 

Definition at line 43 of file Album.php.

Referenced by Album_XML::loadData(), and Album_gallery::loadData().

Album::prefix
 

Definition at line 37 of file Album.php.

Album::thumbnails
 

Definition at line 44 of file Album.php.

Referenced by Album_XML::loadData(), and Album_gallery::loadData().

Album::title
 

Definition at line 52 of file Album.php.

Referenced by Album_gallery::loadData().

Album::visited
 

Definition at line 45 of file Album.php.

Referenced by Album_gallery::loadData().


The documentation for this class was generated from the following file:
Generated on Sun Oct 19 11:08:03 2003 for ImaComm by doxygen1.3