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

Element index for package functions

Package indexes

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ j ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ w ] [ x ] [ z ]

a

a

accessAllAlbums
in file functions-basic.php, function accessAllAlbums()
    Checks access for the album root
addPluginType
in file functions.php, function addPluginType()
    Registers a plugin as handler for a file extension
add_context
in file functions.php, function add_context()
ALBUM
in file template-functions.php, constant ALBUM
albumNumber
in file template-functions.php, function albumNumber()
    Gets the 'n' for n of m albums
ALBUM_FOLDER_EMPTY
in file functions-basic.php, constant ALBUM_FOLDER_EMPTY
ALBUM_FOLDER_SERVERPATH
in file functions-basic.php, constant ALBUM_FOLDER_SERVERPATH
ALBUM_FOLDER_WEBPATH
in file functions-basic.php, constant ALBUM_FOLDER_WEBPATH
assert_handler
in file functions-basic.php, function assert_handler()
    Emits an assertion error
b

b

byteConvert
in file functions.php, function byteConvert()
    Returns a byte size from a size value (eg: 100M).
c

c

checkAccess
in file template-functions.php, function checkAccess()
    Checks to see if a password is needed
checkAlbumPassword
in file functions.php, function checkAlbumPassword()
    Checks to see access is allowed to an album Returns true if access is allowed.
checkForGuest
in file template-functions.php, function checkForGuest()
    returns the auth type of a guest login
checkInstall
in file functions-basic.php, function checkInstall()
    Check to see if the setup script needs to be run
checkObjectsThumb
in file functions.php, function checkObjectsThumb()
    Search for a thumbnail for the image
checkPublishDates
in file functions.php, function checkPublishDates()
    checks if the item has expired
CHMOD_VALUE
in file functions-basic.php, constant CHMOD_VALUE
clearRSSCache
in file functions-rss.php, function clearRSSCache()
    Cleans out the RSS cache folder
commentsAllowed
in file functions.php, function commentsAllowed()
    Returns true if all the right conditions are set to allow comments for the $type
COMMENT_BODY_REQUIRED
in file functions.php, constant COMMENT_BODY_REQUIRED
COMMENT_EMAIL_REQUIRED
in file functions.php, constant COMMENT_EMAIL_REQUIRED
COMMENT_NAME_REQUIRED
in file functions.php, constant COMMENT_NAME_REQUIRED
COMMENT_SEND_EMAIL
in file functions.php, constant COMMENT_SEND_EMAIL
COMMENT_WEB_REQUIRED
in file functions.php, constant COMMENT_WEB_REQUIRED
COOKIE_PESISTENCE
in file functions-basic.php, constant COOKIE_PESISTENCE
cron_starter
in file functions.php, function cron_starter()
    Starts a sechedule script run
d

d

dateTimeConvert
in file functions.php, function dateTimeConvert()
    Converts a datetime to connoical form
DATE_FORMAT
in file functions-basic.php, constant DATE_FORMAT
db_count
in file functions-basic.php, function db_count()
db_name
in file functions-basic.php, function db_name()
debug404
in file functions.php, function debug404()
    produce debugging information on 404 errors
debugLog
in file functions-basic.php, function debugLog()
    Write output to the debug log Use this for debugging when echo statements would come before headers are sent or would create havoc in the HTML.
debugLogArray
in file functions-basic.php, function debugLogArray()
    "print_r" equivalent for the debug log
debugLogBacktrace
in file functions-basic.php, function debugLogBacktrace()
    Logs the calling stack
debugLogVar
in file functions-basic.php, function debugLogVar()
    Records a Var to the debug log
dircopy
in file functions.php, function dircopy()
    Copies a directory recursively
dirsize
in file functions.php, function dirsize()
    Get the size of a directory.
e

e

endRSSCache
in file functions-rss.php, function endRSSCache()
    Ends the static RSS caching.
exposeZenPhotoInformations
in file template-functions.php, function exposeZenPhotoInformations()
    Expose some informations in a HTML comment
f

f

fetchComments
in file functions.php, function fetchComments()
    Gets an array of comments for the current admin
filesystemToInternal
in file functions-basic.php, function filesystemToInternal()
    Converts a file system filename to UTF-8 for zenphoto internal storage
FILESYSTEM_CHARSET
in file functions-basic.php, constant FILESYSTEM_CHARSET
filterImageQuery
in file template-functions.php, function filterImageQuery()
    performs a query and then filters out "illegal" images returning the first "good" image used by the random image functions.
FULLIMAGE_WATERMARK
in file functions-basic.php, constant FULLIMAGE_WATERMARK
FULLWEBPATH
in file functions-basic.php, constant FULLWEBPATH
functions-basic.php
procedural page functions-basic.php
functions-filter.php
procedural page functions-filter.php
functions-rss.php
procedural page functions-rss.php
functions.php
procedural page functions.php
g

g

galleryAlbumsPerPage
in file functions.php, function galleryAlbumsPerPage()
    Returns the number of album thumbs that go on a gallery page
GALLERY_DATA
in file functions-basic.php, constant GALLERY_DATA
GALLERY_SECURITY
in file functions-basic.php, constant GALLERY_SECURITY
GALLERY_SESSION
in file functions-basic.php, constant GALLERY_SESSION
generateListFromArray
in file functions.php, function generateListFromArray()
    Creates the body of a select list
generateListFromFiles
in file functions.php, function generateListFromFiles()
    Generates a selection list from files found on disk
getAlbumArray
in file functions-basic.php, function getAlbumArray()
    getAlbumArray - returns an array of folder names corresponding to the given album string.
