ZenphotoCMS 1.6.6

dprecatedfunctions

Classes

zpFunctions

Constants

OFFSET_PATH = 4: Check for use of deprecated functions

Functions

setThemeColumns() : mixed: controls the thumbnail layout of themes.
getMimeString() : string: Returns the mimetype for a suffix
newAlbum() : Album: Wrapper instantiation function for albums. Do not instantiate directly
isAlbumClass() : bool: Returns true if the object is a zenphoto 'album'
getUrAlbum() : object: Returns the oldest ancestor of an alubm;
newImage() : object: Returns a new "image" object based on the file extension
isImageClass() : bool: Returns true if the object is a zenphoto 'image'
search_quote() : string: encloses search word in quotes if needed
isImageVideo() : bool: Returns video argument of the current Image.
isImagePhoto() : bool: Returns true if the image is a standard photo type
replaceOption() : mixed: Replaces/renames an option. If the old option exits, it creates the new option with the old option's value as the default unless the new option has already been set otherwise. Independently it always deletes the old option.
is_valid_email_zp() : bool: Determines if the input is an e-mail address. Adapted from WordPress.
genAlbumList() : mixed: Populatest $list with an one dimensional list with album name and title of all albums or the subalbums of a specific album
getAllAlbums() : array<string|int, mixed>: Returns a list of all albums decendent from an album
printPopularAlbums() : mixed
printLatestAlbums() : mixed
printMostRatedAlbums() : mixed
printTopRatedAlbums() : mixed
printLatestUpdatedAlbums() : mixed
printPopularImages() : mixed
printTopRatedImages() : mixed
printMostRatedImages() : mixed
printLatestImages() : mixed
printLatestImagesByDate() : mixed
printLatestImagesByMtime() : mixed
filterImageQuery() : mixed: performs a query and then filters out "illegal" images returning the first "good" image used by the random image functions.
getRandomImages() : object: Returns a randomly selected image from the gallery. (May be NULL if none exists)
getRandomImagesAlbum() : object: Returns a randomly selected image from the album or its subalbums. (May be NULL if none exists)
printRandomImages() : mixed: Puts up random image thumbs from the gallery
cleanHTML() : string: fixes unbalanced HTML tags. Used by shortenContent when PHP tidy is not present
getTotalImagesIn() : int: Returns the count of all the images in the album and any subalbums
checkPublishDates() : mixed: checks if the item has expired
getPHPFiles() : string
formatList() : bool
listUses() : type
listDBUses() : bool

OFFSET_PATH

Check for use of deprecated functions


    public
        mixed
    OFFSET_PATH
    = 4

setThemeColumns()

controls the thumbnail layout of themes.

This function is obsolete and has no functionality anymore


    
                    setThemeColumns() : mixed

Uses the theme options: albums_per_row albums_per_page images_per_row images_per_page

getMimeString()

Returns the mimetype for a suffix

