[ class tree: classes ] [ index: classes ] [ all elements ]

Class: Album

Source Location: /class-album.php

Class Album

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From AlbumBase

AlbumBase::$albumthumbnail
AlbumBase::$exists
AlbumBase::$images
AlbumBase::$index
AlbumBase::$lastimagesort
AlbumBase::$lastsubalbumsort
AlbumBase::$linkname
AlbumBase::$localpath
AlbumBase::$manage_rights
AlbumBase::$manage_some_rights
AlbumBase::$name
AlbumBase::$parent
AlbumBase::$parentalbum
AlbumBase::$sidecars
AlbumBase::$subalbums
AlbumBase::$subrights
AlbumBase::$view_rights

Inherited From ThemeObject

ThemeObject::$comments

Inherited From PersistentObject

PersistentObject::$id
PersistentObject::$loaded
PersistentObject::$table
PersistentObject::$transient

Inherited From AlbumBase

AlbumBase::__construct()
AlbumBase::albumSubRights()
returns the mitigated album rights.
AlbumBase::checkforGuest()
Checks if guest is loggedin for the album
AlbumBase::copy()
Copy this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it.
AlbumBase::garbageCollect()
For every image in the album, look for its file. Delete from the database if the file does not exist. Same for each sub-directory/album.
AlbumBase::getAlbumLink()
Returns an URL to the album, including the current page number
AlbumBase::getAlbums()
Returns all folder names for all the subdirectories.
AlbumBase::getAlbumSortKey()
Returns the DB key associated with the subalbum sort type
AlbumBase::getAlbumSortType()
Returns the sort type for subalbums in this album.
AlbumBase::getAlbumTheme()
Returns the theme for the album
AlbumBase::getAlbumThumb()
Gets the thumbnail URL for the album thumbnail image as returned by $this->getAlbumThumbImage();
AlbumBase::getAlbumThumbImage()
Gets the album's set thumbnail image from the database if one exists, otherwise, finds the first image in the album or sub-album and returns it as an Image object.
AlbumBase::getFileName()
Returns the folder on the filesystem
AlbumBase::getFolder()
Returns the folder on the filesystem
AlbumBase::getGalleryPage()
Returns the page number in the gallery of this album
AlbumBase::getImage()
Returns an image from the album based on the index passed.
AlbumBase::getImages()
Returns a of a slice of the images for this album. They will also be sorted according to the sort type of this album, or by filename if none has been set.
AlbumBase::getImageSortKey()
Returns the DB key associated with the image sort type
AlbumBase::getLink()
Returns an URL to the album, including the current page number
AlbumBase::getLocation()
Returns the place data of an album
AlbumBase::getNextAlbum()
Returns the album following the current album
AlbumBase::getNumAlbums()
Returns the count of subalbums
AlbumBase::getNumImages()
Returns the number of images in this album (not counting its subalbums)
AlbumBase::getOwner()
Owner functions
AlbumBase::getParent()
Returns The parent Album of this Album. NULL if this is a top-level album.
AlbumBase::getParentID()
AlbumBase::getPrevAlbum()
Returns the album prior to the current album
AlbumBase::getSearchEngine()
Returns the search engine for a dynamic album
AlbumBase::getSearchParams()
Returns the search parameters for a dynamic album
AlbumBase::getSortDirection()
Returns either the subalbum sort direction or the image sort direction of the album
AlbumBase::getSortType()
Returns the sort type of the album images Will return a parent sort type if the sort type for this album is empty
AlbumBase::getThumb()
Gets the thumbnail URL for the album thumbnail image as returned by $this->getAlbumThumbImage();
AlbumBase::getUpdatedDate()
Date at which the album last discovered an image
AlbumBase::getWatermark()
returns the album watermark
AlbumBase::getWatermarkThumb()
Returns the album watermark thumb
AlbumBase::isDynamic()
Returns true if the album is "dynamic"
AlbumBase::isMyItem()
checks access to the album
AlbumBase::isProtected()
returns true if there is any protection on the album
AlbumBase::loadFileNames()
Load all of the filenames that are found in this Albums directory on disk.
AlbumBase::move()
Move this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it.
AlbumBase::preLoad()
Simply creates objects of all the images and sub-albums in this album to load accurate values into the database.
AlbumBase::remove()
Delete the entire album PERMANENTLY. Be careful! This is unrecoverable.
AlbumBase::rename()
Rename this album folder. Alias for move($newfoldername);
AlbumBase::setAlbumTheme()
Sets the theme of the album
AlbumBase::setAlbumThumb()
Stores the thumbnail path for an album thumg
AlbumBase::setDefaults()
Sets default values for a new album
AlbumBase::setLocation()
Stores the album place
AlbumBase::setOwner()
AlbumBase::setSearchParams()
Sets the search parameters of a dynamic album
AlbumBase::setSortDirection()
sets sort directions for the album
AlbumBase::setSortType()
Stores the sort type for the album
AlbumBase::setSubalbumSortType()
Stores the subalbum sort type for this abum
AlbumBase::setThumb()
Stores the thumbnail path for an album thumg
AlbumBase::setUpdatedDate()
AlbumBase::setWatermark()
Sets the album watermark
AlbumBase::setWatermarkThumb()
Sets the custom watermark usage
AlbumBase::sortImageArray()
sortImageArray will sort an array of Images based on the given key. The key must be one of (filename, title, sort_order) at the moment.
AlbumBase::succeed()
AlbumBase::updateParent()
changes the parent of an album for move/copy
AlbumBase::_move()
common album move code

