Overview

Packages

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

Classes

  • zpMutex

Functions

  • accessAllAlbums
  • adminToolbox
  • albumNumber
  • build_query
  • build_url
  • checkAccess
  • checkForGuest
  • checkInstall
  • checkPageValidity
  • debugLog
  • exitZP
  • exposeZenPhotoInformations
  • filterImageQuery
  • get_filterScript
  • getAlbumArray
  • getAlbumBreadcrumb
  • getAlbumCustomData
  • getAlbumData
  • getAlbumDate
  • getAlbumDesc
  • getAlbumFolder
  • getAlbumInherited
  • getAlbumLocation
  • getAlbumPage
  • getAlbumThumb
  • getAlbumTitle
  • getAlbumURL
  • getAllAccessibleAlbums
  • getAllAlbums
  • getAllDates
  • getAllowedTags
  • getAnnotatedAlbumTitle
  • getAnnotatedImageTitle
  • getBareAlbumDesc
  • getBareAlbumTitle
  • getBareGalleryDesc
  • getBareGalleryTitle
  • getBareImageDesc
  • getBareImageTitle
  • getCodeblock
  • getCurrentPage
  • getCurrentTheme
  • getCustomAlbumThumb
  • getCustomAlbumThumbMaxSpace
  • getCustomImageURL
  • getCustomPageURL
  • getCustomSizedImageMaxSpace
  • getCustomSizedImageThumbMaxSpace
  • getDefaultHeight
  • getDefaultSizedImage
  • getDefaultWidth
  • getFullHeight
  • getFullImageURL
  • getFullWidth
  • getGalleryDesc
  • getGalleryIndexURL
  • getGalleryTitle
  • getHeadTitle
  • getImageArgs
  • getImageCacheFilename
  • getImageCachePostfix
  • getImageCity
  • getImageCountry
  • getImageCustomData
  • getImageData
  • getImageDate
  • getImageDesc
  • getImageLocation
  • getImageMetaData
  • getImageParameters
  • getImageProcessorURI
  • getImageState
  • getImageThumb
  • getImageTitle
  • getImageURI
  • getImageURL
  • getMainSiteName
  • getMainSiteURL
  • getMaxSpaceContainer
  • getNextAlbum
  • getNextAlbumURL
  • getNextImageThumb
  • getNextImageURL
  • getNextPageURL
  • getNumAlbums
  • getNumImages
  • getOption
  • getOptionList
  • getPageNavList
  • getPageNumURL
  • getPageRedirect
  • getParentAlbums
  • getParentBreadcrumb
  • getPasswordProtectImage
  • getPrevAlbum
  • getPrevAlbumURL
  • getPrevImageThumb
  • getPrevImageURL
  • getPrevPageURL
  • getProtectedImageURL
  • getRandomImages
  • getRandomImagesAlbum
  • getRequestURI
  • getSearchDate
  • getSearchURL
  • getSearchWords
  • getSiteHomeURL
  • getSizeCustomImage
  • getSizeDefaultImage
  • getSizeDefaultThumb
  • getSizedImageURL
  • getSizeFullImage
  • getSuffix
  • getTags
  • getTotalImagesIn
  • getTotalPages
  • getUnprotectedImageURL
  • getVersion
  • getWatermarkParam
  • getWatermarkPath
  • hasDynamicAlbumSuffix
  • hasNextImage
  • hasNextPage
  • hasPrevImage
  • hasPrevPage
  • imageNumber
  • imgSrcURI
  • installSignature
  • instrument
  • isAlbumPage
  • isArchive
  • isHandledAlbum
  • isImagePage
  • isLandscape
  • js_encode
  • loadLocalOptions
  • makeAlbumCurrent
  • makeImageCurrent
  • makeSpecialImageName
  • next_album
  • next_image
  • parse_query
  • parse_size
  • pathurlencode
  • print404status
  • printAlbumBreadcrumb
  • printAlbumCustomData
  • printAlbumData
  • printAlbumDate
  • printAlbumDesc
  • printAlbumLocation
  • printAlbumThumbImage
  • printAlbumTitle
  • printAlbumURL
  • printAllDates
  • printAllTagsAs
  • printAnnotatedAlbumTitle
  • printAnnotatedImageTitle
  • printBareAlbumDesc
  • printBareAlbumTitle
  • printBareGalleryDesc
  • printBareGalleryTitle
  • printBareImageDesc
  • printBareImageTitle
  • printCodeblock
  • printCustomAlbumThumbImage
  • printCustomAlbumThumbMaxSpace
  • printCustomPageURL
  • printCustomSizedImage
  • printCustomSizedImageMaxSpace
  • printCustomSizedImageThumbMaxSpace
  • printDefaultSizedImage
  • printGalleryDesc
  • printGalleryIndexURL
  • printGalleryTitle
  • printHeadTitle
  • printHomeLink
  • printImageCustomData
  • printImageData
  • printImageDate
  • printImageDesc
  • printImageMetadata
  • printImageThumb
  • printImageTitle
  • printImageURL
  • printNextPageURL
  • printPageList
  • printPageListWithNav
  • printPageNav
  • printParentBreadcrumb
  • printPasswordForm
  • printPrevPageURL
  • printRandomImages
  • printSearchBreadcrumb
  • printSearchForm
  • printSiteHomeURL
  • printSizedImageURL
  • printTags
  • printVersion
  • printZenJavascripts
  • printZenphotoLink
  • purgeOption
  • rewrite_get_album_image
  • rewrite_path
  • safe_glob
  • secureServer
  • setOption
  • setOptionDefault
  • setThemeColumns
  • stripSuffix
  • switchLog
  • themeSetup
  • zp_apply_filter
  • zp_filter_slot
  • zp_filter_unique_id
  • zp_has_filter
  • zp_register_filter
  • zp_remove_filter
  • zp_session_start
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Package functions