Use mimeTypes::getType(m() instead


    
                    getMimeString(string $suffix) : string

Parameters

$suffix : string: Suffix without . to get the mimetype for

Return values

string

newAlbum()

Wrapper instantiation function for albums. Do not instantiate directly

Use AlbumBase::newAlbum() instead


    
                    newAlbum(string $folder8[, bool $cache = true ][, bool $quiet = false ]) : Album

Parameters

$folder8 : string: the name of the folder (inernal character set)
$cache : bool = true: true if the album should be fetched from the cache
$quiet : bool = false: true to supress error messages

Return values

Album

isAlbumClass()

Returns true if the object is a zenphoto 'album'

Use AlbumBase::siAlbumClass() instead


    
                    isAlbumClass([object $album = NULL ]) : bool

Parameters

$album : object = NULL

Return values

bool

getUrAlbum()

Returns the oldest ancestor of an alubm;

– Use $album->getUrParent() instead


    
                    getUrAlbum(string $album) : object

Parameters

$album : string: an album object

Return values

object

newImage()

Returns a new "image" object based on the file extension

Use Image::newImage() instead


    
                    newImage(object $album, string $filename[, bool $quiet = false ]) : object

Parameters

$album : object: the owner album
$filename : string: the filename
$quiet : bool = false: set true to supress error messages (used by loadimage)

Return values

object

isImageClass()

Returns true if the object is a zenphoto 'image'

Use Image::isImageClass() instead


    
                    isImageClass([object $image = NULL ]) : bool

Parameters

$image : object = NULL

Return values

bool

search_quote()

encloses search word in quotes if needed

Use SearchEngine::getSearchQuote() instead


    
                    search_quote(string $word) : string

Parameters

$word : string

Return values

string

isImageVideo()

Returns video argument of the current Image.

– Use the Image class method isVideo() instead


    
                    isImageVideo([object $image = NULL ]) : bool

Parameters

$image : object = NULL: optional image object

Return values

bool

isImagePhoto()

Returns true if the image is a standard photo type

– Use the Image class method isPhoto() instead


    
                    isImagePhoto([object $image = NULL ]) : bool

Parameters

$image : object = NULL: optional image object

Return values

bool

replaceOption()

Replaces/renames an option. If the old option exits, it creates the new option with the old option's value as the default unless the new option has already been set otherwise. Independently it always deletes the old option.

– Use renameOptionl() instead


    
                    replaceOption(string $oldkey, string $newkey) : mixed

Parameters

$oldkey : string: Old option name
$newkey : string: New option name

is_valid_email_zp()

Determines if the input is an e-mail address. Adapted from WordPress.

– Use isValidEmail() instead


    
                    is_valid_email_zp(string $input_email) : bool

Name changed to avoid conflicts in WP integrations.

Parameters

$input_email : string: email address?

Return values

bool

genAlbumList()

Populatest $list with an one dimensional list with album name and title of all albums or the subalbums of a specific album

– Use the gallery class method getAllAlbums() or getAllAlbumsFromDB() instead


    
                    genAlbumList(array<string|int, mixed> &$list[, obj $curAlbum = NULL ][, int $rights = UPLOAD_RIGHTS ]) : mixed

Parameters

$list : array<string|int, mixed>: The array to fill with the album list
$curAlbum : obj = NULL: Optional object of the album to start with
$rights : int = UPLOAD_RIGHTS: Rights constant to filter album access by.

getAllAlbums()

Returns a list of all albums decendent from an album

– Use the gallery class method getAllAlbums() or getAllAlbumsFromDB() instead


    
                    getAllAlbums([object $album = NULL ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

printPopularAlbums()

– Use printAlbumStatistisc() instead


    
                    printPopularAlbums([mixed $number = 5 ][, mixed $showtitle = false ][, mixed $showdate = false ][, mixed $showdesc = false ][, mixed $desclength = 40 ][, mixed $showstatistic = 'hitcounter' ][, mixed $width = NULL ][, mixed $height = NULL ][, mixed $crop = NULL ][, mixed $albumfolder = '' ][, mixed $firstimglink = false ][, mixed $threshold = 0 ][, mixed $collection = false ]) : mixed

Parameters

$number : mixed = 5
$showtitle : mixed = false
$showdate : mixed = false
$showdesc : mixed = false
$desclength : mixed = 40
$showstatistic : mixed = 'hitcounter'
$width : mixed = NULL
$height : mixed = NULL
$crop : mixed = NULL
$albumfolder : mixed = ''
$firstimglink : mixed = false
$threshold : mixed = 0
$collection : mixed = false

printLatestAlbums()

– Use printAlbumStatistisc() instead


    
                    printLatestAlbums([mixed $number = 5 ][, mixed $showtitle = false ][, mixed $showdate = false ][, mixed $showdesc = false ][, mixed $desclength = 40 ][, mixed $showstatistic = '' ][, mixed $width = NULL ][, mixed $height = NULL ][, mixed $crop = NULL ][, mixed $albumfolder = '' ][, mixed $firstimglink = false ][, mixed $collection = false ]) : mixed

Parameters

$number : mixed = 5
$showtitle : mixed = false
$showdate : mixed = false
$showdesc : mixed = false
$desclength : mixed = 40
$showstatistic : mixed = ''
$width : mixed = NULL
$height : mixed = NULL
$crop : mixed = NULL
$albumfolder : mixed = ''
$firstimglink : mixed = false
$collection : mixed = false

printMostRatedAlbums()

– Use printAlbumStatistisc() instead


    
                    printMostRatedAlbums([mixed $number = 5 ][, mixed $showtitle = false ][, mixed $showdate = false ][, mixed $showdesc = false ][, mixed $desclength = 40 ][, mixed $showstatistic = '' ][, mixed $width = NULL ][, mixed $height = NULL ][, mixed $crop = NULL ][, mixed $albumfolder = '' ][, mixed $firstimglink = false ][, mixed $threshold = 0 ][, mixed $collection = false ]) : mixed

Parameters

$number : mixed = 5
$showtitle : mixed = false
$showdate : mixed = false
$showdesc : mixed = false
$desclength : mixed = 40
$showstatistic : mixed = ''
$width : mixed = NULL
$height : mixed = NULL
$crop : mixed = NULL
$albumfolder : mixed = ''
$firstimglink : mixed = false
$threshold : mixed = 0
$collection : mixed = false

printTopRatedAlbums()

– Use printAlbumStatistisc() instead


    
                    printTopRatedAlbums([mixed $number = 5 ][, mixed $showtitle = false ][, mixed $showdate = false ][, mixed $showdesc = false ][, mixed $desclength = 40 ][, mixed $showstatistic = '' ][, mixed $width = NULL ][, mixed $height = NULL ][, mixed $crop = NULL ][, mixed $albumfolder = '' ][, mixed $firstimglink = false ][, mixed $threshold = 0 ][, mixed $collection = false ]) : mixed

Parameters

$number : mixed = 5
$showtitle : mixed = false
$showdate : mixed = false
$showdesc : mixed = false
$desclength : mixed = 40
$showstatistic : mixed = ''
$width : mixed = NULL
$height : mixed = NULL
$crop : mixed = NULL
$albumfolder : mixed = ''
$firstimglink : mixed = false
$threshold : mixed = 0
$collection : mixed = false

printLatestUpdatedAlbums()

– Use printAlbumStatistisc() instead


    
                    printLatestUpdatedAlbums([mixed $number = 5 ][, mixed $showtitle = false ][, mixed $showdate = false ][, mixed $showdesc = false ][, mixed $desclength = 40 ][, mixed $showstatistic = '' ][, mixed $width = NULL ][, mixed $height = NULL ][, mixed $crop = NULL ][, mixed $albumfolder = '' ][, mixed $firstimglink = false ][, mixed $collection = false ]) : mixed