getAlbumCustomData
in file template-functions.php, function getAlbumCustomData()
    Returns the custom_data field of the current album
getAlbumData
in file template-functions.php, function getAlbumData()
    A composit for getting album data
getAlbumDate
in file template-functions.php, function getAlbumDate()
    Returns the formatted date field of the album
getAlbumDesc
in file template-functions.php, function getAlbumDesc()
    Returns the raw description of the current album.
getAlbumFolder
in file functions-basic.php, function getAlbumFolder()
    Returns the fully qualified path to the album folders
getAlbumId
in file template-functions.php, function getAlbumId()
    Returns the record number of the album in the database
getAlbumInherited
in file functions-basic.php, function getAlbumInherited()
    returns the non-empty value of $field from the album or one of its parents
getAlbumLinkURL
in file template-functions.php, function getAlbumLinkURL()
    Returns the album link url of the current album.
getAlbumLocation
in file template-functions.php, function getAlbumLocation()
    Returns the Location of the album.
getAlbumPage
in file template-functions.php, function getAlbumPage()
    Returns the album page number of the current image
getAlbumThumb
in file template-functions.php, function getAlbumThumb()
    Returns the name of the defined album thumbnail image.
getAlbumTitle
in file template-functions.php, function getAlbumTitle()
    Returns the raw title of the current album.
getAllAlbums
in file template-functions.php, function getAllAlbums()
    Returns a list of all albums decendent from an album
getAllDates
in file template-functions.php, function getAllDates()
    Retrieves a list of all unique years & months from the images in the gallery
getAllowedTags
in file functions-basic.php, function getAllowedTags()
    Returns an array of html tags allowed
getAllSubAlbumIDs
in file functions.php, function getAllSubAlbumIDs()
    Returns an array of album ids whose parent is the folder
getAllTagsCount
in file functions.php, function getAllTagsCount()
    Returns an array indexed by 'tag' with the element value the count of the tag
getAllTagsUnique
in file functions.php, function getAllTagsUnique()
    Returns an array of unique tag names
getAnnotatedAlbumTitle
in file template-functions.php, function getAnnotatedAlbumTitle()
    Returns an album title taged with of Not visible or password protected status
getAnnotatedImageTitle
in file template-functions.php, function getAnnotatedImageTitle()
    Returns the image title taged with not visible annotation.
getBareAlbumDesc
in file template-functions.php, function getBareAlbumDesc()
    Returns a text-only description of the current album.
getBareAlbumTitle
in file template-functions.php, function getBareAlbumTitle()
    Returns a text-only title of the current album.
getBareGalleryDesc
in file template-functions.php, function getBareGalleryDesc()
    Returns a text-only description of the gallery.
getBareGalleryTitle
in file template-functions.php, function getBareGalleryTitle()
    Returns a text-only title of the gallery.
getBareImageDesc
in file template-functions.php, function getBareImageDesc()
    Returns a text-only description of the current image.
getBareImageTitle
in file template-functions.php, function getBareImageTitle()
    Returns a text-only title of the current image.
getCodeblock
in file template-functions.php, function getCodeblock()
    Gets the content of a codeblock for an image, album or Zenpage newsarticle or page.
getCommentAuthorEmail
in file template-functions.php, function getCommentAuthorEmail()
    Returns the comment author's email
getCommentAuthorName
in file template-functions.php, function getCommentAuthorName()
    Returns the comment author's name
getCommentAuthorSite
in file template-functions.php, function getCommentAuthorSite()
    Returns the comment author's website
getCommentBody
in file template-functions.php, function getCommentBody()
    Returns the body of the current comment
getCommentCount
in file template-functions.php, function getCommentCount()
    Retuns the count of comments on the current image
getCommentDateTime
in file template-functions.php, function getCommentDateTime()
    Returns a formatted date and time for the comment.
getCommentsAllowed
in file template-functions.php, function getCommentsAllowed()
    Returns true if neither the album nor the image have comments closed
getCommentStored
in file template-functions.php, function getCommentStored()
    Returns the data from the last comment posted
getCurrentPage
in file template-functions.php, function getCurrentPage()
    Returns the number of the current page without printing it.
getCurrentTheme
in file template-functions.php, function getCurrentTheme()
    Returns the name of the currently active theme
getCustomAlbumThumb
in file template-functions.php, function getCustomAlbumThumb()
    Returns a link to a custom sized thumbnail of the current album
getCustomAlbumThumbMaxSpace
in file template-functions.php, function getCustomAlbumThumbMaxSpace()
    Returns a link to a un-cropped custom sized version of the current album thumb within the given height and width dimensions.
getCustomImageURL
in file template-functions.php, function getCustomImageURL()
    Returns the url to the image with the dimensions you define with this function.
getCustomPageURL
in file template-functions.php, function getCustomPageURL()
    Produces the url to a custom page (e.g. one that is not album.php, image.php, or index.php)
getCustomSizedImageMaxSpace
in file template-functions.php, function getCustomSizedImageMaxSpace()
    Returns a link to a un-cropped custom sized version of the current image within the given height and width dimensions.
getCustomSizedImageThumbMaxSpace
in file template-functions.php, function getCustomSizedImageThumbMaxSpace()
    Returns a link to a un-cropped custom sized version of the current image within the given height and width dimensions.
getDefaultHeight
in file template-functions.php, function getDefaultHeight()
    Returns the height of the default-sized image (in printDefaultSizedImage)
getDefaultSizedImage
in file template-functions.php, function getDefaultSizedImage()
    Returns the url to the default sized image.
getDefaultWidth
in file template-functions.php, function getDefaultWidth()
    The width of the default-sized image (in printDefaultSizedImage)