Classes summary
zpMutex Zenphoto Mutex class
Functions summary
accessAllAlbums Checks access for the album root
adminToolbox Prints the clickable drop down toolbox on any theme page with generic admin helpers
albumNumber Gets the 'n' for n of m albums
build_query createsa query string from the array passed
build_url Builds a url from parts
checkAccess Checks to see if a password is needed
checkForGuest returns the auth type of a guest login
checkInstall
checkPageValidity

Checks for URL page out-of-bounds for "standard" themes Note: This function assumes that an "index" page will display albums and the pagination be determined by them. Any other "index" page strategy needs to be handled by the theme itself.

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. Creates (or adds to) a file named debug.log which is located in the zenphoto core folder

exitZP
exposeZenPhotoInformations Expose some informations in a HTML comment
filterImageQuery
get_filterScript
getAlbumArray

getAlbumArray - returns an array of folder names corresponding to the given album string.

getAlbumBreadcrumb returns the breadcrumb item for the current images's album
getAlbumCustomData Returns the custom_data field of the current album
getAlbumData A composit for getting album data
getAlbumDate Returns the formatted date field of the album
getAlbumDesc Returns the raw description of the current album.
getAlbumFolder Returns the fully qualified path to the album folders
getAlbumInherited returns the non-empty value of $field from the album or one of its parents
getAlbumLocation Returns the Location of the album.
getAlbumPage Returns the album page number of the current image
getAlbumThumb Returns the name of the defined album thumbnail image.
getAlbumTitle Returns the raw title of the current album.
getAlbumURL Returns the album link url of the current album.
getAllAccessibleAlbums Gets an array of the album ids of all accessible albums (publich or user dependend)
getAllAlbums Returns a list of all albums decendent from an album
getAllDates Retrieves a list of all unique years & months from the images in the gallery
getAllowedTags
getAnnotatedAlbumTitle Returns an album title taged with of Not visible or password protected status
getAnnotatedImageTitle Returns the image title taged with not visible annotation.
getBareAlbumDesc Returns a text-only description of the current album.
getBareAlbumTitle Returns a text-only title of the current album.
getBareGalleryDesc Returns a text-only description of the gallery.
getBareGalleryTitle Returns a text-only title of the gallery.
getBareImageDesc Returns a text-only description of the current image.
getBareImageTitle Returns a text-only title of the current image.
getCodeblock Gets the content of a codeblock for an image, album or Zenpage newsarticle or page.
getCurrentPage Returns the number of the current page without printing it.
getCurrentTheme Returns the name of the currently active theme
getCustomAlbumThumb Returns a link to a custom sized thumbnail of the current album
getCustomAlbumThumbMaxSpace Returns a link to a un-cropped custom sized version of the current album thumb within the given height and width dimensions.
getCustomImageURL Returns the url to the image with the dimensions you define with this function.
getCustomPageURL Produces the url to a custom page (e.g. one that is not album.php, image.php, or index.php)
getCustomSizedImageMaxSpace