Inherited From MediaObject

MediaObject::__construct()
Class instantiator
MediaObject::getDesc()
Returns the description
MediaObject::getExpireDate()
Returns the expire date
MediaObject::getPassword()
Returns the password
MediaObject::getPasswordHint()
Returns the password hint
MediaObject::getPublishDate()
Returns the publish date
MediaObject::getSortOrder()
Returns the sort order
MediaObject::getUser()
Returns the guest user
MediaObject::setDesc()
Stores the description
MediaObject::setExpireDate()
sets the expire date
MediaObject::setPassword()
Sets the encrypted password
MediaObject::setPasswordHint()
Sets the password hint
MediaObject::setPublishDate()
sets the publish date
MediaObject::setSortOrder()
Stores the sort order
MediaObject::setUser()
Sets the guest user

Inherited From ThemeObject

ThemeObject::__construct()
Class instantiator
ThemeObject::addComment()
Adds comments to the album assumes data is coming straight from GET or POST
ThemeObject::checkAccess()
Checks if viewing of object is allowed
ThemeObject::checkForGuest()
returns false (deny) if gallery is "private"
ThemeObject::countHit()
counts visits to the object
ThemeObject::getCodeblock()
Returns the codeblocks as an serialized array
ThemeObject::getCommentCount()
Returns the count of comments in the album. Ignores comments in moderation
ThemeObject::getComments()
Returns an array of comments for this album
ThemeObject::getCommentsAllowed()
Retuns true if comments are allowed
ThemeObject::getCustomData()
returns the custom data field
ThemeObject::getDateTime()
Returns the unformatted date
ThemeObject::getHitcounter()
Returns the hitcount
ThemeObject::getParentID()
Returns the partent id
ThemeObject::getShow()
Returns true published
ThemeObject::getTags()
Returns the tag data
ThemeObject::getTitle()
Returns the title
ThemeObject::hasTag()
Checks if an object has a tag assigned.
ThemeObject::isMyItem()
Checks basic access rights of an object
ThemeObject::setCodeblock()
set the codeblocks as an serialized array
ThemeObject::setCommentsAllowed()
Sets the comments allowed flag
ThemeObject::setCustomData()
Sets the custom data field
ThemeObject::setDateTime()
Stores the date
ThemeObject::setParentID()
Sets the ParentID field
ThemeObject::setShow()
Stores the published value
ThemeObject::setTags()
Stores tag information
ThemeObject::setTitle()
Stores the title

Inherited From PersistentObject

PersistentObject::PersistentObject()
PersistentObject::copy()
Copy this record to another unique set. Checks if the record exists there first, if so returns false. If successful returns true. No changes are made to this object and no other objects are created, just the database entry.
PersistentObject::get()
Get the value of a variable. If $current is false, return the value as of the last save of this object.
PersistentObject::getData()
returns the database record of the object
PersistentObject::getID()
Returns the id
PersistentObject::instantiate()
Prime instantiator for Zenphoto objects
PersistentObject::move()
Change one or more values of the unique set assigned to this record.
PersistentObject::remove()
Deletes object from the database
PersistentObject::save()
Save the updates made to this object since the last update. Returns true if successful, false if not.
PersistentObject::set()
Set a variable in this object. Does not persist to the database until save() is called. So, IMPORTANT: Call save() after set() to persist.
PersistentObject::setDefaults()
Sets default values for new objects using the set() method.
PersistentObject::__toString()
"Magic" function to return a string identifying the object when it is treated as a string

[ Top ]
Method Summary
Album   __construct()   Constructor for albums
int   copy()   Copy this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it.
void   garbageCollect()   For every image in the album, look for its file. Delete from the database if the file does not exist. Same for each sub-directory/album.
array   getAlbums()   Returns all folder names for all the subdirectories.
array   getImages()   Returns a of a slice of the images for this album. They will also be sorted according to the sort type of this album, or by filename if none has been set.
array   loadFileNames()   Load all of the filenames that are found in this Albums directory on disk.
int   move()   Move this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it.
bool   remove()   Delete the entire album PERMANENTLY. Be careful! This is unrecoverable.
bool   setDefaults()   Sets default values for a new album
void   succeed()  
boolean   _albumCheck()   album validity check
array   _getAlbums()   Guts of fetching the subalbums