getEnabledPlugins
in file functions.php, function getEnabledPlugins()
    Returns an array of the currently enabled plugins
getFirstImageURL
in file template-functions.php, function getFirstImageURL()
    Returns the url of the first image in current album.
getFullHeight
in file template-functions.php, function getFullHeight()
    Returns the height of the original image
getFullImageURL
in file template-functions.php, function getFullImageURL()
    Returns the url to original image.
getFullWidth
in file template-functions.php, function getFullWidth()
    Returns the width of the original image
getGalleryDesc
in file template-functions.php, function getGalleryDesc()
    Returns the raw description of the gallery.
getGalleryIndexURL
in file template-functions.php, function getGalleryIndexURL()
    Returns the URL of the main gallery page containing the current album
getGalleryTitle
in file template-functions.php, function getGalleryTitle()
    Returns the raw title of the gallery.
getHitcounter
in file template-functions.php, function getHitcounter()
    returns the hitcounter for the current page or for the object passed
getImageCacheFilename
in file functions-basic.php, function getImageCacheFilename()
    Returns the path of an image for uses in caching it NOTE: character set if for the filesystem
getImageCachePostfix
in file functions-basic.php, function getImageCachePostfix()
    Returns the crop/sizing string to postfix to a cache image
getImageCity
in file template-functions.php, function getImageCity()
    Returns the City field of the current image
getImageCountry
in file template-functions.php, function getImageCountry()
    Returns the Country field of the current image
getImageCustomData
in file template-functions.php, function getImageCustomData()
    Returns the custom_data field of the current image
getImageData
in file template-functions.php, function getImageData()
    A composit for getting image data
getImageDate
in file template-functions.php, function getImageDate()
    Returns the image date of the current image in yyyy-mm-dd hh:mm:ss format.
getImageDesc
in file template-functions.php, function getImageDesc()
    Returns the raw description of the current image.
getImageID
in file template-functions.php, function getImageID()
    Get the unique ID of the current image.
getImageLinkURL
in file template-functions.php, function getImageLinkURL()
    Returns the url of the current image.
getImageLocation
in file template-functions.php, function getImageLocation()
    Returns the Location field of the current image
getImageMetaData
in file template-functions.php, function getImageMetaData()
    Returns the Metadata infromation from the current image
getImageParameters
in file functions-basic.php, function getImageParameters()
    Validates and edits image size/cropping parameters
getImageProcessorURI
in file functions-basic.php, function getImageProcessorURI()
    forms the i.php parameter list for an image.
getImageSortOrder
in file template-functions.php, function getImageSortOrder()
    Get the sort order of this image.
getImageState
in file template-functions.php, function getImageState()
    Returns the State field of the current image
getImageThumb
in file template-functions.php, function getImageThumb()
    Returns the url to the thumbnail of the current image.
getImageTitle
in file template-functions.php, function getImageTitle()
    Returns the raw title of the current image.
getLanguageFlag
in file functions.php, function getLanguageFlag()
getLastImageURL
in file template-functions.php, function getLastImageURL()
    Returns the url of the last image in current album.
getLatestComments
in file template-functions.php, function getLatestComments()
    Gets latest comments for images and albums
getMainSiteName
in file template-functions.php, function getMainSiteName()
    Returns the name of the main website as set by the "Website Title" option on the gallery options tab.
getMainSiteURL
in file template-functions.php, function getMainSiteURL()
    Returns the URL of the main website as set by the "Website URL" option on the gallery options tab.
getManagedAlbumList
in file functions.php, function getManagedAlbumList()
    Populates and returns the $_zp_admin_album_list array
getMaxSpaceContainer
in file template-functions.php, function getMaxSpaceContainer()
    Called by ***MaxSpace functions to compute the parameters to be passed to xxCustomyyy functions.
getNextAlbum
in file template-functions.php, function getNextAlbum()
    Returns the next album
getNextAlbumURL
in file template-functions.php, function getNextAlbumURL()
    Get the URL of the next album in the gallery.
getNextImageThumb
in file template-functions.php, function getNextImageThumb()
    Returns the thumbnail of the next image.
getNextImageURL
in file template-functions.php, function getNextImageURL()
    Returns the url of the next image.
getNextPageURL
in file template-functions.php, function getNextPageURL()
    Returns the URL of the next page. Use within If or while loops for pagination.
getNotViewableAlbums
in file functions.php, function getNotViewableAlbums()
    Returns a list of album IDs that the current viewer is allowed to see
getNumAlbums
in file template-functions.php, function getNumAlbums()
    Returns the number of albums.
getNumImages
in file template-functions.php, function getNumImages()
    Returns the number of images in the album.
getOption
in file functions-basic.php, function getOption()
    Get a option stored in the database.
getOptionFromDB
in file functions.php, function getOptionFromDB()
    Gets an option directly from the database.
getOptionList
in file functions-basic.php, function getOptionList()
    Retuns the option array
getPageRedirect
in file template-functions.php, function getPageRedirect()
    Returns a redirection link for the password form
getPageURL
in file template-functions.php, function getPageURL()
    Returns the URL of the page number passed as a parameter
getParentAlbums
in file template-functions.php, function getParentAlbums()
    Returns an array of the names of the parents of the current album.
getPasswordProtectImage
in file template-functions.php, function getPasswordProtectImage()
    Returns an img src link to the password protect thumb substitute
getPlugin
in file functions.php, function getPlugin()
    Returns the fully qualified file name of the plugin file.
getPluginFiles
in file functions.php, function getPluginFiles()
    Returns a consolidated list of plugins The array structure is key=plugin name, value=plugin path