Returns a link to a un-cropped custom sized version of the current image within the given height and width dimensions. Use for sized images.

getCustomSizedImageThumbMaxSpace

Returns a link to a un-cropped custom sized version of the current image within the given height and width dimensions. Use for sized thumbnails.

getDefaultHeight Returns the height of the default-sized image (in printDefaultSizedImage)
getDefaultSizedImage Returns the url to the default sized image.
getDefaultWidth The width of the default-sized image (in printDefaultSizedImage)
getFullHeight Returns the height of the original image
getFullImageURL

Returns the url to original image. It will return a protected image is the option "protect_full_image" is set

getFullWidth Returns the width of the original image
getGalleryDesc Returns the raw description of the gallery.
getGalleryIndexURL

Returns the URL of the main gallery index page. If a custom index page is set this returns that page. So this is not necessarily the home page of the site!

getGalleryTitle Returns the raw title of the gallery.
getHeadTitle

Function to create the page title to be used within the html element. Usefull if you use one header.php for the header of all theme pages instead of individual ones on the theme pages It returns the title and site name in reversed breadcrumb order: | <parent item if present> | <gallery title> It supports standard gallery pages as well a custom and Zenpage news articles, categories and pages.</p></td> </tr> <tr> <td class="name"><a href="function-getImageArgs.html">getImageArgs</a></td> <td>Extract the image parameters from the input variables</td> </tr> <tr> <td class="name"><a href="function-getImageCacheFilename.html">getImageCacheFilename</a></td> <td><p>Returns the path of an image for uses in caching it NOTE: character set if for the filesystem</p></td> </tr> <tr> <td class="name"><a href="function-getImageCachePostfix.html">getImageCachePostfix</a></td> <td>Returns the crop/sizing string to postfix to a cache image</td> </tr> <tr> <td class="name"><a href="function-getImageCity.html">getImageCity</a></td> <td>Returns the City field of the current image</td> </tr> <tr> <td class="name"><a href="function-getImageCountry.html">getImageCountry</a></td> <td>Returns the Country field of the current image</td> </tr> <tr> <td class="name"><a href="function-getImageCustomData.html">getImageCustomData</a></td> <td>Returns the custom_data field of the current image</td> </tr> <tr> <td class="name"><a href="function-getImageData.html">getImageData</a></td> <td>A composit for getting image data</td> </tr> <tr> <td class="name"><a href="function-getImageDate.html">getImageDate</a></td> <td><p>Returns the image date of the current image in yyyy-mm-dd hh:mm:ss format. Pass it a date format string for custom formatting</p></td> </tr> <tr> <td class="name"><a href="function-getImageDesc.html">getImageDesc</a></td> <td><p>Returns the raw description of the current image. new lines are replaced with <br /> tags</p></td> </tr> <tr> <td class="name"><a href="function-getImageLocation.html">getImageLocation</a></td> <td>Returns the Location field of the current image</td> </tr> <tr> <td class="name"><a href="function-getImageMetaData.html">getImageMetaData</a></td> <td>Returns the Metadata infromation from the current image</td> </tr> <tr> <td class="name"><a href="function-getImageParameters.html">getImageParameters</a></td> <td>Validates and edits image size/cropping parameters</td> </tr> <tr> <td class="name"><a href="function-getImageProcessorURI.html">getImageProcessorURI</a></td> <td>forms the i.php parameter list for an image.</td> </tr> <tr> <td class="name"><a href="function-getImageState.html">getImageState</a></td> <td>Returns the State field of the current image</td> </tr> <tr> <td class="name"><a href="function-getImageThumb.html">getImageThumb</a></td> <td>Returns the url to the thumbnail of the current image.</td> </tr> <tr> <td class="name"><a href="function-getImageTitle.html">getImageTitle</a></td> <td>Returns the raw title of the current image.</td> </tr> <tr> <td class="name"><a href="function-getImageURI.html">getImageURI</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-getImageURL.html">getImageURL</a></td> <td>Returns the url of the current image.</td> </tr> <tr> <td class="name"><a href="function-getMainSiteName.html">getMainSiteName</a></td> <td><p>Returns the name of the main website as set by the "Website Title" option on the gallery options tab. Use this if Zenphoto is only a part of your website.</p></td> </tr> <tr> <td class="name"><a href="function-getMainSiteURL.html">getMainSiteURL</a></td> <td><p>Returns the URL of the main website as set by the "Website URL" option on the gallery options tab. Use this if Zenphoto is only a part of your website.</p></td> </tr> <tr> <td class="name"><a href="function-getMaxSpaceContainer.html">getMaxSpaceContainer</a></td> <td>Called by ***MaxSpace functions to compute the parameters to be passed to xxCustomyyy functions.</td> </tr> <tr> <td class="name"><a href="function-getNextAlbum.html">getNextAlbum</a></td> <td>Returns the next album</td> </tr> <tr> <td class="name"><a href="function-getNextAlbumURL.html">getNextAlbumURL</a></td> <td>Get the URL of the next album in the gallery.</td> </tr> <tr> <td class="name"><a href="function-getNextImageThumb.html">getNextImageThumb</a></td> <td>Returns the thumbnail of the next image.</td> </tr> <tr> <td class="name"><a href="function-getNextImageURL.html">getNextImageURL</a></td> <td>Returns the url of the next image.</td> </tr> <tr> <td class="name"><a href="function-getNextPageURL.html">getNextPageURL</a></td> <td>Returns the URL of the next page. Use within If or while loops for pagination.</td> </tr> <tr> <td class="name"><a href="function-getNumAlbums.html">getNumAlbums</a></td> <td>Returns the number of albums.</td> </tr> <tr> <td class="name"><a href="function-getNumImages.html">getNumImages</a></td> <td>Returns the number of images in the album.</td> </tr> <tr> <td class="name"><a href="function-getOption.html">getOption</a></td> <td><p>Get a option stored in the database. This function reads the options only once, in order to improve performance.</p></td> </tr> <tr> <td class="name"><a href="function-getOptionList.html">getOptionList</a></td> <td>Retuns the option array</td> </tr> <tr> <td class="name"><a href="function-getPageNavList.html">getPageNavList</a></td> <td>returns a page nav list.</td> </tr> <tr> <td class="name"><a href="function-getPageNumURL.html">getPageNumURL</a></td> <td>Returns the URL of the page number passed as a parameter</td> </tr> <tr> <td class="name"><a href="function-getPageRedirect.html">getPageRedirect</a></td> <td>Returns a redirection link for the password form</td> </tr> <tr> <td class="name"><a href="function-getParentAlbums.html">getParentAlbums</a></td> <td>Returns an array of the names of the parents of the current album.</td> </tr> <tr> <td class="name"><a href="function-getParentBreadcrumb.html">getParentBreadcrumb</a></td> <td>returns the breadcrumb navigation for album, gallery and image view.</td> </tr> <tr> <td class="name"><a href="function-getPasswordProtectImage.html">getPasswordProtectImage</a></td> <td>Returns an img src link to the password protect thumb substitute</td> </tr> <tr> <td class="name"><a href="function-getPrevAlbum.html">getPrevAlbum</a></td> <td>Returns the previous album</td> </tr> <tr> <td class="name"><a href="function-getPrevAlbumURL.html">getPrevAlbumURL</a></td> <td>Get the URL of the previous album in the gallery.</td> </tr> <tr> <td class="name"><a href="function-getPrevImageThumb.html">getPrevImageThumb</a></td> <td>Returns the thumbnail of the previous image.</td> </tr> <tr> <td class="name"><a href="function-getPrevImageURL.html">getPrevImageURL</a></td> <td>Returns the url of the previous image.</td> </tr> <tr> <td class="name"><a href="function-getPrevPageURL.html">getPrevPageURL</a></td> <td>Returns the URL of the previous page.</td> </tr> <tr> <td class="name"><a href="function-getProtectedImageURL.html">getProtectedImageURL</a></td> <td>Returns an url to the password protected/watermarked current image</td> </tr> <tr> <td class="name"><a href="function-getRandomImages.html">getRandomImages</a></td> <td>Returns a randomly selected image from the gallery. (May be NULL if none exists)</td> </tr> <tr> <td class="name"><a href="function-getRandomImagesAlbum.html">getRandomImagesAlbum</a></td> <td>Returns a randomly selected image from the album or its subalbums. (May be NULL if none exists)</td> </tr> <tr> <td class="name"><a href="function-getRequestURI.html">getRequestURI</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-getSearchDate.html">getSearchDate</a></td> <td>Returns the date of the search</td> </tr> <tr> <td class="name"><a href="function-getSearchURL.html">getSearchURL</a></td> <td>Returns a search URL</td> </tr> <tr> <td class="name"><a href="function-getSearchWords.html">getSearchWords</a></td> <td>Returns the a sanitized version of the search string</td> </tr> <tr> <td class="name"><a href="function-getSiteHomeURL.html">getSiteHomeURL</a></td> <td><p>Returns the home page link (WEBPATH) to the Zenphoto theme index.php page Use in breadcrumbs if the theme uses a custom gallery index page so the gallery is not the site's home page</p></td> </tr> <tr> <td class="name"><a href="function-getSizeCustomImage.html">getSizeCustomImage</a></td> <td>Returns an array with the height & width</td> </tr> <tr> <td class="name"><a href="function-getSizeDefaultImage.html">getSizeDefaultImage</a></td> <td>Returns an array [width, height] of the default-sized image.</td> </tr> <tr> <td class="name"><a href="function-getSizeDefaultThumb.html">getSizeDefaultThumb</a></td> <td>Gets the width and height of a default thumb for the <img> tag height/width</td> </tr> <tr> <td class="name"><a href="function-getSizedImageURL.html">getSizedImageURL</a></td> <td>Returns a link to the current image custom sized to $size</td> </tr> <tr> <td class="name"><a href="function-getSizeFullImage.html">getSizeFullImage</a></td> <td>Returns an array [width, height] of the original image.</td> </tr> <tr> <td class="name"><a href="function-getSuffix.html">getSuffix</a></td> <td>Returns the suffix of a file name</td> </tr> <tr> <td class="name"><a href="function-getTags.html">getTags</a></td> <td>Returns a list of tags for context of the page called where called</td> </tr> <tr> <td class="name"><a href="function-getTotalImagesIn.html">getTotalImagesIn</a></td> <td>Returns the count of all the images in the album and any subalbums</td> </tr> <tr> <td class="name"><a href="function-getTotalPages.html">getTotalPages</a></td> <td>Returns the number of pages for the current object</td> </tr> <tr> <td class="name"><a href="function-getUnprotectedImageURL.html">getUnprotectedImageURL</a></td> <td>Returns the "raw" url to the image in the albums folder</td> </tr> <tr> <td class="name"><a href="function-getVersion.html">getVersion</a></td> <td>Returns the zenphoto version string</td> </tr> <tr> <td class="name"><a href="function-getWatermarkParam.html">getWatermarkParam</a></td> <td>Returns the watermark image to pass to i.php</td> </tr> <tr> <td class="name"><a href="function-getWatermarkPath.html">getWatermarkPath</a></td> <td>Returns the path to a watermark</td> </tr> <tr> <td class="name"><a href="function-hasDynamicAlbumSuffix.html">hasDynamicAlbumSuffix</a></td> <td>Returns true if the file has the dynamic album suffix</td> </tr> <tr> <td class="name"><a href="function-hasNextImage.html">hasNextImage</a></td> <td>True if there is a next image</td> </tr> <tr> <td class="name"><a href="function-hasNextPage.html">hasNextPage</a></td> <td>Returns true if there is a next page</td> </tr> <tr> <td class="name"><a href="function-hasPrevImage.html">hasPrevImage</a></td> <td>True if there is a previous image</td> </tr> <tr> <td class="name"><a href="function-hasPrevPage.html">hasPrevPage</a></td> <td>Returns TRUE if there is a previous page. Use within If or while loops for pagination.</td> </tr> <tr> <td class="name"><a href="function-imageNumber.html">imageNumber</a></td> <td>Returns the 'n' of n of m images</td> </tr> <tr> <td class="name"><a href="function-imgSrcURI.html">imgSrcURI</a></td> <td>Returns an img src URI encoded based on the OS of the server</td> </tr> <tr> <td class="name"><a href="function-installSignature.html">installSignature</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-instrument.html">instrument</a></td> <td>Tool to log execution times of script bits</td> </tr> <tr> <td class="name"><a href="function-isAlbumPage.html">isAlbumPage</a></td> <td>Returns true if this page has album thumbs on it</td> </tr> <tr> <td class="name"><a href="function-isArchive.html">isArchive</a></td> <td>tests if a search page is an "archive" page</td> </tr> <tr> <td class="name"><a href="function-isHandledAlbum.html">isHandledAlbum</a></td> <td><p>checks if there is a file with the prefix and one of the handled suffixes. Returns the found suffix</p></td> </tr> <tr> <td class="name"><a href="function-isImagePage.html">isImagePage</a></td> <td>Returns true if this page has image thumbs on it</td> </tr> <tr> <td class="name"><a href="function-isLandscape.html">isLandscape</a></td> <td>Returns true if the image is landscape-oriented (width is greater than height)</td> </tr> <tr> <td class="name"><a href="function-js_encode.html">js_encode</a></td> <td>encodes a pre-sanitized string to be used as a Javascript parameter</td> </tr> <tr> <td class="name"><a href="function-loadLocalOptions.html">loadLocalOptions</a></td> <td>Loads option table with album/theme options</td> </tr> <tr> <td class="name"><a href="function-makeAlbumCurrent.html">makeAlbumCurrent</a></td> <td>Sets the album passed as the current album</td> </tr> <tr> <td class="name"><a href="function-makeImageCurrent.html">makeImageCurrent</a></td> <td>Sets the image passed as the current image</td> </tr> <tr> <td class="name"><a href="function-makeSpecialImageName.html">makeSpecialImageName</a></td> <td>Returns an i.php "image name" for an image not within the albums structure</td> </tr> <tr> <td class="name"><a href="function-next_album.html">next_album</a></td> <td><p>WHILE next_album(): context switches to Album. If we're already in the album context, this is a sub-albums loop, which, quite simply, changes the source of the album list. Switch back to the previous context when there are no more albums.</p></td> </tr> <tr> <td class="name"><a href="function-next_image.html">next_image</a></td> <td><p>Returns the next image on a page. sets $_zp_current_image to the next image in the album.</p></td> </tr> <tr> <td class="name"><a href="function-parse_query.html">parse_query</a></td> <td>parses a query string WITHOUT url decoding it!</td> </tr> <tr> <td class="name"><a href="function-parse_size.html">parse_size</a></td> <td>Parses a byte size from a size value (eg: 100M) for comparison.</td> </tr> <tr> <td class="name"><a href="function-pathurlencode.html">pathurlencode</a></td> <td>rawurlencode function that is path-safe (does not encode /)</td> </tr> <tr> <td class="name"><a href="function-print404status.html">print404status</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-printAlbumBreadcrumb.html">printAlbumBreadcrumb</a></td> <td>prints the breadcrumb item for the current images's album</td> </tr> <tr> <td class="name"><a href="function-printAlbumCustomData.html">printAlbumCustomData</a></td> <td><p>Prints the custom_data field of the current album. Converts and displays line break in the admin field as <br />.</p></td> </tr> <tr> <td class="name"><a href="function-printAlbumData.html">printAlbumData</a></td> <td>Prints arbitrary data from the album object</td> </tr> <tr> <td class="name"><a href="function-printAlbumDate.html">printAlbumDate</a></td> <td>Prints the date of the current album</td> </tr> <tr> <td class="name"><a href="function-printAlbumDesc.html">printAlbumDesc</a></td> <td>Prints description of the current album</td> </tr> <tr> <td class="name"><a href="function-printAlbumLocation.html">printAlbumLocation</a></td> <td>Prints the location of the album</td> </tr> <tr> <td class="name"><a href="function-printAlbumThumbImage.html">printAlbumThumbImage</a></td> <td>Prints the album thumbnail image.</td> </tr> <tr> <td class="name"><a href="function-printAlbumTitle.html">printAlbumTitle</a></td> <td><p>Prints an encapsulated title of the current album. If you are logged in you can click on this to modify the title on the fly.</p></td> </tr> <tr> <td class="name"><a href="function-printAlbumURL.html">printAlbumURL</a></td> <td>Prints the album link url of the current album.</td> </tr> <tr> <td class="name"><a href="function-printAllDates.html">printAllDates</a></td> <td>Prints a compendum of dates and links to a search page that will show results of the date</td> </tr> <tr> <td class="name"><a href="function-printAllTagsAs.html">printAllTagsAs</a></td> <td>Either prints all of the galleries tgs as a UL list or a cloud</td> </tr> <tr> <td class="name"><a href="function-printAnnotatedAlbumTitle.html">printAnnotatedAlbumTitle</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-printAnnotatedImageTitle.html">printAnnotatedImageTitle</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-printBareAlbumDesc.html">printBareAlbumDesc</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-printBareAlbumTitle.html">printBareAlbumTitle</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-printBareGalleryDesc.html">printBareGalleryDesc</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-printBareGalleryTitle.html">printBareGalleryTitle</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-printBareImageDesc.html">printBareImageDesc</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-printBareImageTitle.html">printBareImageTitle</a></td> <td></td> </tr> <tr> <td class="name"><a href="function-printCodeblock.html">printCodeblock</a></td> <td>Prints the content of a codeblock for an image, album or Zenpage newsarticle or page.</td> </tr> <tr> <td class="name"><a href="function-printCustomAlbumThumbImage.html">printCustomAlbumThumbImage</a></td> <td>Prints a link to a custom sized thumbnail of the current album</td> </tr> <tr> <td class="name"><a href="function-printCustomAlbumThumbMaxSpace.html">printCustomAlbumThumbMaxSpace</a></td> <td><p>Prints a un-cropped custom sized album thumb within the given height and width dimensions. Note: a class of 'not_visible' or 'password_protected' will be added as appropriate</p></td> </tr> <tr> <td class="name"><a href="function-printCustomPageURL.html">printCustomPageURL</a></td> <td>Prints the url to a custom page (e.g. one that is not album.php, image.php, or index.php)</td> </tr> <tr> <td class="name"><a href="function-printCustomSizedImage.html">printCustomSizedImage</a></td> <td><p>Print normal video or custom sized images. Note: a class of 'not_visible' or 'password_protected' will be added as appropriate</p></td> </tr> <tr> <td class="name"><a href="function-printCustomSizedImageMaxSpace.html">printCustomSizedImageMaxSpace</a></td> <td><p>Print normal video or un-cropped within the given height and width dimensions. Use for sized images or thumbnails in an album. Note: a class of 'not_visible' or 'password_protected' will be added as appropriate</p></td> </tr> <tr> <td class="name"><a href="function-printCustomSizedImageThumbMaxSpace.html">printCustomSizedImageThumbMaxSpace</a></td> <td>Creates image thumbnails which will fit un-cropped within the width & height parameters given</td> </tr> <tr> <td class="name"><a href="function-printDefaultSizedImage.html">printDefaultSizedImage</a></td> <td>Show video player with video loaded or display the image.</td> </tr> <tr> <td class="name"><a href="function-printGalleryDesc.html">printGalleryDesc</a></td> <td>Prints the description of the gallery.</td> </tr> <tr> <td class="name"><a href="function-printGalleryIndexURL.html">printGalleryIndexURL</a></td> <td><p>If a custom gallery index page is set this first prints a link to the actual site index (home page = index.php) followed by the gallery index page link. Otherwise just the gallery index link</p></td> </tr> <tr> <td class="name"><a href="function-printGalleryTitle.html">printGalleryTitle</a></td> <td>Prints the title of the gallery.</td> </tr> <tr> <td class="name"><a href="function-printHeadTitle.html">printHeadTitle</a></td> <td><p>Function to print the html <title>title within the of a html page based on the current theme page Usefull if you use one header.php for the header of all theme pages instead of individual ones on the theme pages It prints the title and site name including the tag in reversed breadcrumb order: <title><title of current page> | <parent item if present> | <gallery title> It supports standard gallery pages as well a custom and Zenpage news articles, categories and pages.

