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

Procedural File: template-functions.php

Source Location: /template-functions.php

Page Details
Page Details | Includes | Constants | Functions

Functions used to display content in themes.

Includes
Page Details | Includes | Constants | Functions
require_once (dirname(__FILE__).'/functions.php') [line 10]
[ Top ]


Constants
Page Details | Includes | Constants | Functions
ALBUM  [line 4338]

ALBUM = 2

[ Top ]

IMAGE  [line 4337]

IMAGE = 1

[ Top ]

SEO_FULLWEBPATH  [line 12]

SEO_FULLWEBPATH = FULLWEBPATH

[ Top ]

SEO_WEBPATH  [line 13]

SEO_WEBPATH = WEBPATH

[ Top ]


Functions
Page Details | Includes | Constants | Functions
albumNumber  [line 1015]

Gets the 'n' for n of m albums


int albumNumber( )

[ Top ]
checkAccess  [line 4463]

Checks to see if a password is needed

Returns true if access is allowed

The password protection is hereditary. This normally only impacts direct url access to an object since if you are going down the tree you will be stopped at the first place a password is required.

 Parameters:
string   $hint:  the password hint
bool   $show:  whether there is a user associated with the password.
   &$hint: 
   &$show: 

Information Tags:
Since:  1.1.3

bool checkAccess( [ &$hint = NULL], [ &$show = NULL], string $hint, bool $show  )

[ Top ]
checkForGuest  [line 4407]

returns the auth type of a guest login

Parameters:
string   $hint: 
string   $show: 
   &$hint: 
   &$show: 


string checkForGuest( [ &$hint = NULL], [ &$show = NULL], string $hint, string $show  )

[ Top ]
cleanHTML  [line 4620]

fixes unbalanced HTML tags. Used by shortenContent when PHP tidy is not present

Parameters:
string   $html: 


string cleanHTML( string $html  )

[ Top ]
exposeZenPhotoInformations  [line 4655]

Expose some informations in a HTML comment

Parameters:
string   $obj:  the path to the page being loaded
array   $plugins:  list of activated plugins
string   $theme:  The theme being used


void exposeZenPhotoInformations( [string $obj = ''], [array $plugins = ''], [string $theme = '']  )

[ Top ]
filterImageQuery  [line 3354]

performs a query and then filters out "illegal" images returning the first "good" image used by the random image functions.

Parameters:
object   $result:  query result
string   $source:  album object if this is search within the album


void filterImageQuery( object $result, string $source  )

[ Top ]
getAlbumBreadcrumb  [line 1069]

returns the breadcrumb item for the current images's album

Parameters:
string   $title:  Text to be used as the URL title tag


array getAlbumBreadcrumb( [string $title = NULL]  )

[ Top ]
getAlbumCustomData  [line 1471]

Returns the custom_data field of the current album


string getAlbumCustomData( )

[ Top ]
getAlbumData  [line 1492]

A composit for getting album data

Parameters:
string   $field:  which field you want


string getAlbumData( string $field  )

[ Top ]
getAlbumDate  [line 1319]

Returns the formatted date field of the album

Parameters:
string   $format:  optional format string for the date


string getAlbumDate( [string $format = null]  )

[ Top ]
getAlbumDesc  [line 1378]

Returns the raw description of the current album.


string getAlbumDesc( )

[ Top ]
getAlbumLinkURL  [line 1543]

Returns the album link url of the current album.

Parameters:
object   $album:  optional album object


string getAlbumLinkURL( [object $album = NULL]  )

[ Top ]
getAlbumLocation  [line 1359]

Returns the Location of the album.


string getAlbumLocation( )

[ Top ]
getAlbumPage  [line 1516]

Returns the album page number of the current image

Parameters:
object   $album:  optional album object


integer getAlbumPage( [object $album = NULL]  )

[ Top ]
getAlbumThumb  [line 1572]

Returns the name of the defined album thumbnail image.


string getAlbumThumb( )

[ Top ]
getAlbumTitle  [line 960]

Returns the raw title of the current album.


string getAlbumTitle( )

[ Top ]
getAllAlbums  [line 543]

Returns a list of all albums decendent from an album

Parameters:
object   $album:  optional album. If absent the current album is used


array getAllAlbums( [object $album = NULL]  )

[ Top ]
getAllDates  [line 3707]

Retrieves a list of all unique years & months from the images in the gallery

Parameters:
string   $order:  set to 'desc' for the list to be in descending order


array getAllDates( [string $order = 'asc']  )

[ Top ]
getAnnotatedAlbumTitle  [line 980]

Returns an album title taged with of Not visible or password protected status


string; getAnnotatedAlbumTitle( )

[ Top ]
getAnnotatedImageTitle  [line 2032]

Returns the image title taged with not visible annotation.


string getAnnotatedImageTitle( )

[ Top ]
getBareAlbumDesc  [line 1389]

Returns a text-only description of the current album.


string getBareAlbumDesc( )

[ Top ]
getBareAlbumTitle  [line 971]

Returns a text-only title of the current album.


string getBareAlbumTitle( )

[ Top ]
getBareGalleryDesc  [line 384]

Returns a text-only description of the gallery.


string getBareGalleryDesc( )

[ Top ]
getBareGalleryTitle  [line 354]

Returns a text-only title of the gallery.


string getBareGalleryTitle( )

[ Top ]
getBareImageDesc  [line 2182]

Returns a text-only description of the current image.


string getBareImageDesc( )

[ Top ]
getBareImageTitle  [line 2023]

Returns a text-only title of the current image.


string getBareImageTitle( )

[ Top ]
getCodeblock  [line 4698]

Gets the content of a codeblock for an image, album or Zenpage newsarticle or page.

The priority for codeblocks will be (based on context) 1: articles 2: pages 3: images 4: albums 5: gallery.

This means, for instance, if we are in ZP_ZENPAGE_NEWS_ARTICLE context we will use the news article codeblock even if others are available.

Note: Echoing this array's content does not execute it. Also no special chars will be escaped. Use printCodeblock() if you need to execute script code.

 Parameters:
int   $number:  The codeblock you want to get


string getCodeblock( [int $number = 0]  )

[ Top ]
getCommentAuthorEmail  [line 3081]

Returns the comment author's email


string getCommentAuthorEmail( )

[ Top ]
getCommentAuthorName  [line 3074]

Returns the comment author's name


string getCommentAuthorName( )

[ Top ]
getCommentAuthorSite  [line 3087]

Returns the comment author's website


string getCommentAuthorSite( )

[ Top ]
getCommentBody  [line 3135]

Returns the body of the current comment


string getCommentBody( )

[ Top ]
getCommentCount  [line 2974]

Retuns the count of comments on the current image


int getCommentCount( )

[ Top ]
getCommentDateTime  [line 3122]

Returns a formatted date and time for the comment.

Uses the "date_format" option for the formatting unless a format string is passed.

 Parameters:
string   $format:  'strftime' date/time format


string getCommentDateTime( [string $format = NULL]  )

[ Top ]
getCommentsAllowed  [line 2998]

Returns true if neither the album nor the image have comments closed


bool getCommentsAllowed( )

[ Top ]
getCommentStored  [line 3054]

Returns the data from the last comment posted

Parameters:
bool   $numeric:  Set to true for old themes to get 0->6 indices rather than descriptive ones


array getCommentStored( [bool $numeric = false]  )

[ Top ]
getCurrentPage  [line 532]

Returns the number of the current page without printing it.


int getCurrentPage( )

[ Top ]
getCurrentTheme  [line 477]

Returns the name of the currently active theme


string getCurrentTheme( )

[ Top ]
getCustomAlbumThumb  [line 1663]

Returns a link to a custom sized thumbnail of the current album

Parameters:
int   $size:  the size of the image to have
int   $width:  width
int   $height:  height
int   $cropw:  crop width
int   $croph:  crop height
int   $cropx:  crop part x axis
int   $cropy:  crop part y axis
bool   $effects:  image effects (e.g. set 'gray' to force grayscale)


string getCustomAlbumThumb( int $size, [int $width = NULL], [int $height = NULL], [int $cropw = NULL], [int $croph = NULL], [int $cropx = NULL], [int $cropy = null], [bool $effects = NULL]  )

[ Top ]
getCustomAlbumThumbMaxSpace  [line 1782]

Returns a link to a un-cropped custom sized version of the current album thumb within the given height and width dimensions.

Parameters:
int   $width:  width
int   $height:  height


string getCustomAlbumThumbMaxSpace( int $width, int $height  )

[ Top ]
getCustomImageURL  [line 2827]

Returns the url to the image with the dimensions you define with this function.

Parameters:
int   $size:  the size of the image to have
int   $width:  width
int   $height:  height
int   $cropw:  crop width
int   $croph:  crop height
int   $cropx:  crop part x axis
int   $cropy:  crop part y axis
bool   $thumbStandin:  set true to inhibit watermarking
bool   $effects:  image effects (e.g. set gray to force to grayscale)

API Tags:
Return:  

$width, and $height are used in determining the final image size. At least one of these must be provided. If $size is provided, $width and $height are ignored. If both $width and $height are provided, the image will have those dimensions regardless of the original image height/width ratio. (Yes, this means that the image may be distorted!)

The $crop* parameters determine the portion of the original image that will be incorporated into the final image.

$cropw and $croph "sizes" are typically proportional. That is you can set them to values that reflect the ratio of width to height that you want for the final image. Typically you would set them to the final height and width. These values will always be adjusted so that they are not larger than the original image dimensions.

The $cropx and $cropy values represent the offset of the crop from the top left corner of the image. If these values are provided, the $croph and $cropw parameters are treated as absolute pixels not proportions of the image. If cropx and cropy are not provided, the crop will be "centered" in the image.

When $cropx and $cropy are not provided the crop is offset from the top left proportionally to the ratio of the final image size and the crop size.

Some typical croppings:

$size=200, $width=NULL, $height=NULL, $cropw=200, $croph=100, $cropx=NULL, $cropy=NULL produces an image cropped to a 2x1 ratio which will fit in a 200x200 pixel frame.

$size=NULL, $width=200, $height=NULL, $cropw=200, $croph=100, $cropx=100, $cropy=10 will will take a 200x100 pixel slice from (10,100) of the picture and create a 200x100 image

$size=NULL, $width=200, $height=100, $cropw=200, $croph=120, $cropx=NULL, $cropy=NULL will produce a (distorted) image 200x100 pixels from a 1x0.6 crop of the image.

$size=NULL, $width=200, $height=NULL, $cropw=180, $croph=120, $cropx=NULL, $cropy=NULL will produce an image that is 200x133 from a 1.5x1 crop that is 5% from the left and 15% from the top of the image.


string getCustomImageURL( int $size, [int $width = NULL], [int $height = NULL], [int $cropw = NULL], [int $croph = NULL], [int $cropx = NULL], [int $cropy = NULL], [bool $thumbStandin = false], [bool $effects = NULL]  )

[ Top ]
getCustomPageURL  [line 3814]

Produces the url to a custom page (e.g. one that is not album.php, image.php, or index.php)

Parameters:
string   $linktext:  Text for the URL
string   $page:  page name to include in URL
string   $q:  query string to add to url
string   $album:  optional album for the page


string getCustomPageURL( string $page, [string $q = ''], [string $album = ''], string $linktext  )

[ Top ]
getCustomSizedImageMaxSpace  [line 2900]

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.

 Parameters:
int   $width:  width
int   $height:  height


string getCustomSizedImageMaxSpace( int $width, int $height  )

[ Top ]
getCustomSizedImageThumbMaxSpace  [line 2915]

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.

 Parameters:
int   $width:  width
int   $height:  height


string getCustomSizedImageThumbMaxSpace( int $width, int $height  )

[ Top ]
getDefaultHeight  [line 2541]

Returns the height of the default-sized image (in printDefaultSizedImage)

Parameters:
int   $size:  override the 'image_zize' option


int getDefaultHeight( [int $size = NULL]  )

[ Top ]
getDefaultSizedImage  [line 2583]

Returns the url to the default sized image.


string getDefaultSizedImage( )

[ Top ]
getDefaultWidth  [line 2529]

The width of the default-sized image (in printDefaultSizedImage)

Parameters:
int   $size:  override the 'image_zize' option


int getDefaultWidth( [int $size = NULL]  )

[ Top ]
getFullHeight  [line 2562]

Returns the height of the original image


int getFullHeight( )

[ Top ]
getFullImageURL  [line 2682]

Returns the url to original image.

It will return a protected image is the option "protect_full_image" is set

 Parameters:
$image   $image:  optional image object


string getFullImageURL( [$image $image = NULL]  )

[ Top ]
getFullWidth  [line 2551]

Returns the width of the original image


int getFullWidth( )

[ Top ]
getGalleryDesc  [line 374]

Returns the raw description of the gallery.


string getGalleryDesc( )

[ Top ]
getGalleryIndexURL  [line 427]

Returns the URL of the main gallery page containing the current album

Parameters:
bool   $relative:  set to false to get the true index page


string getGalleryIndexURL( [bool $relative = true]  )

[ Top ]
getGalleryTitle  [line 344]

Returns the raw title of the gallery.


string getGalleryTitle( )

[ Top ]
getHitcounter  [line 3315]

returns the hitcounter for the current page or for the object passed

Parameters:
object   $obj:  the album or page object for which the hitcount is desired


string getHitcounter( [object $obj = NULL]  )

[ Top ]
getImageCity  [line 2137]

Returns the City field of the current image


string getImageCity( )

[ Top ]
getImageCountry  [line 2159]

Returns the Country field of the current image


string getImageCountry( )

[ Top ]
getImageCustomData  [line 2215]

Returns the custom_data field of the current image


string getImageCustomData( )

[ Top ]
getImageData  [line 2204]

A composit for getting image data

Parameters:
string   $field:  which field you want


string getImageData( string $field  )

[ Top ]
getImageDate  [line 2086]

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

 Parameters:
string   $format:  formatting string for the data


string getImageDate( [string $format = null]  )

[ Top ]
getImageDesc  [line 2171]

Returns the raw description of the current image.

new lines are replaced with
tags
string getImageDesc( )

[ Top ]
getImageLinkURL  [line 2324]

Returns the url of the current image.


string getImageLinkURL( )

[ Top ]
getImageLocation  [line 2126]

Returns the Location field of the current image


string getImageLocation( )

[ Top ]
getImageMetaData  [line 2350]

Returns the Metadata infromation from the current image

Parameters:
string   $displayonly:  set to true to return only the items selected for display
$image   $image:  optional image object


array getImageMetaData( [$image $image = NULL], [string $displayonly = true]  )

[ Top ]
getImageState  [line 2148]

Returns the State field of the current image


string getImageState( )

[ Top ]
getImageThumb  [line 2624]

Returns the url to the thumbnail of the current image.


string getImageThumb( )

[ Top ]
getImageTitle  [line 2012]

Returns the raw title of the current image.


string getImageTitle( )

[ Top ]
getLatestComments  [line 3172]

Gets latest comments for images and albums

Parameters:
int   $number:  how many comments you want.
string   $type:  "all" for all latest comments of all images and albums "image" for the lastest comments of one specific image "album" for the latest comments of one specific album
int   $id:  the record id of element to get the comments for if $type != "all"


void getLatestComments( int $number, [string $type = "all"], [int $id = NULL]  )

[ Top ]
getMainSiteName  [line 405]

Returns the name of the main website as set by the "Website Title" option on the gallery options tab.


string getMainSiteName( )

[ Top ]
getMainSiteURL  [line 416]

Returns the URL of the main website as set by the "Website URL" option on the gallery options tab.


string getMainSiteURL( )

[ Top ]
getMaxSpaceContainer  [line 1739]

Called by ***MaxSpace functions to compute the parameters to be passed to xxCustomyyy functions.

Parameters:
int   $width:  maxspace width
int   $height:  maxspace height
object   $image:  the image in question
bool   $thumb:  true if for a thumbnail
   &$width: 
   &$height: 


void getMaxSpaceContainer( &$width, &$height, object $image, [bool $thumb = false], int $width, int $height  )

[ Top ]
getNextAlbum  [line 1812]

Returns the next album


object getNextAlbum( )

[ Top ]
getNextAlbumURL  [line 1829]

Get the URL of the next album in the gallery.


string getNextAlbumURL( )

[ Top ]
getNextImageThumb  [line 2311]

Returns the thumbnail of the next image.


string getNextImageThumb( )

[ Top ]
getNextImageURL  [line 2270]

Returns the url of the next image.


string getNextImageURL( )

[ Top ]
getNextPageURL  [line 664]

Returns the URL of the next page. Use within If or while loops for pagination.


string getNextPageURL( )

[ Top ]
getNumAlbums  [line 461]

Returns the number of albums.


int getNumAlbums( )

[ Top ]
getNumImages  [line 1900]

Returns the number of images in the album.


int getNumImages( )

[ Top ]
getPageNavList  [line 756]

returns a page nav list.

Parameters:
bool   $oneImagePage:  set to true if there is only one image page as, for instance, in flash themes
int   $navlen:  Number of navigation links to show (0 for all pages). Works best if the number is odd.
bool   $firstlast:  Add links to the first and last pages of you gallery
int   $current:  the current page
int   $total:  total number of pages


void getPageNavList( bool $oneImagePage, int $navlen, bool $firstlast, int $current, int $total  )

[ Top ]
getPageRedirect  [line 4505]

Returns a redirection link for the password form


string getPageRedirect( )

[ Top ]
getPageURL  [line 601]

Returns the URL of the page number passed as a parameter

Parameters:
int   $page:  Which page is desired
int   $total:  How many pages there are.


int getPageURL( int $page, [int $total = null]  )

[ Top ]
getParentAlbums  [line 1044]

Returns an array of the names of the parents of the current album.

Parameters:
object   $album:  optional album object to use inseted of the current album


array getParentAlbums( [object $album = null]  )

[ Top ]
getParentBreadcrumb  [line 1179]

returns the breadcrumb navigation for album, gallery and image view.


array getParentBreadcrumb( )

[ Top ]
getPasswordProtectImage  [line 1583]

Returns an img src link to the password protect thumb substitute

Parameters:
string   $extra:  extra stuff to put in the HTML


string getPasswordProtectImage( string $extra  )

[ Top ]
getPrevAlbum  [line 1843]

Returns the previous album


object getPrevAlbum( )

[ Top ]
getPrevAlbumURL  [line 1860]

Get the URL of the previous album in the gallery.


string getPrevAlbumURL( )

[ Top ]
getPrevImageThumb  [line 2298]

Returns the thumbnail of the previous image.


string getPrevImageThumb( )

[ Top ]
getPrevImageURL  [line 2284]

Returns the url of the previous image.


string getPrevImageURL( )

[ Top ]
getPrevPageURL  [line 698]

Returns the URL of the previous page.


string getPrevPageURL( )

[ Top ]
getProtectedImageURL  [line 2724]

Returns an url to the password protected/watermarked current image

Parameters:
object   $image:  optional image object overrides the current image
string   $disposal:  set to override the 'protect_full_image' option


string getProtectedImageURL( [object $image = NULL], [string $disposal = NULL]  )

