Class AlbumBase

Root class for images and albums

PersistentObject

ThemeObject

MediaObject

AlbumBase

Direct known subclasses

Album, dynamicAlbum, favorites

Package: classes
Located at class-album.php

Methods summary
`public`	# `__construct( $folder8, $cache = true )` Class instantiator Class instantiator Overrides `MediaObject::__construct()`
`protected boolean`	# `setDefaults( )` Sets default values for a new album Sets default values for a new album Returns boolean Overrides `PersistentObject::setDefaults()`
`public string`	# `getFileName( )` Returns the folder on the filesystem Returns the folder on the filesystem Returns string
`public string`	# `getFolder( )` Returns the folder on the filesystem Returns the folder on the filesystem Returns string
`public object`	# `getParent( )` Returns The parent Album of this Album. NULL if this is a top-level album. Returns The parent Album of this Album. NULL if this is a top-level album. Returns object
`public string`	# `getParentID( )` Returns the partent id Returns the partent id Returns string Overrides `ThemeObject::getParentID()`
`public string`	# `getLocation( $locale = NULL )` Returns the place data of an album Returns the place data of an album Returns string
`public`	# `setLocation( string $place )` Stores the album place Stores the album place Parameters `$place` text for the place field
`public string`	# `getSortDirection( string $what = 'image' )` Returns either the subalbum sort direction or the image sort direction of the album Returns either the subalbum sort direction or the image sort direction of the album Parameters `$what` 'image_sortdirection' if you want the image direction, 'album_sortdirection' if you want it for the album Returns string
`public string`	# `getSortType( $what = 'image' )` Returns the sort type of the album images Will return a parent sort type if the sort type for this album is empty Returns the sort type of the album images Will return a parent sort type if the sort type for this album is empty Returns string
`public`	# `setSortDirection( boolean $val, string $what = 'image' )` sets sort directions for the album sets sort directions for the album Parameters `$val` the direction `$what` 'image_sortdirection' if you want the image direction, 'album_sortdirection' if you want it for the album
`public`	# `setSortType( string $sorttype, string $what = 'image' )` Stores the sort type for the album Stores the sort type for the album Parameters `$sorttype` the album sort type `$what` 'Description'image' or 'album'
`public string`	# `getAlbumSortType( )` Returns the sort type for subalbums in this album. Returns the sort type for subalbums in this album. Will return a parent sort type if the sort type for this album is empty. Deprecated since version 1.4.5 Returns string
`public`	# `setSubalbumSortType( string $sorttype )` Stores the subalbum sort type for this abum Stores the subalbum sort type for this abum Deprecated since version 1.4.5 Parameters `$sorttype` the subalbum sort type
`public string`	# `getImageSortKey( string $sorttype = null )` Returns the DB key associated with the image sort type Returns the DB key associated with the image sort type Parameters `$sorttype` the sort type Returns string
`public string`	# `getAlbumSortKey( string $sorttype = null )` Returns the DB key associated with the subalbum sort type Returns the DB key associated with the subalbum sort type Parameters `$sorttype` subalbum sort type Returns string
`public array`	# `getAlbums( string $page = 0, string $sorttype = null, string $sortdirection = null, boolean $care = true, boolean $mine = NULL )` Returns all folder names for all the subdirectories. Returns all folder names for all the subdirectories. Parameters `$page` Which page of subalbums to display. `$sorttype` The sort strategy `$sortdirection` The direction of the sort `$care` set to false if the order does not matter `$mine` set true/false to override ownership Returns array
`public integer`	# `getNumAlbums( )` Returns the count of subalbums Returns the count of subalbums Returns integer
`public array`	# `getImages( string $page = 0, integer $firstPageCount = 0, string $sorttype = null, string $sortdirection = null, boolean $care = true, boolean $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. 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 `$page` Which page of images should be returned. If zero, all images are returned. `$firstPageCount` count of images that go on the album/image transition page `$sorttype` optional sort type `$sortdirection` optional sort direction `$care` set to false if the order of the images does not matter `$mine` set true/false to override ownership Returns array
`public integer`	# `getNumImages( )` Returns the number of images in this album (not counting its subalbums) Returns the number of images in this album (not counting its subalbums) Returns integer
`public integer`	# `getImage( integer $index )` Returns an image from the album based on the index passed. Returns an image from the album based on the index passed. Parameters `$index` Returns integer
`public Image`	# `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. 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. Returns `Image`
`public string`	# `getThumb( )` Gets the thumbnail URL for the album thumbnail image as returned by $this->getAlbumThumbImage(); Gets the thumbnail URL for the album thumbnail image as returned by $this->getAlbumThumbImage(); Returns string
`public string`	# `getAlbumThumb( )` Gets the thumbnail URL for the album thumbnail image as returned by $this->getAlbumThumbImage(); Gets the thumbnail URL for the album thumbnail image as returned by $this->getAlbumThumbImage(); Deprecated since version 1.4.6 Returns string
`public`	# `setThumb( string $filename )` Stores the thumbnail path for an album thumg Stores the thumbnail path for an album thumg Parameters `$filename` thumbnail path
`public`	# `setAlbumThumb( string $filename )` Stores the thumbnail path for an album thumg Stores the thumbnail path for an album thumg Deprecated since version 1.4.6 Parameters `$filename` thumbnail path
`public string`	# `getAlbumLink( string $page = NULL )` Returns an URL to the album, including the current page number Returns an URL to the album, including the current page number Deprecated since version 1.4.6 Parameters `$page` if not null, apppend as page # Returns string
`public string`	# `getLink( string $page = NULL )` Returns an URL to the album, including the current page number Returns an URL to the album, including the current page number Parameters `$page` if not null, apppend as page # Returns string
`public boolean`	# `remove( )` Delete the entire album PERMANENTLY. Be careful! This is unrecoverable. Returns true if successful Delete the entire album PERMANENTLY. Be careful! This is unrecoverable. Returns true if successful Returns boolean Overrides `PersistentObject::remove()`
`protected integer`	# `_move( type $newfolder )` common album move code common album move code Parameters `$newfolder` Returns integer
`public integer`	# `move( $newfolder )` Move this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it. Move this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it. Parameters `$newfolder` the folder to move to, including the name of the current folder (possibly renamed). Returns integer 0 on success and error indicator on failure. Overrides `PersistentObject::move()`
`public boolean`	# `rename( string $newfolder )` Rename this album folder. Alias for move($newfoldername); Rename this album folder. Alias for move($newfoldername); Parameters `$newfolder` the new folder name of this album (including subalbum paths) Returns boolean true on success or false on failure.
`protected`	# `succeed( $dest )`
`public integer`	# `copy( $newfolder )` Copy this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it. Copy this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it. Parameters `$newfolder` the folder to copy to, including the name of the current folder (possibly renamed). Returns integer 0 on success and error indicator on failure. Overrides `PersistentObject::copy()`
`public`	# `garbageCollect( boolean $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. 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 `$deep` set to true for a thorough cleansing
`protected array`	# `loadFileNames( $dirs = false )` Load all of the filenames that are found in this Albums directory on disk. Returns an array with all the names. Load all of the filenames that are found in this Albums directory on disk. Returns an array with all the names. Parameters `$dirs` or not to return directories ONLY with the file array. Returns array
`public boolean`	# `isDynamic( )` Returns true if the album is "dynamic" Returns true if the album is "dynamic" Returns boolean
`public string`	# `getSearchParams( )` Returns the search parameters for a dynamic album Returns the search parameters for a dynamic album Returns string
`public`	# `setSearchParams( string $params )` Sets the search parameters of a dynamic album Sets the search parameters of a dynamic album Parameters `$params` The search string to produce the dynamic album
`public object`	# `getSearchEngine( )` Returns the search engine for a dynamic album Returns the search engine for a dynamic album Returns object
`public`	# `isMyItem( bit $action )` checks access to the album checks access to the album Parameters `$action` What the requestor wants to do returns true of access is allowed Overrides `ThemeObject::isMyItem()`
`public`	# `checkforGuest( unknown_type & $hint = NULL, unknown_type & $show = NULL )` Checks if guest is loggedin for the album Checks if guest is loggedin for the album Parameters `$hint` `$show`
`public`	# `isProtected( )` returns true if there is any protection on the album
`public`	# `getOwner( )` Owner functions Owner functions
`public`	# `setOwner( $owner )`
`public`	# `getUpdatedDate( )` Date at which the album last discovered an image
`public`	# `setUpdatedDate( $date )`
`public string`	# `getAlbumTheme( )` Returns the theme for the album Returns the theme for the album Returns string
`public`	# `setAlbumTheme( string $theme )` Sets the theme of the album Sets the theme of the album Parameters `$theme`
`public string`	# `getWatermark( )` returns the album watermark returns the album watermark Returns string
`public`	# `setWatermark( string $wm )` Sets the album watermark Sets the album watermark Parameters `$wm`
`public boolean`	# `getWatermarkThumb( )` Returns the album watermark thumb Returns the album watermark thumb Returns boolean
`public`	# `setWatermarkThumb( $wm )` Sets the custom watermark usage Sets the custom watermark usage Parameters `$wm`
`public`	# `albumSubRights( )` returns the mitigated album rights. returns NULL if not a managed album returns the mitigated album rights. returns NULL if not a managed album
`protected array`	# `sortImageArray( array $images, string $sorttype, string $sortdirection, boolean $mine = NULL )` 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. 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. Parameters `$images` The array of filenames to be sorted. `$sorttype` optional sort type `$sortdirection` optional sort direction `$mine` set to true/false to override ownership clause Returns array
`protected`	# `updateParent( string $newfolder )` changes the parent of an album for move/copy changes the parent of an album for move/copy Parameters `$newfolder` The folder name of the new parent
`public`	# `preLoad( )` Simply creates objects of all the images and sub-albums in this album to load accurate values into the database. Simply creates objects of all the images and sub-albums in this album to load accurate values into the database.
`public object`	# `getNextAlbum( )` Returns the album following the current album Returns the album following the current album Returns object
`public object`	# `getPrevAlbum( )` Returns the album prior to the current album Returns the album prior to the current album Returns object
`public integer`	# `getGalleryPage( )` Returns the page number in the gallery or the parent album of this album Returns the page number in the gallery or the parent album of this album Returns integer