printHomeLink

Prints a link to the 'main website', not the Zenphoto site home page! Only prints the link if the url is not empty and does not point back the gallery page

printImageCustomData

Prints the custom_data field of the current image. Converts and displays line breaks set in the admin field as
.

printImageData Prints arbitrary data from the image object
printImageDate Prints the date of the current album
printImageDesc

Prints the description of the current image. Converts and displays line breaks set in the admin field as
.

printImageMetadata Prints the Metadata data of the current image
printImageThumb
printImageTitle Prints title of the current image
printImageURL Prints the link to the current image.
printNextPageURL Prints the URL of the next page.
printPageList Prints a list of all pages.
printPageListWithNav Prints a full page navigation including previous and next page links with a list of all pages in between.
printPageNav Prints a page navigation including previous and next page links
printParentBreadcrumb Prints the breadcrumb navigation for album, gallery and image view.
printPasswordForm Prints the album password form
printPrevPageURL Returns the URL of the previous page.
printRandomImages Puts up random image thumbs from the gallery
printSearchBreadcrumb

Prints the "breadcrumb" for a search page if the search was for a data range, the breadcrumb is "Archive" otherwise it is "Search"

printSearchForm Prints the search form
printSiteHomeURL

Prints the home page link (WEBPATH with trailing slash) to a Zenphoto theme index.php page Use in breadcrumbs if the theme uses a custom gallery index page so the gallery is not the site's home page