getPrevAlbum
in file template-functions.php, function getPrevAlbum()
    Returns the previous album
getPrevAlbumURL
in file template-functions.php, function getPrevAlbumURL()
    Get the URL of the previous album in the gallery.
getPrevImageThumb
in file template-functions.php, function getPrevImageThumb()
    Returns the thumbnail of the previous image.
getPrevImageURL
in file template-functions.php, function getPrevImageURL()
    Returns the url of the previous image.
getPrevPageURL
in file template-functions.php, function getPrevPageURL()
    Returns the URL of the previous page.
getProtectedImageURL
in file template-functions.php, function getProtectedImageURL()
    Returns an url to the password protected/watermarked current image
getRandomImages
in file template-functions.php, function getRandomImages()
    Returns a randomly selected image from the gallery. (May be NULL if none exists)
getRandomImagesAlbum
in file template-functions.php, function getRandomImagesAlbum()
    Returns a randomly selected image from the album or its subalbums. (May be NULL if none exists)
getRSSAlbumnameAndCollection
in file functions-rss.php, function getRSSAlbumnameAndCollection()
    Returns the albumname and TRUE or FALSE for the collection mode (album + subalbums)
getRSSAlbumsmode
in file functions-rss.php, function getRSSAlbumsmode()
    Returns the albums RSS mode from the feed's url
getRSSAlbumTitle
in file functions-rss.php, function getRSSAlbumTitle()
    Returns the title from the feed's url for latest albums or a specific album rss
getRSSCacheFilename
in file functions-rss.php, function getRSSCacheFilename()
    Gets the RSS file name from the feed url and clears out query items and special chars
getRSSChanneltitle
in file functions-rss.php, function getRSSChanneltitle()
    Returns the rss channel main title part (gallery and/or website title)
getRSSHost
in file functions-rss.php, function getRSSHost()
    Returns the host
getRSSID
in file functions-rss.php, function getRSSID()
    Returns the item id from the feed URL for item specific rss
getRSSImageAndAlbumPaths
in file functions-rss.php, function getRSSImageAndAlbumPaths()
    Returns the image path, album path and modrewrite suffix
getRSSImageSize
in file functions-rss.php, function getRSSImageSize()
    Returns the size of the images to be used in the feed.
getRSSLink
in file template-functions.php, function getRSSLink()
    Prints a RSS link for printRSSLink() and printRSSHeaderLink()
getRSSLocale
in file functions-rss.php, function getRSSLocale()
    Returns the locale of the feed either from the feed's url if passed directly or by standard option
getRSSLocaleXML
in file functions-rss.php, function getRSSLocaleXML()
    Replaces "_" with "-" in the locale for usage in the feed's xml
getRSSNewsCatOptions
in file functions-rss.php, function getRSSNewsCatOptions()
    Returns the News category title or catlink (name) or the mode (all news or category only) for the Zenpage news feed.
getRSSTitle
in file functions-rss.php, function getRSSTitle()
    Returns the title from the feed's url for item specific rss
getRSSType
in file functions-rss.php, function getRSSType()
    Returns the RSS type from the feed's url
getSearchDate
in file template-functions.php, function getSearchDate()
    Returns the date of the search
getSearchURL
in file template-functions.php, function getSearchURL()
    Returns a search URL
getSearchWords
in file template-functions.php, function getSearchWords()
    Returns the a sanitized version of the search string
getSetClause
in file functions-basic.php, function getSetClause()
    Constructs a SET clause ("SET uniqueid1='uniquevalue1', uniqueid2='uniquevalue2' ...") from an array (map) of variables and their values which identifies a unique record in the database table. Used to 'move' records. Note: does not check anything.
getSizeCustomImage
in file template-functions.php, function getSizeCustomImage()
    Returns an array with the height & width
getSizeDefaultImage
in file template-functions.php, function getSizeDefaultImage()
    Returns an array [width, height] of the default-sized image.
getSizedImageURL
in file template-functions.php, function getSizedImageURL()
    Returns a link to the current image custom sized to $size
getSizeFullImage
in file template-functions.php, function getSizeFullImage()
    Returns an array [width, height] of the original image.
getSuffix
in file functions-basic.php, function getSuffix()
    Returns the suffix of a file name
getTableAsoc
in file functions.php, function getTableAsoc()
    Produces the # to table association array
getTags
in file template-functions.php, function getTags()
    Returns a list of tags for either an image or album, depends on the page called from
getTheme
in file template-functions.php, function getTheme()
    Finds the name of the themeColor option selected on the admin options tab Returns a path and name of the theme css file. Returns the value passed for defaultcolor if the theme css option file does not exist.
getThemeOption
in file functions.php, function getThemeOption()
    Returns the value of a theme option
getTinyURL
in file functions.php, function getTinyURL()
    Returns a Zenphoto tiny URL to the object
getTotalImagesIn
in file template-functions.php, function getTotalImagesIn()
    Returns the count of all the images in the album and any subalbums
getTotalPages
in file template-functions.php, function getTotalPages()
    Returns the number of pages for the current object
getUnprotectedImageURL
in file template-functions.php, function getUnprotectedImageURL()
    Returns the "raw" url to the image in the albums folder
getUrAlbum
in file functions.php, function getUrAlbum()
    Returns the oldest ancestor of an alubm;
getURL
in file template-functions.php, function getURL()
    Returns the URL to an image (This is NOT the URL for the image.php page)
getUserIP
in file functions.php, function getUserIP()
    Returns the viewer's IP address Deals with transparent proxies
