Overview

Packages

  • admin
  • classes
    • media
  • CodeIgniter
    • Libraries
  • core
  • functions
  • JSMin
  • None
  • OpenID
  • PHP
  • PHPMailer
  • plugins
    • admin
    • development
    • feed
    • mail
    • media
    • misc
    • seo
    • spam
    • uploader
    • users
    • zenpage
    • zenphoto
      • news
  • Services
    • JSON

Classes

  • Album
  • AlbumBase
  • Comment
  • dynamicAlbum
  • feed
  • Gallery
  • Image
  • MediaObject
  • PersistentObject
  • SearchEngine
  • ThemeObject
  • Transientimage
  • Zenphoto_Administrator
  • Zenphoto_Authority

Functions

  • isAlbumClass
  • isImageClass
  • newAlbum
  • newImage
  • search_quote
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Class dynamicAlbum

Root class for images and albums

PersistentObject
Extended by ThemeObject
Extended by MediaObject
Extended by AlbumBase
Extended by dynamicAlbum
Package: classes
Located at class-album.php
Methods summary
public
# __construct( $folder8, $cache = true, $quiet = false )

Class instantiator

Class instantiator

Overrides

AlbumBase::__construct()
protected boolean
# _albumCheck( type $folder8, $folderFS, $quiet )

album validity check

album validity check

Parameters

$folder8
$folderFS
$quiet

Returns

boolean
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 string
# getSearchParams( )

Returns the search parameters for a dynamic album

Returns the search parameters for a dynamic album

Returns

string

Overrides

AlbumBase::getSearchParams()
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

Overrides

AlbumBase::setSearchParams()
public object
# getSearchEngine( )

Returns the search engine for a dynamic album

Returns the search engine for a dynamic album

Returns

object

Overrides

AlbumBase::getSearchEngine()
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, $oldfolder = "" )

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).
$oldfolder

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
# 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.

Overrides

AlbumBase::preLoad()
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()
public boolean
# isDynamic( )

Returns true if the album is "dynamic"

Returns true if the album is "dynamic"

Returns

boolean

Overrides

AlbumBase::isDynamic()
protected boolean
# setDefaults( )

Sets default values for a new album

Sets default values for a new album

Returns

boolean

Overrides

AlbumBase::setDefaults()
Methods inherited from AlbumBase
_move(), albumSubRights(), checkforGuest(), garbageCollect(), getAlbumLink(), getAlbumSortKey(), getAlbumSortType(), getAlbumTheme(), getAlbumThumb(), getAlbumThumbImage(), getFileName(), getFolder(), getGalleryPage(), getImage(), getImageSortKey(), getLink(), getLocation(), getNextAlbum(), getNumAlbums(), getNumImages(), getOwner(), getParent(), getParentID(), getPrevAlbum(), getSortDirection(), getSortType(), getThumb(), getUpdatedDate(), getWatermark(), getWatermarkThumb(), isMyItem(), isProtected(), rename(), setAlbumTheme(), setAlbumThumb(), setLocation(), setOwner(), 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 summary
public $searchengine
#
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
Zenphoto doc API documentation generated by ApiGen