printSizedImageURL Prints link to an image of specific size
printTags Prints a list of tags, editable by admin
printVersion Prints the zenphoto version string
printZenJavascripts Print any Javascript required by zenphoto.
printZenphotoLink prints the zenphoto logo and link
purgeOption
rewrite_get_album_image Handles the special cases of album/image[rewrite_suffix]
rewrite_path

Returns either the rewrite path or the plain, non-mod_rewrite path based on the mod_rewrite option. The given paths can start /with or without a slash, it doesn't matter.

safe_glob Provide an alternative to glob which does not return filenames with accented charactes in them
secureServer Checks to see if access was through a secure protocol
setOption Stores an option value.
setOptionDefault Sets the default value of an option.
setThemeColumns controls the thumbnail layout of themes.
stripSuffix returns a file name sans the suffix
switchLog Rolls a log over if it has grown too large.
themeSetup primitive theme setup for image handling scripts
zp_apply_filter

Performs a filtering operation on a zenphoto element or event. This function is called for each zenphoto element which supports plugin filtering. It is called after any zenphoto specific actions are completed and before the element is used.

zp_filter_slot
zp_filter_unique_id Build Unique ID for storage and retrieval.
zp_has_filter Check if any filter has been registered for a hook.
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 Removes a function from a specified filter hook.
zp_session_start
Zenphoto doc API documentation generated by ApiGen