getVersion
in file template-functions.php, function getVersion()
    Returns the zenphoto version string
getWatermarkParam
in file functions-basic.php, function getWatermarkParam()
    Returns the watermark image to pass to i.php
getWatermarkPath
in file functions-basic.php, function getWatermarkPath()
    Returns the path to a watermark
getWhereClause
in file functions-basic.php, function getWhereClause()
    Constructs a WHERE clause ("WHERE uniqueid1='uniquevalue1' AND uniqueid2='uniquevalue2' ...") from an array (map) of variables and their values which identifies a unique record in the database table.
getXSRFToken
in file functions.php, function getXSRFToken()
    returns an XSRF token
get_context
in file functions.php, function get_context()
GRAPHICS_LIBRARY
in file functions-basic.php, constant GRAPHICS_LIBRARY
h

h

handleSearchParms
in file functions.php, function handleSearchParms()
    recovers search parameters from stored cookie, clears the cookie
hasDynamicAlbumSuffix
in file functions-basic.php, function hasDynamicAlbumSuffix()
    Returns true if the file has the dynamic album suffix
HASH_SEED
in file functions-basic.php, constant HASH_SEED
hasNextImage
in file template-functions.php, function hasNextImage()
    True if there is a next image
hasNextPage
in file template-functions.php, function hasNextPage()
    Returns true if there is a next page
hasPrevImage
in file template-functions.php, function hasPrevImage()
    True if there is a previous image
hasPrevPage
in file template-functions.php, function hasPrevPage()
    Returns TRUE if there is a previous page. Use within If or while loops for pagination.
html_encode
in file functions-basic.php, function html_encode()
    encodes a pre-sanitized string to be used in an HTML text-only field (value, alt, title, etc.)
i

i

IMAGE
in file template-functions.php, constant IMAGE
imageNumber
in file template-functions.php, function imageNumber()
    Returns the 'n' of n of m images
IMAGE_WATERMARK
in file functions-basic.php, constant IMAGE_WATERMARK
imgSrcURI
in file functions-basic.php, function imgSrcURI()
    Returns an img src URI encoded based on the OS of the server
IM_SUFFIX
in file functions-basic.php, constant IM_SUFFIX
instrument
in file functions-basic.php, function instrument()
    Tool to log execution times of script bits
internalToFilesystem
in file functions-basic.php, function internalToFilesystem()
    Converts a Zenphoto Internal filename string to one compatible with the file system
in_context
in file functions.php, function in_context()
IP_TIED_COOKIES
in file functions-basic.php, constant IP_TIED_COOKIES
isAlbumPage
in file template-functions.php, function isAlbumPage()
    Returns true if this page has album thumbs on it
isArchive
in file template-functions.php, function isArchive()
    tests if a search page is an "archive" page
isImagePage
in file template-functions.php, function isImagePage()
    Returns true if this page has image thumbs on it
isImagePhoto
in file functions.php, function isImagePhoto()
    Returns true if the image is a standard photo type
isImageVideo
in file functions.php, function isImageVideo()
    Returns video argument of the current Image.
isLandscape
in file template-functions.php, function isLandscape()
    Returns true if the image is landscape-oriented (width is greater than height)
isValidURL
in file functions.php, function isValidURL()
    Checks to see if a URL is valid
is_connected
in file functions.php, function is_connected()
    Returns true if there is an internet connection
is_valid_email_zp
in file functions.php, function is_valid_email_zp()
    Determines if the input is an e-mail address. Adapted from WordPress.
is_valid_image
in file functions.php, function is_valid_image()
    Returns true if the file is an image
is_valid_other
in file functions-basic.php, function is_valid_other()
    Returns true if the file is a valid 'other' type
is_valid_other_type
in file functions.php, function is_valid_other_type()
    Returns true if the file is handled by a plugin object
j

j

js_encode
in file functions-basic.php, function js_encode()
    encodes a pre-sanitized string to be used as a Javascript parameter
l

l

loadLocalOptions
in file functions-basic.php, function loadLocalOptions()
    Loads option table with album/theme options
LOCAL_CHARSET
in file functions-basic.php, constant LOCAL_CHARSET
logTime
in file functions.php, function logTime()
    Logs a time into the debug log
lookupSortKey
in file functions.php, function lookupSortKey()
    Returns a sort field part for querying Note: $sorttype may be a comma separated list of field names. If so, these are peckmarked and returned otherwise unchanged.
m

m

makeAlbumCurrent
in file template-functions.php, function makeAlbumCurrent()
    Sets the album passed as the current album
makeImageCurrent
in file template-functions.php, function makeImageCurrent()
    Sets the image passed as the current image
makeSpecialImageName
in file functions.php, function makeSpecialImageName()
    Returns an i.php "image name" for an image not within the albums structure
MEMBERS_ONLY_COMMENTS
in file functions-basic.php, constant MEMBERS_ONLY_COMMENTS
mkdir_recursive
in file functions-basic.php, function mkdir_recursive()
    Makes directory recursively, returns TRUE if exists or was created sucessfuly.
MOD_REWRITE
in file functions-basic.php, constant MOD_REWRITE
myts_date
in file functions.php, function myts_date()
    Simple SQL timestamp formatting function.
n

n

next_album
in file template-functions.php, function next_album()
    WHILE next_album(): context switches to Album.
next_comment
in file template-functions.php, function next_comment()
    Iterate through comments; use the ZP_COMMENT context.
next_image
in file template-functions.php, function next_image()
    Returns the next image on a page.
NO_WATERMARK
in file functions-basic.php, constant NO_WATERMARK
o

o