Methods inherited from MediaObject
`getDesc(), getExpireDate(), getPassword(), getPasswordHint(), getPublishDate(), getSortOrder(), getUser(), setDesc(), setExpireDate(), setPassword(), setPasswordHint(), setPublishDate(), setSortOrder(), setUser()`

Methods inherited from ThemeObject
`addComment(), checkAccess(), checkForGuest(), checkPublishDates(), countHit(), getCodeblock(), getCommentCount(), getComments(), getCommentsAllowed(), getCustomData(), getDateTime(), getHitcounter(), getShow(), getTags(), getTitle(), hasTag(), setCodeblock(), setCommentsAllowed(), setCustomData(), setDateTime(), setParentID(), setShow(), setTags(), setTitle()`

Methods inherited from PersistentObject
`__toString(), get(), getData(), getID(), instantiate(), save(), set()`

Properties summary
`public`	`$name`	#
`public`	`$linkname`	#
`public`	`$localpath`	#
`public boolean`	`$exists`	# `true`
`public`	`$images`	# `null`
`public`	`$parent`	# `null`
`public`	`$parentalbum`	# `null`
`public array`	`$sidecars`	# `array()`
`public`	`$manage_rights`	# `MANAGE_ALL_ALBUM_RIGHTS`
`public`	`$manage_some_rights`	# `ALBUM_RIGHTS`
`public`	`$view_rights`	# `ALL_ALBUMS_RIGHTS`
`protected`	`$subalbums`	# `null`
`protected`	`$index`	#
`protected`	`$lastimagesort`	# `NULL`
`protected`	`$lastsubalbumsort`	# `NULL`
`protected`	`$albumthumbnail`	# `NULL`
`protected`	`$subrights`	# `NULL`

Properties inherited from ThemeObject
`$comments`

Properties inherited from PersistentObject
`$id, $loaded, $table, $transient`

Packages

Classes

Functions

Class AlbumBase

Direct known subclasses

Overrides

Returns

Overrides

Returns

Returns

Returns

Returns

Overrides

Returns

Parameters

Parameters

Returns

Returns

Parameters

Parameters

Deprecated

Returns

Deprecated

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Deprecated

Returns

Parameters

Deprecated

Parameters

Deprecated

Parameters

Returns

Parameters

Returns

Returns

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns