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