Class Album

Root class for images and albums

PersistentObject

Extended by

ThemeObject

Extended by

MediaObject

Extended by

AlbumBase

Extended by

Album

Package: classes
Located at class-album.php

Methods summary
`public Album`	# `__construct( object $folder8, string $cache = true, boolean $quiet = false )` Constructor for albums Constructor for albums Parameters `$folder8` $gallery The parent gallery: deprecated `$cache` $folder8 folder name (UTF8) of the album `$quiet` $cache load from cache if present Returns `Album` Overrides `AlbumBase::__construct()`
`protected boolean`	# `_albumCheck( $folder8, $folderFS, $quiet )` album validity check album validity check Returns boolean
`protected boolean`	# `setDefaults( )` Sets default values for a new album Sets default values for a new album Returns boolean Overrides `AlbumBase::setDefaults()`
`protected array`	# `_getAlbums( )` Guts of fetching the subalbums Guts of fetching the subalbums Returns array
`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 Overrides `AlbumBase::getAlbums()`
`public array`	# `getImages( integer $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 Overrides `AlbumBase::getImages()`
`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 `AlbumBase::remove()`
`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 `AlbumBase::move()`
`protected`	# `succeed( $dest )` Overrides `AlbumBase::succeed()`
`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 `AlbumBase::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 Overrides `AlbumBase::garbageCollect()`
`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 Overrides `AlbumBase::loadFileNames()`

Methods inherited from AlbumBase
_move(), albumSubRights(), checkforGuest(), getAlbumLink(), getAlbumSortKey(), getAlbumSortType(), getAlbumTheme(), getAlbumThumb(), getAlbumThumbImage(), getFileName(), getFolder(), getGalleryPage(), getImage(), getImageSortKey(), getLink(), getLocation(), getNextAlbum(), getNumAlbums(), getNumImages(), getOwner(), getParent(), getParentID(), getPrevAlbum(), getSearchEngine(), getSearchParams(), getSortDirection(), getSortType(), getThumb(), getUpdatedDate(), getWatermark(), getWatermarkThumb(), isDynamic(), isMyItem(), isProtected(), preLoad(), rename(), setAlbumTheme(), setAlbumThumb(), setLocation(), setOwner(), setSearchParams(), setSortDirection(), setSortType(), setSubalbumSortType(), setThumb(), setUpdatedDate(), setWatermark(), setWatermarkThumb(), sortImageArray(), updateParent()

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 inherited from AlbumBase
`$albumthumbnail, $exists, $images, $index, $lastimagesort, $lastsubalbumsort, $linkname, $localpath, $manage_rights, $manage_some_rights, $name, $parent, $parentalbum, $sidecars, $subalbums, $subrights, $view_rights`

Properties inherited from ThemeObject
`$comments`

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