Element index for package classes
Package indexes
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ w ]
[ z ]
[ _ ]
_
- _Image
- in file class-image.php, class _Image
handles 'picture' images
- _Image
- in file class-image.php, method _Image::_Image()
Constructor for class-image
- __construct
- in file class-video.php, method Video::__construct()
Constructor for class-video
- __construct
- in file classes.php, method MediaObject::__construct()
Class instantiator
- __construct
- in file classes.php, method ThemeObject::__construct()
Class instantiator
- __construct
- in file class-transientimage.php, method Transientimage::__construct()
creates a transient image (that is, one that is not stored in the database)
- __construct
- in file class-search.php, method SearchEngine::__construct()
Constuctor
- __construct
- in file class-comment.php, method Comment::__construct()
Constructor for a comment
- __construct
- in file class-album.php, method Album::__construct()
Constructor for albums
- __construct
- in file class-gallery.php, method Gallery::__construct()
Creates an instance of a gallery
a
- $admin_all
- in file lib-auth.php, variable Zenphoto_Authority::$admin_all
- $admin_groups
- in file lib-auth.php, variable Zenphoto_Authority::$admin_groups
- $admin_other
- in file lib-auth.php, variable Zenphoto_Authority::$admin_other
- $admin_users
- in file lib-auth.php, variable Zenphoto_Authority::$admin_users
- $album
- in file class-image.php, variable _Image::$album
- $albumdir
- in file class-gallery.php, variable Gallery::$albumdir
- $albums
- in file class-search.php, variable SearchEngine::$albums
- $albums
- in file class-gallery.php, variable Gallery::$albums
- $albumthumbnail
- in file class-album.php, variable Album::$albumthumbnail
- $album_list
- in file class-search.php, variable SearchEngine::$album_list
- addComment
- in file classes.php, method ThemeObject::addComment()
Adds comments to the album assumes data is coming straight from GET or POST
- Album
- in file class-album.php, class Album
Root class for images and albums
- albumSubRights
- in file class-album.php, method Album::albumSubRights()
returns the mitigated album rights.
- allowedSearchFields
- in file class-search.php, method SearchEngine::allowedSearchFields()
Returns an array of the enabled search fields
c
- $cache_by
- in file classes.php, variable PersistentObject::$cache_by
- $category_list
- in file class-search.php, variable SearchEngine::$category_list
- $commentcount
- in file classes.php, variable ThemeObject::$commentcount
- $comments
- in file classes.php, variable ThemeObject::$comments
- $comment_error_text
- in file class-comment.php, variable Comment::$comment_error_text
- checkAccess
- in file classes.php, method ThemeObject::checkAccess()
Checks if viewing of object is allowed
- checkAccess
- in file class-image.php, method _Image::checkAccess()
returns true if user is allowed to see the image
- checkAuthorization
- in file lib-auth.php, method Zenphoto_Authority::checkAuthorization()
Retuns the administration rights of a saved authorization code Will promote an admin to ADMIN_RIGHTS if he is the most privileged admin
- checkCookieCredentials
- in file lib-auth.php, method Zenphoto_Authority::checkCookieCredentials()
Checks saved cookies to see if a user is logged in
- checkForGuest
- in file classes.php, method ThemeObject::checkForGuest()
returns false (deny) if gallery is "private"
- checkforGuest
- in file class-gallery.php, method Gallery::checkforGuest()
Checks if guest is loggedin for the album
- checkforGuest
- in file class-image.php, method _Image::checkforGuest()
Checks if guest is loggedin for the album
- checkforGuest
- in file class-album.php, method Album::checkforGuest()
Checks if guest is loggedin for the album
- checkLogon
- in file lib-auth.php, method Zenphoto_Authority::checkLogon()
Checks a logon user/password against admins
- class-album.php
- procedural page class-album.php
- class-comment.php
- procedural page class-comment.php
- class-gallery.php
- procedural page class-gallery.php
- class-image.php
- procedural page class-image.php
- class-search.php
- procedural page class-search.php
- class-transientimage.php
- procedural page class-transientimage.php
- classes.php
- procedural page classes.php
- classSetup
- in file class-image.php, method _Image::classSetup()
generic "image" class setup code Returns true if valid image.
- clearCache
- in file class-gallery.php, method Gallery::clearCache()
Cleans out the cache folder
- clearSearchWords
- in file class-search.php, method SearchEngine::clearSearchWords()
- codifySearchString
- in file class-search.php, method SearchEngine::codifySearchString()
recodes the search words replacing the boolean operators with text versions
- Comment
- in file class-comment.php, class Comment
Comment Class
- commentClean
- in file class-gallery.php, method Gallery::commentClean()
- compressedIDList
- in file class-search.php, method SearchEngine::compressedIDList()
Takes a list of IDs and makes a where clause
- copy
- in file class-image.php, method _Image::copy()
Copies the image to a new album, along with all metadata.
- copy
- in file classes.php, method 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.
- copy
- in file class-album.php, method Album::copy()
Copy this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it.
- countHit
- in file class-gallery.php, method Gallery::countHit()
counts visits to the object
- countHit
- in file classes.php, method ThemeObject::countHit()
counts visits to the object
- createPrimealbum
- in file lib-auth.php, method Zenphoto_Administrator::createPrimealbum()
Creates a "prime" album for the user. Album name is based on the userid
- class-video.php
- procedural page class-video.php
g
- $gallery
- in file class-search.php, variable SearchEngine::$gallery
- $gallery
- in file class-album.php, variable Album::$gallery
- Gallery
- in file class-gallery.php, class Gallery
Gallery Class
- garbageCollect
- in file class-gallery.php, method Gallery::garbageCollect()
For every album in the gallery, look for its file. Delete from the database if the file does not exist. Do the same for images. Clean up comments that have been left orphaned.
- garbageCollect
- in file class-album.php, method Album::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.
- get
- in file classes.php, method PersistentObject::get()
Get the value of a variable. If $current is false, return the value as of the last save of this object.
- get
- in file class-gallery.php, method Gallery::get()
- getAdminEmail
- in file lib-auth.php, method Zenphoto_Authority::getAdminEmail()
Returns the email addresses of the Admin with ADMIN_USERS rights
- getAdministrators
- in file lib-auth.php, method Zenphoto_Authority::getAdministrators()
Returns an array of admin users, indexed by the userid and ordered by "privileges"
- getAlbum
- in file lib-auth.php, method Zenphoto_Administrator::getAlbum()
Returns the user's "prime" album. See setAlbum().
- getAlbum
- in file class-image.php, method _Image::getAlbum()
Returns the album that holds this image
- getAlbum
- in file class-gallery.php, method Gallery::getAlbum()
Returns the a specific album in the array indicated by index.
- getAlbumDir
- in file class-gallery.php, method Gallery::getAlbumDir()
Returns the main albums directory
- getAlbumID
- in file class-album.php, method Album::getAlbumID()
Returns the id of this album in the db
- getAlbumIndex
- in file class-search.php, method SearchEngine::getAlbumIndex()
Returns the index of the album within the search albums
- getAlbumLink
- in file class-album.php, method Album::getAlbumLink()
Returns an URL to the album, including the current page number
- getAlbumList
- in file class-search.php, method SearchEngine::getAlbumList()
return the list of albums found
- getAlbumName
- in file class-image.php, method _Image::getAlbumName()
Retuns the folder name of the album that holds this image
- getAlbumPublish
- in file class-gallery.php, method Gallery::getAlbumPublish()
- getAlbums
- in file class-gallery.php, method Gallery::getAlbums()
Get Albums will create our $albums array with a fully populated set of Album names in the correct order.
- getAlbums
- in file class-search.php, method SearchEngine::getAlbums()
Returns an array of album names found in the search.
- getAlbums
- in file class-album.php, method Album::getAlbums()
Returns all folder names for all the subdirectories.
- getAlbumSortKey
- in file class-album.php, method Album::getAlbumSortKey()
Returns the DB key associated with the subalbum sort type
- getAlbumSortKey
- in file class-gallery.php, method Gallery::getAlbumSortKey()
Returns the DB field corresponding to the album sort type desired
- getAlbumSortType
- in file class-album.php, method Album::getAlbumSortType()
Returns the sort type for subalbums in this album.
- getAlbumTheme
- in file class-album.php, method Album::getAlbumTheme()
Returns the theme for the album
- getAlbumThumb
- in file class-album.php, method Album::getAlbumThumb()
Gets the thumbnail URL for the album thumbnail image as returned by $this->getAlbumThumbImage();
- getAlbumThumbImage
- in file class-album.php, method Album::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.
- getAlbumUseImagedate
- in file class-gallery.php, method Gallery::getAlbumUseImagedate()
Option to update album date from date of new images
- getAnAdmin
- in file lib-auth.php, method Zenphoto_Authority::getAnAdmin()
Returns an admin object from the $pat:$criteria
- getAnon
- in file class-comment.php, method Comment::getAnon()
Returns true if the comment is flagged anonymous
- getAuthCookies
- in file lib-auth.php, method Zenphoto_Authority::getAuthCookies()
returns an array of the active "password" cookies
- getBody
- in file class-video.php, method Video::getBody()
returns the content of the vido
- getCacheTag
- in file class-search.php, method SearchEngine::getCacheTag()
creates a unique id for a search
- getCategoryList
- in file class-search.php, method SearchEngine::getCategoryList()
return the list of categories found
- getChallengePhraseInfo
- in file lib-auth.php, method Zenphoto_Administrator::getChallengePhraseInfo()
- getCity
- in file class-image.php, method _Image::getCity()
Returns the city field of the image
- getCodeblock
- in file classes.php, method ThemeObject::getCodeblock()
Returns the codeblocks as an serialized array
- getCodeblock
- in file class-gallery.php, method Gallery::getCodeblock()
Returns the codeblocks as an serialized array
- getComment
- in file class-comment.php, method Comment::getComment()
Returns the comment text
- getCommentCount
- in file classes.php, method ThemeObject::getCommentCount()
Returns the count of comments in the album. Ignores comments in moderation
- getComments
- in file classes.php, method ThemeObject::getComments()
Returns an array of comments for this album
- getCommentsAllowed
- in file classes.php, method ThemeObject::getCommentsAllowed()
Retuns true if comments are allowed
- getCopyright
- in file class-image.php, method _Image::getCopyright()
Returns the copyright field of the image
- getCountry
- in file class-image.php, method _Image::getCountry()
Returns the country field of the image
- getCredentials
- in file lib-auth.php, method Zenphoto_Administrator::getCredentials()
Data to support other credential systems integration
- getCredit
- in file class-image.php, method _Image::getCredit()
Returns the credit field of the image
- getCurrentTheme
- in file class-gallery.php, method Gallery::getCurrentTheme()
Returns the foldername of the current theme.
- getCustomData
- in file lib-auth.php, method Zenphoto_Administrator::getCustomData()
Returns custom data
- getCustomData
- in file classes.php, method ThemeObject::getCustomData()
returns the custom data field
- getCustomData
- in file class-comment.php, method Comment::getCustomData()
Returns the custom data field of the comment
- getCustomImage
- in file class-video.php, method Video::getCustomImage()
Get a custom sized version of this image based on the parameters.
- getCustomImage
- in file class-image.php, method _Image::getCustomImage()
Get a custom sized version of this image based on the parameters.
- getDateTime
- in file lib-auth.php, method Zenphoto_Administrator::getDateTime()
Returns the unformatted date
- getDateTime
- in file classes.php, method ThemeObject::getDateTime()
Returns the unformatted date
- getDateTime
- in file class-comment.php, method Comment::getDateTime()
returns the comment date/time
- getDefaultTitle
- in file class-image.php, method _Image::getDefaultTitle()
- getDesc
- in file classes.php, method MediaObject::getDesc()
Returns the description
- getDesc
- in file class-gallery.php, method Gallery::getDesc()
Returns the gallery description
- getEmail
- in file class-comment.php, method Comment::getEmail()
returns the email address of the commentor
- getEmail
- in file lib-auth.php, method Zenphoto_Administrator::getEmail()
Returns the user email
- getExpireDate
- in file classes.php, method MediaObject::getExpireDate()
Returns the expire date
- getFileName
- in file class-image.php, method _Image::getFileName()
Returns the image filename
- getFolder
- in file class-album.php, method Album::getFolder()
Returns the folder on the filesystem
- getFullImage
- in file class-image.php, method _Image::getFullImage()
Returns a path to the original image in the original folder.
- getGalleryPage
- in file class-album.php, method Album::getGalleryPage()
Returns the page number in the gallery of this album
- getGallerySession
- in file class-gallery.php, method Gallery::getGallerySession()
Option of for gallery sessions
- getGroup
- in file lib-auth.php, method Zenphoto_Administrator::getGroup()
Returns user's group
- getHeight
- in file class-image.php, method _Image::getHeight()
Returns the height of the image
- getHitcounter
- in file classes.php, method ThemeObject::getHitcounter()
Returns the hitcount
- getHitcounter
- in file class-gallery.php, method Gallery::getHitcounter()
Returns the hitcount
- getID
- in file classes.php, method PersistentObject::getID()
Returns the id
- getID
- in file lib-auth.php, method Zenphoto_Administrator::getID()
- GETID3_INCLUDEPATH
- in file class-video.php, constant GETID3_INCLUDEPATH
- getImage
- in file class-search.php, method SearchEngine::getImage()
Returns a specific image
- getImage
- in file class-album.php, method Album::getImage()
Returns an image from the album based on the index passed.
- getImageFootprint
- in file class-image.php, method _Image::getImageFootprint()
Returns the disk size of the image
- getImageIndex
- in file class-search.php, method SearchEngine::getImageIndex()
Returns the index of this image in the search images
- getImageLink
- in file class-image.php, method _Image::getImageLink()
Returns an image page link for the image
- getImagePublish
- in file class-gallery.php, method Gallery::getImagePublish()
- getImages
- in file class-search.php, method SearchEngine::getImages()
Returns an array of images found in the search It will return a "page's worth" if $page is non zero
- getImages
- in file class-album.php, method Album::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.
- getImageSortKey
- in file class-album.php, method Album::getImageSortKey()
Returns the DB key associated with the image sort type
- getIndex
- in file class-image.php, method _Image::getIndex()
Get the index of this image in the album, taking sorting into account.
- getInModeration
- in file class-comment.php, method Comment::getInModeration()
Returns true if the comment is marked for moderation
- getIP
- in file class-comment.php, method Comment::getIP()
Returns the IP address of the comment poster
- getIPTCTag
- in file class-image.php, method _Image::getIPTCTag()
For internal use--fetches a single tag from IPTC data
- getIPTCTagArray
- in file class-image.php, method _Image::getIPTCTagArray()
For internal use--fetches the IPTC array for a single tag.
- getLanguage
- in file lib-auth.php, method Zenphoto_Administrator::getLanguage()
Returns the user's prefered language
- getLastLogon
- in file lib-auth.php, method Zenphoto_Administrator::getLastLogon()
returns the last time the user has logged on
- getLocation
- in file class-album.php, method Album::getLocation()
Returns the place data of an album
- getLocation
- in file class-image.php, method _Image::getLocation()
Returns the location field of the image
- getMetaData
- in file class-image.php, method _Image::getMetaData()
Returns an array of EXIF data
- getName
- in file lib-auth.php, method Zenphoto_Administrator::getName()
Returns the user name
- getName
- in file class-comment.php, method Comment::getName()
Returns the commentor's name
- getNextAlbum
- in file class-search.php, method SearchEngine::getNextAlbum()
Returns the album following the current one
- getNextAlbum
- in file class-album.php, method Album::getNextAlbum()
Returns the album following the current album
- getNextImage
- in file class-image.php, method _Image::getNextImage()
Returns the next Image.
- getNumAlbums
- in file class-gallery.php, method Gallery::getNumAlbums()
Returns the total number of TOPLEVEL albums in the gallery (does not include sub-albums)
- getNumAlbums
- in file class-album.php, method Album::getNumAlbums()
Returns the count of subalbums
- getNumAlbums
- in file class-search.php, method SearchEngine::getNumAlbums()
Returns the number of albums found in a search
- getNumComments
- in file class-gallery.php, method Gallery::getNumComments()
Returns the count of comments
- getNumImages
- in file class-gallery.php, method Gallery::getNumImages()
Returns the number of images from a database Ideally one should call garbageCollect() before to make sure the database is current.
- getNumImages
- in file class-album.php, method Album::getNumImages()
Returns the number of images in this album (not counting its subalbums)
- getNumImages
- in file class-search.php, method SearchEngine::getNumImages()
Returns the number of images found in the search
- getObjects
- in file lib-auth.php, method Zenphoto_Administrator::getObjects()
Saves local copy of managed objects.
- getOptionsSupported
- in file lib-auth.php, method Zenphoto_Authority::getOptionsSupported()
Declares options used by lib-auth
- getOptionsSupported
- in file class-video.php, method VideoObject_Options::getOptionsSupported()
Standard option interface
- getOwner
- in file class-album.php, method Album::getOwner()
Owner functions
- getOwner
- in file class-image.php, method _Image::getOwner()
Owner functions
- getOwnerID
- in file class-comment.php, method Comment::getOwnerID()
Returns the id of the comment owner
- getParent
- in file class-album.php, method Album::getParent()
Returns The parent Album of this Album. NULL if this is a top-level album.
- getParentID
- in file classes.php, method ThemeObject::getParentID()
Returns the partent id
- getPass
- in file lib-auth.php, method Zenphoto_Administrator::getPass()
Returns stored password hash
- getPassword
- in file classes.php, method MediaObject::getPassword()
Returns the password
- getPassword
- in file class-gallery.php, method Gallery::getPassword()
Returns the hashed password for guest gallery access
- getPasswordHint
- in file class-gallery.php, method Gallery::getPasswordHint()
Returns the hind associated with the gallery password
- getPasswordHint
- in file classes.php, method MediaObject::getPasswordHint()
Returns the password hint
- getPersistentArchive
- in file class-gallery.php, method Gallery::getPersistentArchive()
Option of caching Album ZIP files
- getPrevAlbum
- in file class-album.php, method Album::getPrevAlbum()
Returns the album prior to the current album
- getPrevAlbum
- in file class-search.php, method SearchEngine::getPrevAlbum()
Returns the album preceding the current one
- getPrevImage
- in file class-image.php, method _Image::getPrevImage()
Return the previous Image
- getPrivate
- in file class-comment.php, method Comment::getPrivate()
Returns true if the comment is flagged private
- getPublishDate
- in file classes.php, method MediaObject::getPublishDate()
Returns the publish date
- getQuota
- in file lib-auth.php, method Zenphoto_Administrator::getQuota()
Returns the users quota
- getResetTicket
- in file lib-auth.php, method Zenphoto_Authority::getResetTicket()
- getRights
- in file lib-auth.php, method Zenphoto_Administrator::getRights()
Returns user rights
- getRights
- in file lib-auth.php, method Zenphoto_Authority::getRights()
Returns an array of the rights definitions for $version (default returns current version rights)
- getSearchAlbums
- in file class-search.php, method SearchEngine::getSearchAlbums()
Returns an array of albums found in the search
- getSearchDate
- in file class-search.php, method SearchEngine::getSearchDate()
Returns the search dates variable
- getSearchEngine
- in file class-album.php, method Album::getSearchEngine()
Returns the search engine for a dynamic album
- getSearchFieldList
- in file class-search.php, method SearchEngine::getSearchFieldList()
Returns a list of search fields display names indexed by the search mask
- getSearchFields
- in file class-search.php, method SearchEngine::getSearchFields()
Returns the search fields variable
- getSearchFieldsText
- in file class-search.php, method SearchEngine::getSearchFieldsText()
Returns the "searchstring" element of a query parameter set
- getSearchImages
- in file class-search.php, method SearchEngine::getSearchImages()
Returns an array of image names found in the search
- getSearchNews
- in file class-search.php, method SearchEngine::getSearchNews()
Returns a list of News Titlelinks found in the search
- getSearchPages
- in file class-search.php, method SearchEngine::getSearchPages()
Returns a list of Pages Titlelinks found in the search
- getSearchParams
- in file class-album.php, method Album::getSearchParams()
Returns the search parameters for a dynamic album
- getSearchParams
- in file class-search.php, method SearchEngine::getSearchParams()
creates a search query from the search words
- getSearchString
- in file class-search.php, method SearchEngine::getSearchString()
Parses a search string Items within quotations are treated as atomic AND, OR and NOT are converted to &, |, and !
- getSearchWords
- in file class-search.php, method SearchEngine::getSearchWords()
Returns the search words variable
- getSecondLevelThumbs
- in file class-gallery.php, method Gallery::getSecondLevelThumbs()
Option to show subalbum images in the thumbnail selector
- getSecurity
- in file class-gallery.php, method Gallery::getSecurity()
Option to allow only registered users view the site
- getShow
- in file classes.php, method ThemeObject::getShow()
Returns true published
- getSizedImage
- in file class-video.php, method Video::getSizedImage()
(non-PHPdoc)
- getSizedImage
- in file class-image.php, method _Image::getSizedImage()
Returns a path to a sized version of the image
- getSortDirection
- in file class-album.php, method Album::getSortDirection()
Returns either the subalbum sort direction or the image sort direction of the album
- getSortDirection
- in file class-gallery.php, method Gallery::getSortDirection()
- getSortOrder
- in file classes.php, method MediaObject::getSortOrder()
Returns the sort order
- getSortType
- in file class-gallery.php, method Gallery::getSortType()
- getSortType
- in file class-album.php, method Album::getSortType()
Returns the sort type of the album images Will return a parent sort type if the sort type for this album is empty
- getState
- in file class-image.php, method _Image::getState()
Returns the state field of the image
- getTags
- in file classes.php, method ThemeObject::getTags()
Returns the tag data
- getThemes
- in file class-gallery.php, method Gallery::getThemes()
Populates the theme array and returns it. The theme array contains information about all the currently available themes.
- getThumb
- in file class-image.php, method _Image::getThumb()
Get a default-sized thumbnail of this image.
- getThumb
- in file class-video.php, method Video::getThumb()
Get a default-sized thumbnail of this image.
- getThumbCropping
- in file class-image.php, method _Image::getThumbCropping()
Returns an array of cropping parameters. Used as a "helper" function for various inherited getThumb() methods
- getThumbImageFile
- in file class-image.php, method _Image::getThumbImageFile()
Returns the image file name for the thumbnail image.
- getThumbImageFile
- in file class-video.php, method Video::getThumbImageFile()
Returns the image file name for the thumbnail image.
- getThumbSelectImages
- in file class-gallery.php, method Gallery::getThumbSelectImages()
Option to show images in the thumbnail selector
- getTitle
- in file class-gallery.php, method Gallery::getTitle()
Returns the gallery title
- getTitle
- in file classes.php, method ThemeObject::getTitle()
Returns the title
- getType
- in file class-comment.php, method Comment::getType()
Returns the 'type' of the comment. i.e. the class of the owner object
- getUpdatedDate
- in file class-album.php, method Album::getUpdatedDate()
- getUser
- in file class-gallery.php, method Gallery::getUser()
- getUser
- in file classes.php, method MediaObject::getUser()
Returns the guest user
- getUser
- in file lib-auth.php, method Zenphoto_Administrator::getUser()
Returns user's user id
- getUserLogonField
- in file class-gallery.php, method Gallery::getUserLogonField()
Option to expose the user field on logon forms
- getValid
- in file lib-auth.php, method Zenphoto_Administrator::getValid()
Returns the valid flag
- getVersion
- in file lib-auth.php, method Zenphoto_Authority::getVersion()
- getWatermark
- in file class-album.php, method Album::getWatermark()
returns the album watermark
- getWatermark
- in file class-image.php, method _Image::getWatermark()
Returns the custom watermark name
- getWatermarkThumb
- in file class-album.php, method Album::getWatermarkThumb()
Returns the album watermark thumb
- getWebsite
- in file class-comment.php, method Comment::getWebsite()
returns the Website of the commentor
- getWebsiteTitle
- in file class-gallery.php, method Gallery::getWebsiteTitle()
Title to be used for the home (not Zenphoto gallery) WEBsite
- getWebsiteURL
- in file class-gallery.php, method Gallery::getWebsiteURL()
The URL of the home (not Zenphoto gallery) WEBsite
- getWidth
- in file class-image.php, method _Image::getWidth()
Returns the width of the image
- getWMUse
- in file class-image.php, method _Image::getWMUse()
Returns the custom watermark usage
i
- $id
- in file classes.php, variable PersistentObject::$id
- $images
- in file class-album.php, variable Album::$images
- $images
- in file class-search.php, variable SearchEngine::$images
- $index
- in file class-album.php, variable Album::$index
- $index
- in file class-image.php, variable _Image::$index
- $iteration
- in file class-search.php, variable SearchEngine::$iteration
- IMAGE_SORT_DIRECTION
- in file class-album.php, constant IMAGE_SORT_DIRECTION
- IMAGE_SORT_TYPE
- in file class-album.php, constant IMAGE_SORT_TYPE
- isDynamic
- in file class-album.php, method Album::isDynamic()
Returns true if the album is "dynamic"
- isImageClass
- in file class-image.php, function isImageClass()
Returns true if the object is a zenphoto 'image'
- isMyItem
- in file class-image.php, method _Image::isMyItem()
- isMyItem
- in file classes.php, method ThemeObject::isMyItem()
Checks basic access rights of an object
- isMyItem
- in file class-album.php, method Album::isMyItem()
checks access to the album
- isProtected
- in file class-gallery.php, method Gallery::isProtected()
returns true if there is any protection on the gallery
- isProtected
- in file class-album.php, method Album::isProtected()
returns true if there is any protection on the album
- isProtected
- in file class-image.php, method _Image::isProtected()
returns true if there is any protection on the image
- isUnprotectedPage
- in file class-gallery.php, method Gallery::isUnprotectedPage()
Tests if a page is excluded from password protection
m
- $manage_rights
- in file class-image.php, variable _Image::$manage_rights
- $manage_rights
- in file class-album.php, variable Album::$manage_rights
- $manage_rights
- in file classes.php, variable ThemeObject::$manage_rights
- $manage_some_rights
- in file classes.php, variable ThemeObject::$manage_some_rights
- $manage_some_rights
- in file class-image.php, variable _Image::$manage_some_rights
- $manage_some_rights
- in file class-album.php, variable Album::$manage_some_rights
- $master
- in file lib-auth.php, variable Zenphoto_Administrator::$master
- $master_user
- in file lib-auth.php, variable Zenphoto_Authority::$master_user
- $msg
- in file lib-auth.php, variable Zenphoto_Administrator::$msg
- MediaObject
- in file classes.php, class MediaObject
Root class for images and albums
- migrateAuth
- in file lib-auth.php, method Zenphoto_Authority::migrateAuth()
Migrates credentials
- move
- in file classes.php, method PersistentObject::move()
Change one or more values of the unique set assigned to this record.
- moveAlbum
- in file class-album.php, method Album::moveAlbum()
Move this album to the location specified by $newfolder, copying all metadata, subalbums, and subalbums' metadata with it.
- moveImage
- in file class-image.php, method _Image::moveImage()
Moves an image to a new album and/or filename (rename).
o
- $objects
- in file lib-auth.php, variable Zenphoto_Administrator::$objects
This is a simple class so that we have a convienient "handle" for manipulating Administrators.
- $objectsThumb
- in file class-image.php, variable _Image::$objectsThumb
- OBJECT_CACHE_DEPTH
- in file classes.php, constant OBJECT_CACHE_DEPTH
***************************************************************************** ****************************************************************************** Persistent Object Class *****************************************************
p
- $page
- in file class-search.php, variable SearchEngine::$page
- $parent
- in file class-album.php, variable Album::$parent
- $parentalbum
- in file class-album.php, variable Album::$parentalbum
- $preferred_version
- in file lib-auth.php, variable Zenphoto_Authority::$preferred_version
- $processed_search
- in file class-search.php, variable SearchEngine::$processed_search
- parseQueryFields
- in file class-search.php, method SearchEngine::parseQueryFields()
Returns the set of fields from the url query/post
- passwordHash
- in file lib-auth.php, method Zenphoto_Authority::passwordHash()
Returns the hash of the zenphoto password
- passwordNote
- in file lib-auth.php, method Zenphoto_Authority::passwordNote()
Returns text describing password constraints
- PersistentObject
- in file classes.php, method PersistentObject::PersistentObject()
Prime instantiator for Zenphoto objects
- PersistentObject
- in file classes.php, class PersistentObject
- preLoad
- in file class-album.php, method Album::preLoad()
Simply creates objects of all the images and sub-albums in this album to load accurate values into the database.
- printLoginForm
- in file lib-auth.php, method Zenphoto_Authority::printLoginForm()
Print the login form for ZP. This will take into account whether mod_rewrite is enabled or not.
r
- $rightsset
- in file lib-auth.php, variable Zenphoto_Authority::$rightsset
- remove
- in file class-album.php, method Album::remove()
Delete the entire album PERMANENTLY. Be careful! This is unrecoverable.
- remove
- in file lib-auth.php, method Zenphoto_Administrator::remove()
Removes a user from the system
- remove
- in file class-image.php, method _Image::remove()
Permanently delete this image (permanent: be careful!)
- remove
- in file classes.php, method PersistentObject::remove()
Deletes object from the database
- rename
- in file class-image.php, method _Image::rename()
Renames an image to a new filename, keeping it in the same album. Convenience for moveImage($image->album, $newfilename).
- rename
- in file class-album.php, method Album::rename()
Rename this album folder. Alias for moveAlbum($newfoldername);
s
- $searchengine
- in file class-album.php, variable Album::$searchengine
- $searches
- in file class-search.php, variable SearchEngine::$searches
- $search_no_albums
- in file class-search.php, variable SearchEngine::$search_no_albums
- $search_no_images
- in file class-search.php, variable SearchEngine::$search_no_images
- $search_no_news
- in file class-search.php, variable SearchEngine::$search_no_news
- $search_no_pages
- in file class-search.php, variable SearchEngine::$search_no_pages
- $search_structure
- in file class-search.php, variable SearchEngine::$search_structure
- $sidecars
- in file class-album.php, variable Album::$sidecars
- $sidecars
- in file class-image.php, variable _Image::$sidecars
- $sortorder
- in file class-image.php, variable _Image::$sortorder
- $subalbums
- in file class-album.php, variable Album::$subalbums
- $subrights
- in file class-album.php, variable Album::$subrights
- $supports_version
- in file lib-auth.php, variable Zenphoto_Authority::$supports_version
- save
- in file class-gallery.php, method Gallery::save()
- save
- in file lib-auth.php, method Zenphoto_Administrator::save()
Uptates the database with all changes
- save
- in file classes.php, method PersistentObject::save()
Save the updates made to this object since the last update. Returns true if successful, false if not.
- searchDate
- in file class-search.php, method SearchEngine::searchDate()
returns the results of a date search
- SearchEngine
- in file class-search.php, class SearchEngine
- searchFieldsAndTags
- in file class-search.php, method SearchEngine::searchFieldsAndTags()
Searches the table for tags Returns an array of database records.
- SEARCH_CACHE_DURATION
- in file class-search.php, constant SEARCH_CACHE_DURATION
- SEARCH_DURATION
- in file class-search.php, constant SEARCH_DURATION
- search_quote
- in file class-search.php, function search_quote()
encloses search word in quotes if needed
- set
- in file class-gallery.php, method Gallery::set()
- set
- in file classes.php, method 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.
- setAlbum
- in file lib-auth.php, method Zenphoto_Administrator::setAlbum()
Records the "prime album" of a user. Prime albums are linked to the user and removed if the user is removed.
- setAlbumPublish
- in file class-gallery.php, method Gallery::setAlbumPublish()
- setAlbumTheme
- in file class-album.php, method Album::setAlbumTheme()
Sets the theme of the album
- setAlbumThumb
- in file class-album.php, method Album::setAlbumThumb()
Stores the thumbnail path for an album thumg
- setAlbumUseImagedate
- in file class-gallery.php, method Gallery::setAlbumUseImagedate()
- setAnon
- in file class-comment.php, method Comment::setAnon()
Sets the anonymous flag of the comment
- setChallengePhraseInfo
- in file lib-auth.php, method Zenphoto_Administrator::setChallengePhraseInfo()
- setCity
- in file class-image.php, method _Image::setCity()
Stores the city field of the image
- setCodeblock
- in file classes.php, method ThemeObject::setCodeblock()
set the codeblocks as an serialized array
- setCodeblock
- in file class-gallery.php, method Gallery::setCodeblock()
set the codeblocks as an serialized array
- setComment
- in file class-comment.php, method Comment::setComment()
Stores the comment text
- setCommentsAllowed
- in file classes.php, method ThemeObject::setCommentsAllowed()
Sets the comments allowed flag
- setCopyright
- in file class-image.php, method _Image::setCopyright()
Stores the text for the copyright field of the image
- setCountry
- in file class-image.php, method _Image::setCountry()
Stores the country field of the image
- setCredentials
- in file lib-auth.php, method Zenphoto_Administrator::setCredentials()
- setCredit
- in file class-image.php, method _Image::setCredit()
Stores the credit field of the image
- setCurrentTheme
- in file class-gallery.php, method Gallery::setCurrentTheme()
Sets the current theme
- setCustomData
- in file class-comment.php, method Comment::setCustomData()
Stores the custom data field of the comment
- setCustomData
- in file classes.php, method ThemeObject::setCustomData()
Sets the custom data field
- setCustomData
- in file lib-auth.php, method Zenphoto_Administrator::setCustomData()
Stores custom data
- setDateTime
- in file lib-auth.php, method Zenphoto_Administrator::setDateTime()
Stores the date
- setDateTime
- in file classes.php, method ThemeObject::setDateTime()
Stores the date
- setDateTime
- in file class-comment.php, method Comment::setDateTime()
Sets a comment date/time value
- setDefaults
- in file class-album.php, method Album::setDefaults()
Sets default values for a new album
- setDefaults
- in file class-comment.php, method Comment::setDefaults()
Sets up default items on new comment objects
- setDefaults
- in file classes.php, method PersistentObject::setDefaults()
Sets default values for new objects using the set() method.
- setDesc
- in file classes.php, method MediaObject::setDesc()
Stores the description
- setEmail
- in file lib-auth.php, method Zenphoto_Administrator::setEmail()
Stores the user email
- setEmail
- in file class-comment.php, method Comment::setEmail()
Sets the email address of the commentor
- setExpireDate
- in file classes.php, method MediaObject::setExpireDate()
sets the expire date
- setGallerySession
- in file class-gallery.php, method Gallery::setGallerySession()
- setGroup
- in file lib-auth.php, method Zenphoto_Administrator::setGroup()
Sets the user's group.
- setImagePublish
- in file class-gallery.php, method Gallery::setImagePublish()
- setInModeration
- in file class-comment.php, method Comment::setInModeration()
Sets the moderation flag of the comment
- setIP
- in file class-comment.php, method Comment::setIP()
Sets the IP address field of the comment
- setLanguage
- in file lib-auth.php, method Zenphoto_Administrator::setLanguage()
Sets the user's preferec language
- setLocation
- in file class-album.php, method Album::setLocation()
Stores the album place
- setLocation
- in file class-image.php, method _Image::setLocation()
Stores the location field of the image
- setName
- in file lib-auth.php, method Zenphoto_Administrator::setName()
Stores the user name
- setName
- in file class-comment.php, method Comment::setName()
Sets the commentor's name
- setObjects
- in file lib-auth.php, method Zenphoto_Administrator::setObjects()
Returns local copy of managed objects.
- setOwner
- in file class-album.php, method Album::setOwner()
- setOwner
- in file class-image.php, method _Image::setOwner()
- setOwnerID
- in file class-comment.php, method Comment::setOwnerID()
Sets the id of the owner of the comment
- setParentID
- in file classes.php, method ThemeObject::setParentID()
Sets the ParentID field
- setPass
- in file lib-auth.php, method Zenphoto_Administrator::setPass()
Hashes and stores the password
- setPassword
- in file classes.php, method MediaObject::setPassword()
Sets the encrypted password
- setPassword
- in file class-gallery.php, method Gallery::setPassword()
- setPasswordHint
- in file classes.php, method MediaObject::setPasswordHint()
Sets the password hint
- setPasswordHint
- in file class-gallery.php, method Gallery::setPasswordHint()
- setPersistentArchive
- in file class-gallery.php, method Gallery::setPersistentArchive()
- setPrivate
- in file class-comment.php, method Comment::setPrivate()
Sets the private flag of the comment
- setPublishDate
- in file classes.php, method MediaObject::setPublishDate()
sets the publish date
- setQuota
- in file lib-auth.php, method Zenphoto_Administrator::setQuota()
Sets the users quota
- setRights
- in file lib-auth.php, method Zenphoto_Administrator::setRights()
Stores user rights
- setSearchParams
- in file class-search.php, method SearchEngine::setSearchParams()
Parses and stores a search string NOTE!! this function assumes that the 'words' part of the list has been urlencoded!!!
- setSearchParams
- in file class-album.php, method Album::setSearchParams()
Sets the search parameters of a dynamic album
- setSecondLevelThumbs
- in file class-gallery.php, method Gallery::setSecondLevelThumbs()
- setSecurity
- in file class-gallery.php, method Gallery::setSecurity()
- setShow
- in file classes.php, method ThemeObject::setShow()
Stores the published value
- setSortDirection
- in file class-gallery.php, method Gallery::setSortDirection()
- setSortDirection
- in file class-album.php, method Album::setSortDirection()
sets sort directions for the album
- setSortOrder
- in file classes.php, method MediaObject::setSortOrder()
Stores the sort order
- setSortType
- in file class-album.php, method Album::setSortType()
Stores the sort type for the album
- setSortType
- in file class-gallery.php, method Gallery::setSortType()
- setState
- in file class-image.php, method _Image::setState()
Stores the state field of the image
- setSubalbumSortType
- in file class-album.php, method Album::setSubalbumSortType()
Stores the subalbum sort type for this abum
- setTags
- in file classes.php, method ThemeObject::setTags()
Stores tag information
- setThumbSelectImages
- in file class-gallery.php, method Gallery::setThumbSelectImages()
- setTitle
- in file classes.php, method ThemeObject::setTitle()
Stores the title
- setType
- in file class-comment.php, method Comment::setType()
Sets the 'type' field of the comment
- setUnprotectedPage
- in file class-gallery.php, method Gallery::setUnprotectedPage()
- setUpdatedDate
- in file class-album.php, method Album::setUpdatedDate()
- setUser
- in file classes.php, method MediaObject::setUser()
Sets the guest user
- setUser
- in file class-gallery.php, method Gallery::setUser()
- setUser
- in file lib-auth.php, method Zenphoto_Administrator::setUser()
Sets the user's user id
- setUserLogonField
- in file class-gallery.php, method Gallery::setUserLogonField()
- setValid
- in file lib-auth.php, method Zenphoto_Administrator::setValid()
Sets the "valid" flag. Valid is 1 for users, 0 for groups and templates
- setWatermark
- in file class-album.php, method Album::setWatermark()
Sets the album watermark
- setWatermark
- in file class-image.php, method _Image::setWatermark()
Set custom watermark
- setWatermarkThumb
- in file class-album.php, method Album::setWatermarkThumb()
Sets the custom watermark usage
- setWebsite
- in file class-comment.php, method Comment::setWebsite()
Stores the website of the commentor
- setWebsiteTitle
- in file class-gallery.php, method Gallery::setWebsiteTitle()
- setWebsiteURL
- in file class-gallery.php, method Gallery::setWebsiteURL()
- setWMUse
- in file class-image.php, method _Image::setWMUse()
Sets the custom watermark usage
- sizeOfCache
- in file class-gallery.php, method Gallery::sizeOfCache()
Returns the size in bytes of the cache folder. WARNING: VERY SLOW.
- sizeOfImages
- in file class-gallery.php, method Gallery::sizeOfImages()
Returns the size in bytes of the albums folder. WARNING: VERY SLOW.
- sortAlbumArray
- in file class-gallery.php, method Gallery::sortAlbumArray()
Sort the album array based on either according to the sort key.
- sortImageArray
- in file class-album.php, method Album::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.
- subsetNewsCategories
- in file class-search.php, method SearchEngine::subsetNewsCategories()
Returns an array of News article IDs belonging to the search categories
|
|