OFFSET_PATH
in file functions-basic.php, constant OFFSET_PATH
openedForComments
in file template-functions.php, function openedForComments()
    Checks to see if comment posting is allowed for an image/album Returns true if comment posting should be allowed
p

p

pageError
in file functions.php, function pageError()
    Emits a page error. Used for attempts to bypass password protection
parseAllowedTags
in file functions.php, function parseAllowedTags()
    parses the allowed HTML tags for use by htmLawed
parseThemeDef
in file functions.php, function parseThemeDef()
    Parses and sanitizes Theme definition text
parse_size
in file functions-basic.php, function parse_size()
    Parses a byte size from a size value (eg: 100M) for comparison.
pathurlencode
in file functions-basic.php, function pathurlencode()
    rawurlencode function that is path-safe (does not encode /)
populateManagedObjectsList
in file functions.php, function populateManagedObjectsList()
    Returns a list of album names managed by $id
postComment
in file functions.php, function postComment()
    Generic comment adding routine. Called by album objects or image objects to add comments.
prefix
in file functions-basic.php, function prefix()
    Prefix a table name with a user-defined string to avoid conflicts.
printAdminToolbox
in file template-functions.php, function printAdminToolbox()
    Prints the clickable drop down toolbox on any theme page with generic admin helpers
printAlbumBreadcrumb
in file template-functions.php, function printAlbumBreadcrumb()
    prints the breadcrumb item for the current images's album
printAlbumCustomData
in file template-functions.php, function printAlbumCustomData()
    Prints the custom_data field of the current album.
printAlbumData
in file template-functions.php, function printAlbumData()
    Prints arbitrary data from the album object and make it editable if applicable
printAlbumDate
in file template-functions.php, function printAlbumDate()
    Prints the date of the current album and makes it editable in place if applicable
printAlbumDesc
in file template-functions.php, function printAlbumDesc()
    Prints description of the current album and makes it editable in place
printAlbumLink
in file template-functions.php, function printAlbumLink()
    Prints the album link url of the current album.
printAlbumLocation
in file template-functions.php, function printAlbumLocation()
    Prints the location of the album and make it editable
printAlbumThumbImage
in file template-functions.php, function printAlbumThumbImage()
    Prints the album thumbnail image.
printAlbumTitle
in file template-functions.php, function printAlbumTitle()
    Prints an encapsulated title of the current album.
printAlbumZip
in file template-functions.php, function printAlbumZip()
    Creates an URL for to download of a zipped copy of the current album
printAllDates
in file template-functions.php, function printAllDates()
    Prints a compendum of dates and links to a search page that will show results of the date
printAllTagsAs
in file template-functions.php, function printAllTagsAs()
    Either prints all of the galleries tgs as a UL list or a cloud
printCaptcha
in file template-functions.php, function printCaptcha()
    Simple captcha for comments.
printCodeblock
in file template-functions.php, function printCodeblock()
    Prints the content of a codeblock for an image, album or Zenpage newsarticle or page.
printCommentAuthorLink
in file template-functions.php, function printCommentAuthorLink()
    Prints a link to the author
printCustomAlbumThumbImage
in file template-functions.php, function printCustomAlbumThumbImage()
    Prints a link to a custom sized thumbnail of the current album
printCustomAlbumThumbMaxSpace
in file template-functions.php, function printCustomAlbumThumbMaxSpace()
    Prints a un-cropped custom sized album thumb within the given height and width dimensions.
printCustomPageURL
in file template-functions.php, function printCustomPageURL()
    Prints the url to a custom page (e.g. one that is not album.php, image.php, or index.php)
printCustomSizedImage
in file template-functions.php, function printCustomSizedImage()
    Print normal video or custom sized images.
printCustomSizedImageMaxSpace
in file template-functions.php, function printCustomSizedImageMaxSpace()
    Print normal video or un-cropped within the given height and width dimensions. Use for sized images or thumbnails in an album.
printCustomSizedImageThumbMaxSpace
in file template-functions.php, function printCustomSizedImageThumbMaxSpace()
    Creates image thumbnails which will fit un-cropped within the width & height parameters given
printDefaultSizedImage
in file template-functions.php, function printDefaultSizedImage()
    Show video player with video loaded or display the image.
printEditCommentLink
in file template-functions.php, function printEditCommentLink()
    Creates a link to the admin comment edit page for the current comment
printField
in file template-functions.php, function printField()
    Print any album or image data and make it editable in place
printGalleryDesc
in file template-functions.php, function printGalleryDesc()
    Prints the description of the gallery.
printGalleryTitle
in file template-functions.php, function printGalleryTitle()
    Prints the title of the gallery.
printHomeLink
in file template-functions.php, function printHomeLink()
    Prints a link to the 'main website' Only prints the link if the url is not empty and does not point back the gallery page
printImageCustomData
in file template-functions.php, function printImageCustomData()
    Prints the custom_data field of the current image.
printImageData
in file template-functions.php, function printImageData()
    Prints arbitrary data from the image object and make it editable if applicable
printImageDate
in file template-functions.php, function printImageDate()
    Prints the date of the current album and makes it editable in place if applicable
printImageDesc
in file template-functions.php, function printImageDesc()
    Prints the description of the current image.
printImageDiv
in file template-functions.php, function printImageDiv()
    Print the entire <div> for a thumbnail. If we are in sorting mode, then only the image is inserted, if not, then the hyperlink to the image is also added.
printImageID
in file template-functions.php, function printImageID()
    Print the unique ID of the current image.
printImageLink
in file template-functions.php, function printImageLink()
    Prints the link to the current image.