[ Top ]
getRandomImages  [line 3378]

Returns a randomly selected image from the gallery. (May be NULL if none exists)

Parameters:
bool   $daily:  set to true and the picture changes only once a day.


object getRandomImages( [bool $daily = false]  )

[ Top ]
getRandomImagesAlbum  [line 3419]

Returns a randomly selected image from the album or its subalbums. (May be NULL if none exists)

Parameters:
mixed   $rootAlbum:  optional album object/folder from which to get the image.
bool   $daily:  set to true to change picture only once a day.


object getRandomImagesAlbum( [mixed $rootAlbum = NULL], [bool $daily = false]  )

[ Top ]
getRSSLink  [line 3875]

Prints a RSS link for printRSSLink() and printRSSHeaderLink()

Parameters:
string   $option:  type of RSS: "Gallery" feed for latest images of the whole gallery "Album" for latest images only of the album it is called from "Collection" for latest images of the album it is called from and all of its subalbums "Comments" for all comments of all albums and images "Comments-image" for latest comments of only the image it is called from "Comments-album" for latest comments of only the album it is called from "AlbumsRSS" for latest albums "AlbumsRSScollection" only for latest subalbums with the album it is called from or a getZenpageRSSLink option
string   $lang:  optional to display a feed link for a specific language. Enter the locale like "de_DE" (the locale must be installed on your Zenphoto to work of course). If empty the locale set in the admin option or the language selector (getOption('locale') is used.
string   $addl:  provided additional data for feeds (e.g. album object for album feeds, $categorylink for getZenpageRSSLink categories

Information Tags:
Since:  1.4.2

void getRSSLink( string $option, [string $lang = NULL], [string $addl = NULL]  )

[ Top ]
getSearchDate  [line 4325]

Returns the date of the search

Parameters:
string   $format:  formatting of the date, default 'F Y'

Information Tags:
Since:  1.1

string getSearchDate( [string $format = '%B %Y']  )

[ Top ]
getSearchURL  [line 4023]

Returns a search URL

Parameters:
mixed   $words:  the search words target
mixed   $dates:  the dates that limit the search
mixed   $fields:  the fields on which to search
int   $page:  the page number for the URL
array   $object_list:  the list of objects to search

Information Tags:
Since:  1.1.3

string getSearchURL( mixed $words, mixed $dates, mixed $fields, int $page, [array $object_list = NULL]  )

[ Top ]
getSearchWords  [line 4312]

Returns the a sanitized version of the search string

Information Tags:
Since:  1.1

string getSearchWords( )

[ Top ]
getSizeCustomImage  [line 2440]

Returns an array with the height & width

Parameters:
int   $size:  size
int   $width:  width
int   $height:  height
int   $cw:  crop width
int   $ch:  crop height
int   $cx:  crop x axis
int   $cy:  crop y axis


array getSizeCustomImage( int $size, [int $width = NULL], [int $height = NULL], [int $cw = NULL], [int $ch = NULL], [int $cx = NULL], [int $cy = NULL]  )

[ Top ]
getSizeDefaultImage  [line 2506]

Returns an array [width, height] of the default-sized image.

Parameters:
int   $size:  override the 'image_zize' option


array getSizeDefaultImage( [int $size = NULL]  )

[ Top ]
getSizedImageURL  [line 2765]

Returns a link to the current image custom sized to $size

Parameters:
int   $size:  The size the image is to be


void getSizedImageURL( int $size  )

[ Top ]
getSizeFullImage  [line 2516]

Returns an array [width, height] of the original image.


array getSizeFullImage( )

[ Top ]
getTags  [line 3554]

Returns a list of tags for context of the page called where called

Information Tags:
Since:  1.1

string getTags( )

[ Top ]
getTotalImagesIn  [line 1917]

Returns the count of all the images in the album and any subalbums

Parameters:
object   $album:  The album whose image count you want

Information Tags:
Since:  1.1.4

int getTotalImagesIn( object $album  )

[ Top ]
getTotalPages  [line 567]

Returns the number of pages for the current object

Parameters:
bool   $oneImagePage:  set to true if your theme collapses all image thumbs or their equivalent to one page. This is typical with flash viewer themes


int getTotalPages( [bool $oneImagePage = false]  )

[ Top ]
getUnprotectedImageURL  [line 2708]

Returns the "raw" url to the image in the albums folder

Parameters:
$image   $image:  optional image object


string getUnprotectedImageURL( [$image $image = NULL]  )

[ Top ]
getURL  [line 3853]

Returns the URL to an image (This is NOT the URL for the image.php page)

Parameters:
object   $image:  the image


string getURL( object $image  )

[ Top ]
getVersion  [line 26]

Returns the zenphoto version string


void getVersion( )

[ Top ]
hasNextImage  [line 2249]

True if there is a next image


bool hasNextImage( )

[ Top ]
hasNextPage  [line 655]

Returns true if there is a next page


bool hasNextPage( )

[ Top ]
hasPrevImage  [line 2259]

True if there is a previous image


bool hasPrevImage( )

[ Top ]
hasPrevPage  [line 689]

Returns TRUE if there is a previous page. Use within If or while loops for pagination.


bool hasPrevPage( )

[ Top ]
imageNumber  [line 2060]

Returns the 'n' of n of m images


int imageNumber( )

[ Top ]
isAlbumPage  [line 1889]

Returns true if this page has album thumbs on it


bool isAlbumPage( )

[ Top ]
isArchive  [line 4008]

tests if a search page is an "archive" page


bool isArchive( )

[ Top ]
isImagePage  [line 1874]

Returns true if this page has image thumbs on it


bool isImagePage( )

[ Top ]
isLandscape  [line 2573]

Returns true if the image is landscape-oriented (width is greater than height)


bool isLandscape( )

[ Top ]
makeAlbumCurrent  [line 949]

Sets the album passed as the current album

Parameters:
object   $album:  the album to be made current


void makeAlbumCurrent( object $album  )

[ Top ]
makeImageCurrent  [line 1999]

Sets the image passed as the current image

Parameters:
object   $image:  the image to become current


void makeImageCurrent( object $image  )

[ Top ]
next_album  [line 500]

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. Returns true if there are albums, false if none

 Parameters:
bool   $all:  true to go through all the albums
string   $sorttype:  overrides default sort type
string   $sortdirection:  overrides default sort direction
bool   $mine:  override the password checks

Information Tags:
Since:  0.6

bool next_album( [bool $all = false], [string $sorttype = NULL], [string $sortdirection = NULL], [bool $mine = NULL]  )

[ Top ]
next_comment  [line 3015]

Iterate through comments; use the ZP_COMMENT context.

Return true if there are more comments

 Parameters:
bool   $desc:  set true for desecnding order


bool next_comment( [bool $desc = false]  )

[ Top ]
next_image  [line 1946]

Returns the next image on a page.

sets $_zp_current_image to the next image in the album. Returns true if there is an image to be shown

 Parameters:
bool   $all:  set to true disable pagination
int   $firstPageCount:  the number of images which can go on the page that transitions between albums and images Normally this parameter should be NULL so as to use the default computations.
string   $sorttype:  overrides the default sort type
string   $sortdirection:  overrides the default sort direction.
bool   $mine:  overridePassword the password check


bool next_image( [bool $all = false], [int $firstPageCount = NULL], [string $sorttype = null], [string $sortdirection = NULL], [bool $mine = NULL]  )

[ Top ]
openedForComments  [line 4347]

Checks to see if comment posting is allowed for an image/album Returns true if comment posting should be allowed

Parameters:
int   $what:  the degree of control desired allowed values: ALBUM, IMAGE, and ALBUM+IMAGE


bool openedForComments( [int $what = 3]  )

[ Top ]
printAdminToolbox  [line 67]

Prints the clickable drop down toolbox on any theme page with generic admin helpers

Parameters:
string   $id:  the html/css theming id
bool   $customDIV:  set true to omit the show/hid divisions tags


void printAdminToolbox( [string $id = 'admin'], [bool $customDIV = false]  )

[ Top ]
printAlbumBreadcrumb  [line 1110]

prints the breadcrumb item for the current images's album

Parameters:
string   $before:  Text to place before the breadcrumb
string   $after:  Text to place after the breadcrumb
string   $title:  Text to be used as the URL title tag


void printAlbumBreadcrumb( [string $before = ''], [string $after = ''], [string $title = NULL]  )

[ Top ]
printAlbumCustomData  [line 1482]

Prints the custom_data field of the current album.

Converts and displays line break in the admin field as
.

 Information Tags:
Author:  Ozh

void printAlbumCustomData( )

[ Top ]
printAlbumData  [line 1505]

Prints arbitrary data from the album object

Parameters:
string   $field:  the field name of the data desired
string   $label:  text to label the field

Information Tags:
Author:  Ozh

void printAlbumData( string $field, [string $label = '']  )

[ Top ]
printAlbumDate  [line 1339]

Prints the date of the current album

Parameters:
string   $before:  Insert here the text to be printed before the date.
string   $nonemessage:  Insert here the text to be printed if there is no date.
string   $format:  Format string for the date formatting

Information Tags:
Author:  Ozh

void printAlbumDate( [string $before = ''], [string $nonemessage = ''], [string $format = null]  )

[ Top ]
printAlbumDesc  [line 1398]

Prints description of the current album

Information Tags:
Author:  Ozh

void printAlbumDesc( )

[ Top ]
printAlbumLink  [line 1563]

Prints the album link url of the current album.

Parameters:
string   $text:  Insert the link text here.
string   $title:  Insert the title text here.
string   $class:  Insert here the CSS-class name with with you want to style the link.
string   $id:  Insert here the CSS-id name with with you want to style the link.


void printAlbumLink( string $text, string $title, [string $class = NULL], [string $id = NULL]  )

[ Top ]
printAlbumLocation  [line 1369]

Prints the location of the album

Information Tags:
Author:  Ozh

void printAlbumLocation( )

[ Top ]
printAlbumThumbImage  [line 1604]

Prints the album thumbnail image.

Parameters:
string   $alt:  Insert the text for the alternate image name here.
string   $class:  Insert here the CSS-class name with with you want to style the link.
string   $id:  Insert here the CSS-id name with with you want to style the link.


void printAlbumThumbImage( string $alt, [string $class = NULL], [string $id = NULL]  )

[ Top ]
printAlbumTitle  [line 1002]

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.

 Information Tags:
Author:  Ozh

void printAlbumTitle( )

[ Top ]
printAllDates  [line 3754]

Prints a compendum of dates and links to a search page that will show results of the date

Parameters:
string   $class:  optional class
string   $yearid:  optional class for "year"
string   $monthid:  optional class for "month"
string   $order:  set to 'desc' for the list to be in descending order


void printAllDates( [string $class = 'archive'], [string $yearid = 'year'], [string $monthid = 'month'], [string $order = 'asc']  )

[ Top ]
printAllTagsAs  [line 3644]

Either prints all of the galleries tgs as a UL list or a cloud

Parameters:
string   $option:  "cloud" for tag cloud, "list" for simple list
string   $class:  CSS class
string   $sort:  "results" for relevance list, "abc" for alphabetical, blank for unsorted
bool   $counter:  TRUE if you want the tag count within brackets behind the tag
bool   $links:  set to TRUE to have tag search links included with the tag.
int   $maxfontsize:  largest font size the cloud should display
int   $maxcount:  the floor count for setting the cloud font size to $maxfontsize
int   $mincount:  the minimum count for a tag to appear in the output
int   $limit:  set to limit the number of tags displayed to the top $numtags
int   $minfontsize:  minimum font size the cloud should display

Information Tags:
Since:  1.1

void printAllTagsAs( string $option, [string $class = ''], [string $sort = 'abc'], [bool $counter = FALSE], [bool $links = TRUE], [int $maxfontsize = 2], [int $maxcount = 50], [int $mincount = 10], [int $limit = NULL], [int $minfontsize = 0.8]  )

[ Top ]
printAnnotatedAlbumTitle  [line 992]

void printAnnotatedAlbumTitle( )

[ Top ]
printAnnotatedImageTitle  [line 2040]

void printAnnotatedImageTitle( )

[ Top ]
printBareAlbumDesc  [line 1402]

void printBareAlbumDesc( )

[ Top ]
printBareAlbumTitle  [line 1006]

void printBareAlbumTitle( )

[ Top ]
printBareGalleryDesc  [line 395]

void printBareGalleryDesc( )

[ Top ]
printBareGalleryTitle  [line 365]

void printBareGalleryTitle( )

[ Top ]
printBareImageDesc  [line 2194]

void printBareImageDesc( )

[ Top ]
printBareImageTitle  [line 2051]

void printBareImageTitle( )

[ Top ]
printCaptcha  [line 4591]

Simple captcha for comments.

Prints a captcha entry field for a form such as the comments form.

 Parameters:
string   $preText:  lead-in text
string   $midText:  text that goes between the captcha image and the input field
string   $postText:  text that closes the captcha
int   $size:  the text-width of the input field

Information Tags:
Since:  1.1.4

void printCaptcha( [string $preText = ''], [string $midText = ''], [string $postText = ''], [int $size = 4]  )

[ Top ]
printCodeblock  [line 4741]

Prints the content of a codeblock for an image, album or Zenpage newsarticle or page.

NOTE: This executes PHP and JavaScript code if available

 Parameters:
int   $number:  The codeblock you want to get
mixed   $what:  optonal object for which you want the codeblock


string printCodeblock( [int $number = 0], [mixed $what = NULL]  )

[ Top ]
printCommentAuthorLink  [line 3096]

Prints a link to the author

Parameters:
string   $title:  URL title tag
string   $class:  optional class tag
string   $id:  optional id tag


void printCommentAuthorLink( [string $title = NULL], [string $class = NULL], [string $id = NULL]  )

[ Top ]
printCustomAlbumThumbImage  [line 1687]

Prints a link to a custom sized thumbnail of the current album

See getCustomImageURL() for details.

 Parameters:
string   $alt:  Alt atribute text
int   $size:  size
int   $width:  width
int   $height:  height
int   $cropw:  cropwidth
int   $croph:  crop height
int   $cropx:  crop part x axis
int   $cropy:  crop part y axis
string   $class:  css class
string   $id:  css id


string printCustomAlbumThumbImage( string $alt, int $size, [int $width = NULL], [int $height = NULL], [int $cropw = NULL], [int $croph = NULL], [int $cropx = NULL], [int $cropy = null], [string $class = NULL], [string $id = NULL]  )

[ Top ]
printCustomAlbumThumbMaxSpace  [line 1800]

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

 Parameters:
string   $alt:  Alt text for the url
int   $width:  width
int   $height:  height
string   $class:  Optional style class
string   $id:  Optional style id
bool   $thumbStandin:  set to true to treat as thumbnail


void printCustomAlbumThumbMaxSpace( [string $alt = ''], int $width, int $height, [string $class = NULL], [string $id = NULL], bool $thumbStandin  )

[ Top ]
printCustomPageURL  [line 3840]

Prints the url to a custom page (e.g. one that is not album.php, image.php, or index.php)

Parameters:
string   $linktext:  Text for the URL
string   $page:  page name to include in URL
string   $q:  query string to add to url
string   $prev:  text to insert before the URL
string   $next:  text to follow the URL
string   $class:  optional class


void printCustomPageURL( string $linktext, string $page, [string $q = ''], [string $prev = ''], [string $next = ''], [string $class = NULL]  )

[ Top ]
printCustomSizedImage  [line 2858]

Print normal video or custom sized images.

Note: a class of 'not_visible' or 'password_protected' will be added as appropriate

Notes on cropping:

The $crop* parameters determine the portion of the original image that will be incorporated into the final image. The w and h "sizes" are typically proportional. That is you can set them to values that reflect the ratio of width to height that you want for the final image. Typically you would set them to the fincal height and width.

 Parameters:
string   $alt:  Alt text for the url
int   $size:  size
int   $width:  width
int   $height:  height
int   $cropw:  crop width
int   $croph:  crop height
int   $cropx:  crop x axis
int   $cropy:  crop y axis
string   $class:  Optional style class
string   $id:  Optional style id
bool   $thumbStandin:  set to true to treat as thumbnail
bool   $effects:  image effects (e.g. set gray to force grayscale)


void printCustomSizedImage( string $alt, int $size, [int $width = NULL], [int $height = NULL], [int $cropw = NULL], [int $croph = NULL], [int $cropx = NULL], [int $cropy = NULL], [string $class = NULL], [string $id = NULL], [bool $thumbStandin = false], [bool $effects = NULL]  )

[ Top ]
printCustomSizedImageMaxSpace  [line 2948]

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

 Parameters:
string   $alt:  Alt text for the url
int   $width:  width
int   $height:  height
string   $class:  Optional style class
string   $id:  Optional style id
   $thumb: 


void printCustomSizedImageMaxSpace( [string $alt = ''], int $width, int $height, [string $class = NULL], [string $id = NULL], [ $thumb = false]  )

[ Top ]
printCustomSizedImageThumbMaxSpace  [line 2931]

Creates image thumbnails which will fit un-cropped within the width & height parameters given

Parameters:
string   $alt:  Alt text for the url
int   $width:  width
int   $height:  height
string   $class:  Optional style class
string   $id:  Optional style id


void printCustomSizedImageThumbMaxSpace( [string $alt = ''], int $width, int $height, [string $class = NULL], [string $id = NULL]  )

[ Top ]
printDefaultSizedImage  [line 2596]

Show video player with video loaded or display the image.

Parameters:
string   $alt:  Alt text
string   $class:  Optional style class
string   $id:  Optional style id


void printDefaultSizedImage( string $alt, [string $class = NULL], [string $id = NULL]  )

[ Top ]
printEditCommentLink  [line 3150]

Creates a link to the admin comment edit page for the current comment

Parameters:
string   $text:  Link text
string   $before:  text to go before the link
string   $after:  text to go after the link
string   $title:  title text
string   $class:  optional css clasee
string   $id:  optional css id


void printEditCommentLink( string $text, [string $before = ''], [string $after = ''], [string $title = NULL], [string $class = NULL], [string $id = NULL]  )

[ Top ]
printField  [line 1418]

Print any album or image data

Parameters:
string   $context:  either 'image' or 'album'
string   $field:  the data field to echo & edit if applicable: 'date', 'title', 'place', 'description', ...
bool   $convertBR:  when true, converts new line characters into HTML line breaks
string   $override:  if not empty, print this string instead of fetching field value from database
string   $label:  "label" text to print if the field is not empty

Information Tags:
Author:  Ozh
Since:  1.3

void printField( string $context, string $field, [bool $convertBR = NULL], [string $override = false], [string $label = '']  )

[ Top ]
printGalleryDesc  [line 391]

Prints the description of the gallery.


void printGalleryDesc( )

[ Top ]
printGalleryTitle  [line 361]

Prints the title of the gallery.


void printGalleryTitle( )

[ Top ]
printHomeLink  [line 1291]

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

Parameters:
string   $before:  text to precede the link
string   $after:  text to follow the link
string   $title:  Title text
string   $class:  optional css class
string   $id:  optional css id


void printHomeLink( [string $before = ''], [string $after = ''], [string $title = NULL], [string $class = NULL], [string $id = NULL]  )

[ Top ]
printImageCustomData  [line 2226]

Prints the custom_data field of the current image.

Converts and displays line breaks set in the admin field as
.
string printImageCustomData( )

[ Top ]
printImageData  [line 2240]

Prints arbitrary data from the image object

Parameters:
string   $field:  the field name of the data desired
string   $label:  text to label the field.

Information Tags:
Author:  Ozh

void printImageData( string $field, [string $label = '']  )

[ Top ]
printImageDate  [line 2107]

Prints the date of the current album

Parameters:
string   $before:  Insert here the text to be printed before the date.
string   $nonemessage:  Insert here the text to be printed if there is no date.
string   $format:  Format string for the date formatting

Information Tags:
Author:  Ozh

void printImageDate( [string $before = ''], [string $nonemessage = ''], [string $format = null]  )

[ Top ]
printImageDesc  [line 2191]

Prints the description of the current image.

Converts and displays line breaks set in the admin field as
.
void printImageDesc( )

[ Top ]
printImageLink  [line 2339]

Prints the link to the current image.

Parameters:
string   $text:  text for the link
string   $title:  title tag for the link
string   $class:  optional style class for the link
string   $id:  optional style id for the link


void printImageLink( string $text, string $title, [string $class = NULL], [string $id = NULL]  )

[ Top ]
printImageMetadata  [line 2379]

Prints the Metadata data of the current image

Parameters:
string   $title:  title tag for the class
bool   $toggle:  set to true to get a javascript toggle on the display of the data
string   $id:  style class id
string   $class:  style class
   $span: 

Information Tags:
Author:  Ozh

void printImageMetadata( [string $title = NULL], [bool $toggle = true], [string $id = 'imagemetadata'], [string $class = null], [ $span = NULL]  )

[ Top ]
printImageThumb  [line 2634]
Parameters:
string   $alt:  Alt text
string   $class:  optional class tag
string   $id:  optional id tag


void printImageThumb( string $alt, [string $class = NULL], [string $id = NULL]  )

[ Top ]
printImageTitle  [line 2048]

Prints title of the current image

Information Tags:
Author:  Ozh

void printImageTitle( )

[ Top ]
printLatestComments  [line 3276]

Prints out latest comments for images and albums

Parameters:
see   $number:  getLatestComments
   $shorten: 
   $type: 
   $item: 


void printLatestComments( see $number, [ $shorten = '123'], [ $type = "all"], [ $item = NULL]  )

[ Top ]
printNextPageLink  [line 676]

Prints the URL of the next page.

Parameters:
string   $text:  text for the URL
string   $title:  Text for the HTML title
string   $class:  Text for the HTML class
string   $id:  Text for the HTML id


void printNextPageLink( string $text, [string $title = NULL], [string $class = NULL], [string $id = NULL]  )

[ Top ]
printPageList  [line 742]

Prints a list of all pages.

Parameters:
string   $class:  the css class to use, "pagelist" by default
string   $id:  the css id to use
int   $navlen:  Number of navigation links to show (0 for all pages). Works best if the number is odd.


void printPageList( [string $class = 'pagelist'], [string $id = NULL], [int $navlen = 9]  )

[ Top ]
printPageListWithNav  [line 804]

Prints a full page navigation including previous and next page links with a list of all pages in between.

Parameters:
string   $prevtext:  Insert here the linktext like 'previous page'
string   $nexttext:  Insert here the linktext like 'next page'
bool   $oneImagePage:  set to true if there is only one image page as, for instance, in flash themes
string   $nextprev:  set to true to get the 'next' and 'prev' links printed
string   $class:  Insert here the CSS-class name you want to style the link with (default is "pagelist")
string   $id:  Insert here the CSS-ID name if you want to style the link with this
bool   $firstlast:  Add links to the first and last pages of you gallery
int   $navlen:  Number of navigation links to show (0 for all pages). Works best if the number is odd.


void printPageListWithNav( string $prevtext, string $nexttext, [bool $oneImagePage = false], [string $nextprev = true], [string $class = 'pagelist'], [string $id = NULL], [bool $firstlast = true], [int $navlen = 9]  )

[ Top ]
printPageNav  [line 727]

Prints a page navigation including previous and next page links

Parameters:
string   $prevtext:  Insert here the linktext like 'previous page'
string   $separator:  Insert here what you like to be shown between the prev and next links
string   $nexttext:  Insert here the linktext like "next page"
string   $class:  Insert here the CSS-class name you want to style the link with (default is "pagelist")
string   $id:  Insert here the CSS-ID name if you want to style the link with this


void printPageNav( string $prevtext, string $separator, string $nexttext, [string $class = 'pagenav'], [string $id = NULL]  )

[ Top ]
printParentBreadcrumb  [line 1242]

Prints the breadcrumb navigation for album, gallery and image view.

Parameters:
string   $before:  Insert here the text to be printed before the links
string   $between:  Insert here the text to be printed between the links
string   $after:  Insert here the text to be printed after the links
mixed   $truncate:  if not empty, the max lenght of the description.
string   $elipsis:  the text to append to the truncated description


void printParentBreadcrumb( [string $before = NULL], [string $between = NULL], [string $after = NULL], [mixed $truncate = NULL], [string $elipsis = NULL]  )

[ Top ]
printPasswordForm  [line 4551]

Prints the album password form

Parameters:
string   $hint:  hint to the password
bool   $showProtected:  set false to supress the password protected message
bool   $showuser:  set true to force the user name filed to be present
string   $redirect:  optional URL to send the user to after successful login
   $_password_hint: 
   $_password_showuser: 
   $_password_showProtected: 
   $_password_redirect: 

Information Tags:
Since:  1.1.3

void printPasswordForm( $_password_hint, [ $_password_showuser = NULL], [ $_password_showProtected = true], [ $_password_redirect = NULL], string $hint, bool $showProtected, bool $showuser, string $redirect  )

[ Top ]
printPrevPageLink  [line 710]

Returns the URL of the previous page.

Parameters:
string   $text:  The linktext that should be printed as a link
string   $title:  The text the html-tag "title" should contain
string   $class:  Insert here the CSS-class name you want to style the link with
string   $id:  Insert here the CSS-ID name you want to style the link with


void printPrevPageLink( string $text, [string $title = NULL], [string $class = NULL], [string $id = NULL]  )

[ Top ]
printRandomImages  [line 3498]

Puts up random image thumbs from the gallery

Parameters:
int   $number:  how many images
string   $class:  optional class
string   $option:  what you want selected: all for all images, album for selected ones from an album
mixed   $rootAlbum:  optional album object/folder from which to get the image.
integer   $width:  the width/cropwidth of the thumb if crop=true else $width is longest size.
integer   $height:  the height/cropheight of the thumb if crop=true else not used
bool   $crop:  'true' (default) if the thumb should be cropped, 'false' if not
bool   $fullimagelink:  'false' (default) for the image page link , 'true' for the unprotected full image link (to use Colorbox for example)


void printRandomImages( [int $number = 5], [string $class = null], [string $option = 'all'], [mixed $rootAlbum = ''], [integer $width = NULL], [integer $height = NULL], [bool $crop = NULL], [bool $fullimagelink = false]  )

[ Top ]
printRSSHeaderLink  [line 3990]

Prints the RSS link for use in the HTML HEAD

Parameters:
string   $option:  type of RSS: "Gallery" feed for latest images of the whole gallery "Album" for latest images only of the album it is called from "Collection" for latest images of the album it is called from and all of its subalbums "Comments" for all comments of all albums and images "Comments-image" for latest comments of only the image it is called from "Comments-album" for latest comments of only the album it is called from "AlbumsRSS" for latest albums "AlbumsRSScollection" only for latest subalbums with the album it is called from
string   $linktext:  title of the link
string   $lang:  optional to display a feed link for a specific language. Enter the locale like "de_DE" (the locale must be installed on your Zenphoto to work of course). If empty the locale set in the admin option or the language selector (getOption('locale') is used.

Information Tags:
Since:  1.1.6

void printRSSHeaderLink( string $option, string $linktext, [string $lang = '']  )

[ Top ]
printRSSLink  [line 3959]

Prints an RSS link

Parameters:
string   $option:  type of RSS: "Gallery" feed for latest images of the whole gallery "Album" for latest images only of the album it is called from "Collection" for latest images of the album it is called from and all of its subalbums "Comments" for all comments of all albums and images "Comments-image" for latest comments of only the image it is called from "Comments-album" for latest comments of only the album it is called from "AlbumsRSS" for latest albums "AlbumsRSScollection" only for latest subalbums with the album it is called from
string   $prev:  text to before before the link
string   $linktext:  title of the link
string   $next:  text to appear after the link
bool   $printIcon:  print an RSS icon beside it? if true, the icon is zp-core/images/rss.png
string   $class:  css class
string   $lang:  optional to display a feed link for a specific language. Enter the locale like "de_DE" (the locale must be installed on your Zenphoto to work of course). If empty the locale set in the admin option or the language selector (getOption('locale') is used.

Information Tags:
Since:  1.1

void printRSSLink( string $option, string $prev, string $linktext, string $next, [bool $printIcon = true], [string $class = null], [string $lang = '']  )

[ Top ]
printSearchBreadcrumb  [line 1137]

Prints the "breadcrumb" for a search page

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

 Parameters:
string   $between:  Insert here the text to be printed between the links
string   $class:  is the class for the link (if present)
string   $search:  text for a search page title
string   $archive:  text for an archive page title
string   $format:  data format for archive page crumb


void printSearchBreadcrumb( [string $between = NULL], [string $class = NULL], [string $search = NULL], [string $archive = NULL], [string $format = '%B %Y']  )

[ Top ]
printSearchForm  [line 4138]

Prints the search form

Search works on a list of tokens entered into the search form.

Tokens may be part of boolean expressions using &, |, !, and parens. (Comma is retained as a synonom of | for backwords compatibility.)

Tokens may be enclosed in quotation marks to create exact pattern matches or to include the boolean operators and parens as part of the tag..

 Parameters:
string   $prevtext:  text to go before the search form
string   $id:  css id for the search form, default is 'search'
string   $buttonSource:  optional path to the image for the button or if not a path to an image, this will be the button hint
string   $buttontext:  optional text for the button ("Search" will be the default text)
string   $iconsource:  optional theme based icon for the search fields toggle
array   $query_fields:  override selection for enabled fields with this list
array   $objects_list:  optional array of things to search eg. [albums]=>[list], etc. if the list is simply 0, the objects will be omitted from the search
string   $within:  set to true to search within current results, false to search fresh
   $object_list: 

Information Tags:
Since:  1.1.3

void printSearchForm( [string $prevtext = NULL], [string $id = 'search'], [string $buttonSource = NULL], [string $buttontext = ''], [string $iconsource = NULL], [array $query_fields = NULL], [ $object_list = NULL], [string $within = NULL], array $objects_list  )

[ Top ]
printSizedImageLink  [line 2964]

Prints link to an image of specific size

Parameters:
int   $size:  how big
string   $text:  URL text
string   $title:  URL title
string   $class:  optional URL class
string   $id:  optional URL id


void printSizedImageLink( int $size, string $text, string $title, [string $class = NULL], [string $id = NULL]  )

[ Top ]
printTags  [line 3581]

Prints a list of tags, editable by admin

Parameters:
string   $option:  links by default, if anything else the tags will not link to all other images with the same tag
string   $preText:  text to go before the printed tags
string   $class:  css class to apply to the div surrounding the UL list
string   $separator:  what charactor shall separate the tags

Information Tags:
Since:  1.1

void printTags( [string $option = 'links'], [string $preText = NULL], [string $class = NULL], [string $separator = ', ']  )

[ Top ]
printVersion  [line 33]

Prints the zenphoto version string


void printVersion( )

[ Top ]
printZenJavascripts  [line 40]

Print any Javascript required by zenphoto.


void printZenJavascripts( )

[ Top ]
printZenphotoLink  [line 4610]

prints the zenphoto logo and link


void printZenphotoLink( )

[ Top ]
setThemeColumns  [line 4369]

controls the thumbnail layout of themes.

Uses the theme options: albums_per_row albums_per_page images_per_row images_per_page

Computes a normalized images/albums per page and computes the number of images that will fit on the "transitional" page between album thumbs and image thumbs. This function is "internal" and is called from the root index.php script before the theme script is loaded.
void setThemeColumns( )

[ Top ]
functions
Packages:
core
admin
classes
functions
GoogleMapAPI
JSMin
OpenID
PHPMailer
plugins
Services_JSON

Files:
functions-basic.php
functions-filter.php
functions.php
template-functions.php

Classes:
Mutex
zpFunctions
Documentation generated on Sat, 05 Jan 2013 15:51:26 +0100 by phpDocumentor 1.4.3