[ Top ]
Methods
Constructor __construct  [line 1175]

  Album __construct( string $folder8, [bool $cache = true], [ $quiet = false], object $gallery  )

Constructor for albums

Parameters:
object   $gallery:  The parent gallery: deprecated
string   $folder8:  folder name (UTF8) of the album
bool   $cache:  load from cache if present
   $quiet: 


Redefinition of:
AlbumBase::__construct()

[ Top ]
copy  [line 1411]

  int copy( $newfolder $newfolder  )

Copy this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it.

Parameters:
$newfolder   $newfolder:  string the folder to copy to, including the name of the current folder (possibly renamed).

API Tags:
Return:  0 on success and error indicator on failure.


Redefinition of:
AlbumBase::copy()
Copy this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it.

[ Top ]
garbageCollect  [line 1446]

  void garbageCollect( [bool $deep = false]  )

For every image in the album, look for its file. Delete from the database if the file does not exist. Same for each sub-directory/album.

Parameters:
bool   $deep:  set to true for a thorough cleansing


Redefinition of:
AlbumBase::garbageCollect()
For every image in the album, look for its file. Delete from the database if the file does not exist. Same for each sub-directory/album.

[ Top ]
getAlbums  [line 1265]

  array getAlbums( [string $page = 0], [string $sorttype = null], [string $sortdirection = null], [bool $care = true], [bool $mine = NULL]  )

Returns all folder names for all the subdirectories.

Parameters:
string   $page:  Which page of subalbums to display.
string   $sorttype:  The sort strategy
string   $sortdirection:  The direction of the sort
bool   $care:  set to false if the order does not matter
bool   $mine:  set true/false to override ownership


Redefinition of:
AlbumBase::getAlbums()
Returns all folder names for all the subdirectories.

[ Top ]
getImages  [line 1307]

  array getImages( [int $page = 0], [int $firstPageCount = 0], [string $sorttype = null], [string $sortdirection = null], [bool $care = true], [bool $mine = NULL]  )

Returns a of a slice of the images for this album. They will also be sorted according to the sort type of this album, or by filename if none has been set.

Parameters:
int   $page:  Which page of images should be returned. If zero, all images are returned.
int   $firstPageCount:  count of images that go on the album/image transition page
string   $sorttype:  optional sort type
string   $sortdirection:  optional sort direction
bool   $care:  set to false if the order of the images does not matter
bool   $mine:  set true/false to override ownership


Redefinition of:
AlbumBase::getImages()
Returns a of a slice of the images for this album. They will also be sorted according to the sort type of this album, or by filename if none has been set.

[ Top ]
loadFileNames  [line 1522]

  array loadFileNames( [$dirs $dirs = false]  )

Load all of the filenames that are found in this Albums directory on disk.

Returns an array with all the names.

Parameters:
$dirs   $dirs:  Whether or not to return directories ONLY with the file array.

API Tags:
Access:  protected


Redefinition of:
AlbumBase::loadFileNames()
Load all of the filenames that are found in this Albums directory on disk.

[ Top ]
move  [line 1379]

  int move( $newfolder $newfolder  )

Move this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it.

Parameters:
$newfolder   $newfolder:  string the folder to move to, including the name of the current folder (possibly renamed).

API Tags:
Return:  0 on success and error indicator on failure.


Redefinition of:
AlbumBase::move()
Move this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it.

[ Top ]
remove  [line 1332]

  bool remove( )

Delete the entire album PERMANENTLY. Be careful! This is unrecoverable.

Returns true if successful



Redefinition of:
AlbumBase::remove()
Delete the entire album PERMANENTLY. Be careful! This is unrecoverable.

[ Top ]
setDefaults  [line 1223]

  bool setDefaults( )

Sets default values for a new album


API Tags:
Access:  protected


Redefinition of:
AlbumBase::setDefaults()
Sets default values for a new album

[ Top ]
succeed  [line 1400]

  void succeed( $dest  )

Parameters:
   $dest: 

API Tags:
Access:  protected


Redefinition of:
AlbumBase::succeed()

[ Top ]
_albumCheck  [line 1198]

  boolean _albumCheck( $folder8, $folderFS, $quiet  )

album validity check

Parameters:
   $folder8: 
   $folderFS: 
   $quiet: 

API Tags:
Access:  protected


[ Top ]
_getAlbums  [line 1245]

  array _getAlbums( )

Guts of fetching the subalbums


API Tags:
Access:  protected


[ Top ]

Documentation generated on Sat, 07 Jun 2014 18:03:13 +0200 by phpDocumentor 1.4.3