printImageMetadata
in file template-functions.php, function printImageMetadata()
    Prints the Metadata data of the current image, and make each value editable in place if applicable
printImageSortOrder
in file template-functions.php, function printImageSortOrder()
    Print the sort order of this image.
printImageThumb
in file template-functions.php, function printImageThumb()
printImageTitle
in file template-functions.php, function printImageTitle()
    Prints title of the current image and make it editable in place
printLargeFileContents
in file functions.php, function printLargeFileContents()
    Processes a file for createAlbumZip
printLatestComments
in file template-functions.php, function printLatestComments()
    Prints out latest comments for images and albums
printLink
in file functions.php, function printLink()
    General link printing function
printNextPageLink
in file template-functions.php, function printNextPageLink()
    Prints the URL of the next page.
printPageList
in file template-functions.php, function printPageList()
    Prints a list of all pages.
printPageListWithNav
in file template-functions.php, function printPageListWithNav()
    Prints a full page navigation including previous and next page links with a list of all pages in between.
printPageNav
in file template-functions.php, function printPageNav()
    Prints a page navigation including previous and next page links
printParentBreadcrumb
in file template-functions.php, function printParentBreadcrumb()
    Prints the breadcrumb navigation for album, gallery and image view.
printPasswordForm
in file template-functions.php, function printPasswordForm()
    Prints the album password form
printPrevPageLink
in file template-functions.php, function printPrevPageLink()
    Returns the URL of the previous page.
printRandomImages
in file template-functions.php, function printRandomImages()
    Puts up random image thumbs from the gallery
printRSSHeaderLink
in file template-functions.php, function printRSSHeaderLink()
    Prints the RSS link for use in the HTML HEAD
printRSSLink
in file template-functions.php, function printRSSLink()
    Prints an RSS link
printSearchForm
in file template-functions.php, function printSearchForm()
    Prints the search form
printSizedImageLink
in file template-functions.php, function printSizedImageLink()
    Prints link to an image of specific size
printTags
in file template-functions.php, function printTags()
    Prints a list of tags, editable by admin
printVersion
in file template-functions.php, function printVersion()
    Prints the zenphoto version string
printZenJavascripts
in file template-functions.php, function printZenJavascripts()
    Print any Javascript required by zenphoto.
printZenphotoLink
in file template-functions.php, function printZenphotoLink()
    prints the zenphoto logo and link
PROTOCOL
in file functions-basic.php, constant PROTOCOL
purgeOption
in file functions-basic.php, function purgeOption()
r

r

readTags
in file functions.php, function readTags()
    Retrieves the tags for an album/image Returns them in an array
read_exif_data_protected
in file functions.php, function read_exif_data_protected()
    Provides an error protected read of image EXIF/IPTC data
reconfigure
in file functions-basic.php, function reconfigure()
    Redirects to setup if the files are present. Otherwise notifies need for re-upload
rem_context
in file functions.php, function rem_context()
resetCurrentAlbum
in file template-functions.php, function resetCurrentAlbum()
restore_context
in file functions.php, function restore_context()
rewrite_get_album_image
in file functions-basic.php, function rewrite_get_album_image()
    rewrite_get_album_image - Fix special characters in the album and image names if mod_rewrite is on: This is redundant and hacky; we need to either make the rewriting completely internal, or fix the bugs in mod_rewrite. The former is probably a good idea.
rewrite_path
in file functions-basic.php, function rewrite_path()
    Returns either the rewrite path or the plain, non-mod_rewrite path based on the mod_rewrite option.
RSShitcounter
in file functions-rss.php, function RSShitcounter()
s

s

safe_fnmatch
in file functions.php, function safe_fnmatch()
    pattern match function Works with accented characters where the PHP one does not.
safe_glob
in file functions-basic.php, function safe_glob()
    Provide an alternative to glob which does not return filenames with accented charactes in them
SAFE_MODE_ALBUM_SEP
in file functions-basic.php, constant SAFE_MODE_ALBUM_SEP
sanitize
in file functions-basic.php, function sanitize()
    Make strings generally clean. Takes an input string and cleans out null-bytes, slashes (if magic_quotes_gpc is on), and optionally use KSES library to prevent XSS attacks and other malicious user input.
sanitize_numeric
in file functions-basic.php, function sanitize_numeric()
    Checks if the input is numeric, rounds if so, otherwise returns false.
sanitize_path
in file functions-basic.php, function sanitize_path()
    Takes user input meant to be used within a path to a file or folder and removes anything that could be insecure or malicious, or result in duplicate representations for the same physical file.
sanitize_string
in file functions-basic.php, function sanitize_string()
    returns a sanitized string for the sanitize function
save_context
in file functions.php, function save_context()
secureServer
in file functions-basic.php, function secureServer()
    Checks to see if access was through a secure protocol
seoFriendly
in file functions.php, function seoFriendly()
    Strips out and/or replaces characters from the string that are not "soe" friendly
SERVERCACHE
in file functions-basic.php, constant SERVERCACHE
SERVERPATH
in file functions-basic.php, constant SERVERPATH
SERVER_PROTOCOL
in file functions-basic.php, constant SERVER_PROTOCOL
setAlbumCustomData
in file template-functions.php, function setAlbumCustomData()
    Sets the album custom_data field
setexifvars
in file functions.php, function setexifvars()
    initializes the $_zp_exifvars array display state
setImageCustomData
in file template-functions.php, function setImageCustomData()
    Sets the image custom_data field
setOption
in file functions-basic.php, function setOption()
    Stores an option value.
setOptionDefault
in file functions-basic.php, function setOptionDefault()
    Sets the default value of an option.
setThemeColumns
in file template-functions.php, function setThemeColumns()
    controls the thumbnail layout of themes.
setThemeOption
in file functions.php, function setThemeOption()
    Set options local to theme and/or album
setThemeOptionDefault
in file functions.php, function setThemeOptionDefault()
    Used to set default values for theme specific options
setupTheme
in file functions.php, function setupTheme()
    Returns the theme folder If there is an album theme, loads the theme options.
set_context
in file functions.php, function set_context()
shortenContent
in file template-functions.php, function shortenContent()
    Returns truncated html formatted content
size_readable
in file functions-basic.php, function size_readable()
    Return human readable sizes From: http://aidan.dotgeek.org/lib/
sortByKey
in file functions.php, function sortByKey()
    sorts the found albums (images) by the required key(s)
sortByMultilingual
in file functions.php, function sortByMultilingual()
    Sorts the results of a DB search by the current locale string for $field
sortMultiArray
in file functions.php, function sortMultiArray()
    multidimensional array column sort
startRSSCache
in file functions-rss.php, function startRSSCache()
    Starts static RSS caching
storeTags
in file functions.php, function storeTags()
    Stores tags for an album/image
stripSuffix
in file functions-basic.php, function stripSuffix()
    returns a file name sans the suffix
t

t

template-functions.php
procedural page template-functions.php
themeSetup
in file functions-basic.php, function themeSetup()
    primitive theme setup for image handling scripts
THUMB_WATERMARK
in file functions-basic.php, constant THUMB_WATERMARK
truncate_string
in file functions.php, function truncate_string()
    Returns a truncated string
u

u

USE_CAPTCHA
in file functions.php, constant USE_CAPTCHA
UTF8_IMAGE_URI
in file functions-basic.php, constant UTF8_IMAGE_URI
w

w

WEBPATH
in file functions-basic.php, constant WEBPATH
    OFFSET_PATH definisions:
x

x

XSRFToken
in file functions.php, function XSRFToken()
    Emits a "hidden" input for the XSRF token
z

z

ZENPHOTO_LOCALE
in file functions.php, constant ZENPHOTO_LOCALE
zpFormattedDate
in file functions.php, function zpFormattedDate()
    Returns a formated date for output
ZP_ALBUM
in file functions-basic.php, constant ZP_ALBUM
ZP_ALBUM_LINKED
in file functions-basic.php, constant ZP_ALBUM_LINKED
zp_apply_filter
in file functions-filter.php, function zp_apply_filter()
    Performs a filtering operation on a zenphoto element or event.
ZP_COMMENT
in file functions-basic.php, constant ZP_COMMENT
zp_cookieEncode
in file functions.php, function zp_cookieEncode()
    Encodes a cookie value tying it to the user IP
zp_error
in file functions-basic.php, function zp_error()
    Formats an error message If DEBUG_ERROR is set, supplies the calling sequence
zp_filter_slot
in file functions-filter.php, function zp_filter_slot()
    Returns the position of the function in the hook queue
zp_filter_unique_id
in file functions-filter.php, function zp_filter_unique_id()
    Build Unique ID for storage and retrieval.
zp_getCookie
in file functions.php, function zp_getCookie()
    Returns the value of a cookie from either the cookies or from $_SESSION[]
zp_handle_password
in file functions.php, function zp_handle_password()
    checks password posting
zp_has_filter
in file functions-filter.php, function zp_has_filter()
    Check if any filter has been registered for a hook.
zp_html_decode
in file functions-basic.php, function zp_html_decode()
    Decodes HTML Special Characters.
ZP_IMAGE
in file functions-basic.php, constant ZP_IMAGE
ZP_IMAGE_LINKED
in file functions-basic.php, constant ZP_IMAGE_LINKED
zp_image_types
in file functions.php, function zp_image_types()
    returns a list of comment record 'types' for "images"
ZP_INDEX
in file functions-basic.php, constant ZP_INDEX
zp_loggedin
in file functions.php, function zp_loggedin()
    Check if logged in (with specific rights) Returns a true value if there is a user logged on with the required rights
zp_mail
in file functions.php, function zp_mail()
    Send an mail to the mailing list. We also attempt to intercept any form injection attacks by slime ball spammers. Returns error message if send failure.
zp_register_filter
in file functions-filter.php, function zp_register_filter()
    Registers a filtering function Filtering functions are used to post process zenphoto elements or to trigger functions when a filter occur
zp_remove_filter
in file functions-filter.php, function zp_remove_filter()
    Removes a function from a specified filter hook.
ZP_SEARCH
in file functions-basic.php, constant ZP_SEARCH
ZP_SEARCH_LINKED
in file functions-basic.php, constant ZP_SEARCH_LINKED
zp_setCookie
in file functions.php, function zp_setCookie()
    Sets a cookie both in the browser cookies and in $_SESSION[]
ZP_ZENPAGE_NEWS_ARTICLE
in file functions-basic.php, constant ZP_ZENPAGE_NEWS_ARTICLE
ZP_ZENPAGE_NEWS_CATEGORY
in file functions-basic.php, constant ZP_ZENPAGE_NEWS_CATEGORY
ZP_ZENPAGE_NEWS_DATE
in file functions-basic.php, constant ZP_ZENPAGE_NEWS_DATE
ZP_ZENPAGE_PAGE
in file functions-basic.php, constant ZP_ZENPAGE_PAGE
ZP_ZENPAGE_SINGLE
in file functions-basic.php, constant ZP_ZENPAGE_SINGLE

Documentation generated on Tue, 20 Dec 2011 16:06:21 +0100 by phpDocumentor 1.4.3