ZenphotoCMS 1.6.8

misc

Interfaces

CacheException: Exception interface for all exceptions thrown by an Implementing Library.
CacheItemInterface: CacheItemInterface defines an interface for interacting with objects inside a cache.
CacheItemPoolInterface: CacheItemPoolInterface generates CacheItemInterface objects.
InvalidArgumentException: Exception interface for invalid cache arguments.
CacheException: Interface used for all types of exceptions thrown by the implementing library.
CacheInterface
InvalidArgumentException: Exception interface for invalid cache arguments.

Classes

imageMetaFormatter: Class to handle metadata formatting
update: Static class to check for available updates of Zenphoto
getid3_lib
getID3
getid3_handler
getid3_exception
getid3_mpeg
getid3_quicktime
getid3_aac
getid3_mp3
getid3_apetag
getid3_id3v1
getid3_id3v2
getid3_lyrics3
JSMin_UnterminatedStringException
JSMin_UnterminatedCommentException
JSMin_UnterminatedRegExpException
OAuthExcept
OAuthConsumer
OAuthToken
OAuthSignatureMethod: A class for implementing a Signature Method See section 9 ("Signing Requests") in the spec
OAuthSignatureMethod_HMAC_SHA1: The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104] where the Signature Base String is the text and the key is the concatenated values (each first encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&' character (ASCII code 38) even if empty.
OAuthSignatureMethod_PLAINTEXT: The PLAINTEXT method does not provide any security protection and SHOULD only be used over a secure channel such as HTTPS. It does not use the Signature Base String.
OAuthSignatureMethod_RSA_SHA1: The RSA-SHA1 signature method uses the RSASSA-PKCS1-v1_5 signature algorithm as defined in [RFC3447] section 8.2 (more simply known as PKCS#1), using SHA-1 as the hash function for EMSA-PKCS1-v1_5. It is assumed that the Consumer has provided its RSA public key in a verified way to the Service Provider, in a manner which is beyond the scope of this specification.
OAuthRequest
OAuthServer
OAuthDataStore
OAuthUtil
elFinderEditor: Abstract class of editor plugins.
elFinderEditorOnlineConvert: Abstract class of editor plugins.
elFinderEditorZipArchive: Abstract class of editor plugins.
elFinderEditorZohoOffice: Abstract class of editor plugins.
elFinderAbortException: Custom exception class for aborting request
elFinderTriggerException
elFinderConnector: Default elFinder connector
elFinderVolumeFlysystemGoogleDriveCache
elFinderVolumeFlysystemGoogleDriveNetmount
elFinderVolumeBox: Simple elFinder driver for BoxDrive Box.com API v2.0.
elFinderVolumeDriver: Base class for elFinder volume.
elFinderVolumeDropbox: Simple elFinder driver for FTP
elFinderVolumeDropbox2: Simple elFinder driver for Dropbox kunalvarma05/dropbox-php-sdk:0.1.5 or above.
elFinderVolumeFTP: Simple elFinder driver for FTP
elFinderVolumeGoogleDrive: Simple elFinder driver for GoogleDrive google-api-php-client-2.x or above.
elFinderVolumeGroup: elFinder driver for Volume Group.
RecursiveCallbackFilterIterator
elFinderVolumeLocalFileSystem: elFinder driver for local filesystem.
elFinderVolumeMySQL: Simple elFinder driver for MySQL.
elFinderVolumeOneDrive: Simple elFinder driver for OneDrive onedrive api v5.0.
elFinderVolumeSFTPphpseclib: Simple elFinder driver for SFTP using phpseclib 1
elFinderVolumeTrash: elFinder driver for trash bin at local filesystem.
elFinderVolumeTrashMySQL: elFinder driver for trash bin at MySQL Database
elFinderLibGdBmp
elFinderPluginWinRemoveTailDots: This class describes elFinder plugin window remove tail dots.
Cache: Generic naive implementation of a Simple Cache system using an associative array.
CacheException
CacheItem: Simple cache item (key, value, ttl) that is being used by all the detection methods of Mobile Detect class.
MobileDetectException
MobileDetect: Auto-generated isXXXX() magic methods.
MobileDetectStandalone: Auto-generated isXXXX() magic methods.
Exception: PHPMailer exception handler.
PHPMailer: PHPMailer - PHP email creation and transport class.
POP3: PHPMailer POP-Before-SMTP Authentication Class.
SMTP: PHPMailer RFC821 SMTP email transport class.
UploadHandler

Constants

DEBUG_404 = isset($_zp_conf_vars['debug_404']) && $_zp_conf_vars['debug_404'] || \TEST_RELEASE
DEBUG_ERROR = isset($_zp_conf_vars['debug_error']) && $_zp_conf_vars['debug_error'] || \TEST_RELEASE
DEBUG_EXIF = isset($_zp_conf_vars['debug_exif']) && $_zp_conf_vars['debug_exif']
DEBUG_FILTERS = isset($_zp_conf_vars['debug_filters']) && $_zp_conf_vars['debug_filters']
DEBUG_IMAGE = isset($_zp_conf_vars['debug_image']) && $_zp_conf_vars['debug_image']
DEBUG_IMAGE_ERR = isset($_zp_conf_vars['debug_image_err']) && $_zp_conf_vars['debug_image_err'] || \TEST_RELEASE
DEBUG_LOCALE = isset($_zp_conf_vars['debug_locale']) && $_zp_conf_vars['debug_locale']
DEBUG_LOGIN = isset($_zp_conf_vars['debug_login']) && $_zp_conf_vars['debug_login']
DEBUG_PLUGINS = isset($_zp_conf_vars['debug_plugins']) && $_zp_conf_vars['debug_plugins']
ELFINDER_PHP_ROOT_PATH = \dirname(__FILE__)
ENT_SUBSTITUTE = \defined('ENT_IGNORE') ? \ENT_IGNORE : 8
EXPLAIN_SELECTS = isset($_zp_conf_vars['explain_selects']) && $_zp_conf_vars['explain_selects']
GD_FREETYPE = (bool) $this->info['FreeType']
GD_FREETYPE_SAMPLE = 'The quick brown fox jumps over the lazy dog'
GD_FREETYPE_SAMPLE_CHARS = strlen('GD_FREETYPE_SAMPLE')
GETID3_HELPERAPPSDIR = $helperappsdir . DIRECTORY_SEPARATOR
GETID3_INCLUDEPATH = \dirname(__FILE__) . \DIRECTORY_SEPARATOR
GETID3_LIBXML_OPTIONS = \LIBXML_NOENT | \LIBXML_NONET | \LIBXML_NOWARNING
GETID3_OS_ISWINDOWS = \stripos(\PHP_OS, 'WIN') === 0
GETID3_TEMP_DIR = $temp_dir
NEWS_POSITION_NORMAL = 0
NEWS_POSITION_STICK_TO_TOP = 9
NEWS_POSITION_STICKY = 1
OFFSET_PATH = 1
OFFSET_PATH = 3
OFFSET_PATH = 3
OFFSET_PATH = 3
PHP_INT_MAX = 2147483647
PHP_INT_MIN = ~PHP_INT_MAX
PRE_RELEASE = \false
RECORD_LIMIT = 5
SERVERPATH = $_zp_setup_serverpath
SETUPLOG = $_zp_setup_serverpath . '/' . \DATA_FOLDER . '/setup.log'
SITE_LOCALE = 'en_US'
TEST_RELEASE = $is_testrelease
ZENPAGE_COMBINEWS = \false: Some global variable setup
ZP_ARTICLES_PER_PAGE = \getOption("zenpage_articles_per_page") >= 1 ? \getOption("zenpage_articles_per_page") : 1
ZP_COMBINEWS = \false
ZP_READ_MORE = $zenpage_readmore_text
ZP_SHORTEN_LENGTH = \getOption('zenpage_text_length')
ZP_SHORTENINDICATOR = $shortenindicator = \getOption('zenpage_textshorten_indicator')

Functions

RSS_Tags() : mixed: RSS Extractor and Displayer (c) 2007-2009 Scriptol.com - License Mozilla 1.1.
RSS_Channel() : mixed
RSS_Retrieve() : mixed
generateLanguageList() : array<string|int, mixed>: Returns an array of available language locales.
setMainDomain() : mixed: Sets the locale, etc. to the zenphoto domain details.
gettext_th() : string: Gettext replacement function for separate translations of third party themes.
ngettext_th() : string: ngettext replacement function for separate translations of third party themes.
gettext_pl() : string: Gettext replacement function for separate translations of third party plugins within the root plugins folder.
ngettext_pl() : string: ngettext replacement function for separate translations of third party plugins within the root plugins folder.
i18nSetLocale() : string: Wrapper function for setLocale() so that all the proper permutations are used Returns the result from the setLocale call
setupDomain() : mixed: Sets the translation domain and type for optional theme or plugin based translations
setupCurrentLocale() : mixed: Setup code for gettext translation Returns the result of the setlocale call
getLangAttributeLocale() : string: Converts underscore locales like "en_US" to valid IANA/BCP 47 hyphen locales like "en-US" Needed for example in JS or HTML "lang" attributes.
parseHttpAcceptLanguage() : array<string|int, mixed>: This function will parse a given HTTP Accepted language instruction (or retrieve it from $_SERVER if not provided) and will return a sorted array. For example, it will parse fr;en-us;q=0.8
validateLocale() : mixed: checks a "supplied" locale against the valid locales.
getUserLocale() : mixed: Returns a saved (or posted) locale. Posted locales are stored as a cookie.
get_language_string() : string: Returns the sring for the current language from a serialized set of language strings Defaults to the string for the current locale, the en_US string, or the first string which ever is present
getTimezones() : unknown: Returns a list of timezones
timezoneDiff() : int: Returns the difference between the server timez one and the local (users) time zone
getAllTranslations() : mixed: Returns a serialized "multilingual array" of translations of the currently active translations and if there is an gettext translation Used for setting static multi-lingual strings in the db if a dynamic gettexted text doesn't work.
getLanguageSubdomains() : mixed: creates an SEO language prefix list
getLanguageText() : string: Returns a canonical language name string for the location
getSystemLocales() : array<string|int, mixed>: Gets all locales suppported on the current server as a multidimensional array
getLanguageDisplayName() : string: Returns the real language name to the locale passed.
printLangAttribute() : mixed: Prints the lang="" attribute for the main <html> element.
getFormattedLocaleDate() : string: Returns a locale aware - e.g. translated day and month names - formatted date. Requires the PHP intl extension to work properly Otherwise returns standard formatted date.
imageError() : mixed
imageDebug() : mixed: Prints debug information from the arguments to i.php.
propSizes() : array<string|int, mixed>: Calculates proprotional width and height Used internally by cacheImage
iptc_make_tag() : mixed: iptc_make_tag() function by Thies C. Arntzen
cacheImage() : mixed: Creates the cache folder version of the image, including watermarking
getImageRotation() : array<string|int, mixed>|false: Determines the rotation of the image by looking at EXIF information.
addWatermark() : resource|object: Adds a watermark to a resized image. If no watermark is set it just returns the image
isGDImage() : bool: Checks if an processed image is a GD library image
getRules() : mixed
bind_textdomain_codeset() : mixed
textdomain() : mixed
gettext() : mixed
ngettext() : mixed
dgettext() : mixed
dngettext() : mixed
hl_attrval() : mixed: Validate attribute value and possibly change to a default value if invalid.
hl_bal() : mixed
hl_cmtcd() : string: Handle comment/CDATA section.
hl_ent() : string: Handle entity.
hl_prot() : string: Handle URL to convert to relative/absolute type, block scheme, or add anti-spam text.
hl_regex() : int: Check regex pattern for PHP error.
hl_spec() : array<string|int, mixed>: Parse $spec htmLawed argument as array.
hl_tag() : string: Handle tag text with </> limiters.
hl_tag2() : mixed: Transform deprecated element, with any attribute, into a new element.
hl_tidy() : mixed: Tidy/beautify HTM by adding newline and other spaces (padding), or compact by removing unnecessary spaces.
hl_version() : mixed: Report version.
mb_strtolower() : mixed
mb_strtoupper() : mixed
mb_strlen() : mixed
mb_substr() : mixed
mb_strrpos() : mixed
mb_strpos() : mixed
mb_substr_count() : mixed
elFinderAutoloader() : mixed
imagecreatefrombmp() : mixed
printFullAlbumsList() : string: Prints all albums of the Zenphoto gallery as a partial drop down menu (<option></option> parts).
printSubLevelAlbums() : string: Recursive helper function for printFullAlbumsList() to get all sub albums of each top level album
unpublishedZenphotoItemCheck() : string: checks if a album or image is un-published and returns a '*'
shortentitle() : string: shortens a string, truncate_string() was not exact enough.
printImageslist() : string: Prints the images and/or albums as thumbnails of the selected album
getImageType() : string: Returns the object "type" of the "image".
printNewsArticlesList() : string: Prints all available articles in Zenpage
checkAlbumForImages() : bool: Checks if an album has images for display on the form
showZenphotoOptions() : bool: Checks if the full Zenphoto include form options should be shown
printTinyPageNav() : string: Prints the page navigation for albums or Zenpage news articles
printZenpageItems() : string: Prints the Zenpage items as a partial dropdown (pages, news articles, categories)
printAllNestedList() : string: Prints all available pages or categories in Zenpage
unpublishedZenpageItemCheck() : string: checks if a news article or page is un-published and/or protected and returns a '*'
setTinyZenpageLocale() : mixed: Set the locale for gettext translation of this plugin. Somehow ZenPhoto's setupDomain() does not work here.
printTinyZenpageCategorySelector() : mixed: Prints the dropdown menu for the category selector for the news articles list
upload_extra() : mixed
upload_form() : mixed

DEBUG_404


    public
        mixed
    DEBUG_404
    = isset($_zp_conf_vars['debug_404']) && $_zp_conf_vars['debug_404'] || \TEST_RELEASE

DEBUG_ERROR


    public
        mixed
    DEBUG_ERROR
    = isset($_zp_conf_vars['debug_error']) && $_zp_conf_vars['debug_error'] || \TEST_RELEASE

DEBUG_EXIF


    public
        mixed
    DEBUG_EXIF
    = isset($_zp_conf_vars['debug_exif']) && $_zp_conf_vars['debug_exif']

DEBUG_FILTERS


    public
        mixed
    DEBUG_FILTERS
    = isset($_zp_conf_vars['debug_filters']) && $_zp_conf_vars['debug_filters']

DEBUG_IMAGE


    public
        mixed
    DEBUG_IMAGE
    = isset($_zp_conf_vars['debug_image']) && $_zp_conf_vars['debug_image']

DEBUG_IMAGE_ERR


    public
        mixed
    DEBUG_IMAGE_ERR
    = isset($_zp_conf_vars['debug_image_err']) && $_zp_conf_vars['debug_image_err'] || \TEST_RELEASE

DEBUG_LOCALE


    public
        mixed
    DEBUG_LOCALE
    = isset($_zp_conf_vars['debug_locale']) && $_zp_conf_vars['debug_locale']

DEBUG_LOGIN


    public
        mixed
    DEBUG_LOGIN
    = isset($_zp_conf_vars['debug_login']) && $_zp_conf_vars['debug_login']

DEBUG_PLUGINS


    public
        mixed
    DEBUG_PLUGINS
    = isset($_zp_conf_vars['debug_plugins']) && $_zp_conf_vars['debug_plugins']

ELFINDER_PHP_ROOT_PATH


    public
        mixed
    ELFINDER_PHP_ROOT_PATH
    = \dirname(__FILE__)

ENT_SUBSTITUTE


    public
        mixed
    ENT_SUBSTITUTE
    = \defined('ENT_IGNORE') ? \ENT_IGNORE : 8

EXPLAIN_SELECTS


    public
        mixed
    EXPLAIN_SELECTS
    = isset($_zp_conf_vars['explain_selects']) && $_zp_conf_vars['explain_selects']

GD_FREETYPE


    public
        mixed
    GD_FREETYPE
    = (bool) $this->info['FreeType']

GD_FREETYPE_SAMPLE


    public
        mixed
    GD_FREETYPE_SAMPLE
    = 'The quick brown fox jumps over the lazy dog'

GD_FREETYPE_SAMPLE_CHARS


    public
        mixed
    GD_FREETYPE_SAMPLE_CHARS
    = strlen('GD_FREETYPE_SAMPLE')

GETID3_HELPERAPPSDIR


    public
        mixed
    GETID3_HELPERAPPSDIR
    = $helperappsdir . DIRECTORY_SEPARATOR

GETID3_INCLUDEPATH


    public
        mixed
    GETID3_INCLUDEPATH
    = \dirname(__FILE__) . \DIRECTORY_SEPARATOR

GETID3_LIBXML_OPTIONS


    public
        mixed
    GETID3_LIBXML_OPTIONS
    = \LIBXML_NOENT | \LIBXML_NONET | \LIBXML_NOWARNING

GETID3_OS_ISWINDOWS


    public
        mixed
    GETID3_OS_ISWINDOWS
    = \stripos(\PHP_OS, 'WIN') === 0

GETID3_TEMP_DIR


    public
        mixed
    GETID3_TEMP_DIR
    = $temp_dir

NEWS_POSITION_NORMAL


    public
        mixed
    NEWS_POSITION_NORMAL
    = 0

NEWS_POSITION_STICK_TO_TOP


    public
        mixed
    NEWS_POSITION_STICK_TO_TOP
    = 9

NEWS_POSITION_STICKY


    public
        mixed
    NEWS_POSITION_STICKY
    = 1

OFFSET_PATH


    public
        mixed
    OFFSET_PATH
    = 1

OFFSET_PATH


    public
        mixed
    OFFSET_PATH
    = 3

OFFSET_PATH


    public
        mixed
    OFFSET_PATH
    = 3

OFFSET_PATH


    public
        mixed
    OFFSET_PATH
    = 3

PHP_INT_MAX


    public
        mixed
    PHP_INT_MAX
    = 2147483647

PHP_INT_MIN


    public
        mixed
    PHP_INT_MIN
    = ~PHP_INT_MAX

PRE_RELEASE


    public
        mixed
    PRE_RELEASE
    = \false

RECORD_LIMIT


    public
        mixed
    RECORD_LIMIT
    = 5

SERVERPATH


    public
        mixed
    SERVERPATH
    = $_zp_setup_serverpath

SETUPLOG


    public
        mixed
    SETUPLOG
    = $_zp_setup_serverpath . '/' . \DATA_FOLDER . '/setup.log'

SITE_LOCALE


    public
        mixed
    SITE_LOCALE
    = 'en_US'

TEST_RELEASE


    public
        mixed
    TEST_RELEASE
    = $is_testrelease

ZENPAGE_COMBINEWS

Some global variable setup


    public
        mixed
    ZENPAGE_COMBINEWS
    = \false

ZP_ARTICLES_PER_PAGE


    public
        mixed
    ZP_ARTICLES_PER_PAGE
    = \getOption("zenpage_articles_per_page") >= 1 ? \getOption("zenpage_articles_per_page") : 1

ZP_COMBINEWS


    public
        mixed
    ZP_COMBINEWS
    = \false

ZP_READ_MORE


    public
        mixed
    ZP_READ_MORE
    = $zenpage_readmore_text

ZP_SHORTEN_LENGTH


    public
        mixed
    ZP_SHORTEN_LENGTH
    = \getOption('zenpage_text_length')

ZP_SHORTENINDICATOR


    public
        mixed
    ZP_SHORTENINDICATOR
    = $shortenindicator = \getOption('zenpage_textshorten_indicator')

RSS_Tags()


    
                    RSS_Tags(mixed $item, mixed $type) : mixed

rsslib.php Modified for zenphoto by s. billard removed unused functions made more resilient

Requirements:

PHP 5.
A RSS feed

Parameters

$item : mixed
$type : mixed

RSS_Channel()


    
                    RSS_Channel(mixed $channel) : mixed

Parameters

$channel : mixed

RSS_Retrieve()


    
                    RSS_Retrieve(mixed $url) : mixed

Parameters

$url : mixed

generateLanguageList()

Returns an array of available language locales.


    
                    generateLanguageList([mixed $all = false ]) : array<string|int, mixed>

Parameters

$all : mixed = false

Return values

array<string|int, mixed>

setMainDomain()

Sets the locale, etc. to the zenphoto domain details.


    
                    setMainDomain() : mixed

Returns the result of setupCurrentLocale()

gettext_th()

Gettext replacement function for separate translations of third party themes.


    
                    gettext_th(string $string[, string $theme = Null ]) : string

Parameters

$string : string: The string to be translated
$theme : string = Null: The name of the plugin. Only required for strings on the 'theme_description.php' file like the general theme description. If the theme is the current theme the function sets it automatically.

Return values

string

ngettext_th()

ngettext replacement function for separate translations of third party themes.


    
                    ngettext_th(string $msgid1, string $msgid2, int $n[, string $theme = NULL ]) : string

Parameters

$msgid1 : string
$msgid2 : string
$n : int
$theme : string = NULL

Return values

string

gettext_pl()

Gettext replacement function for separate translations of third party plugins within the root plugins folder.


    
                    gettext_pl(string $string, string $plugin) : string

Parameters

$string : string: The string to be translated
$plugin : string: The name of the plugin. Required.

Return values

string

ngettext_pl()

ngettext replacement function for separate translations of third party plugins within the root plugins folder.


    
                    ngettext_pl(string $msgid1, string $msgid2, int $n, string $plugin) : string

Parameters

$msgid1 : string
$msgid2 : string
$n : int
$plugin : string

Return values

string

i18nSetLocale()

Wrapper function for setLocale() so that all the proper permutations are used Returns the result from the setLocale call


    
                    i18nSetLocale(mixed $locale) : string

Parameters

$locale : mixed: the local desired

Return values

string

setupDomain()

Sets the translation domain and type for optional theme or plugin based translations


    
                    setupDomain([mixed $domain = NULL ][, mixed $type = NULL ]) : mixed

Parameters

$domain : mixed = NULL
$type : mixed = NULL: NULL (Zenphoto main translation), "theme" or "plugin"

setupCurrentLocale()

Setup code for gettext translation Returns the result of the setlocale call


    
                    setupCurrentLocale([string $override = NULL ]) : mixed

Parameters

$override : string = NULL: force locale to this

getLangAttributeLocale()

Converts underscore locales like "en_US" to valid IANA/BCP 47 hyphen locales like "en-US" Needed for example in JS or HTML "lang" attributes.


    
                    getLangAttributeLocale([string $locale = NULL ]) : string

Parameters

$locale : string = NULL: a locale like "en_US", if empty the current locale is used

Return values

string

parseHttpAcceptLanguage()

This function will parse a given HTTP Accepted language instruction (or retrieve it from $_SERVER if not provided) and will return a sorted array. For example, it will parse fr;en-us;q=0.8


    
                    parseHttpAcceptLanguage([string $str = NULL ]) : array<string|int, mixed>

Thanks to Fredbird.org for this code.

Parameters

$str : string = NULL: optional language string

Return values

array<string|int, mixed>

validateLocale()

checks a "supplied" locale against the valid locales.


    
                    validateLocale(string $userlocale, mixed $source) : mixed

Returns a valid locale if one exists else returns NULL

Parameters

$userlocale : string
$source : mixed

getUserLocale()

Returns a saved (or posted) locale. Posted locales are stored as a cookie.


    
                    getUserLocale() : mixed

Sets the 'locale' option to the result (non-persistent)

get_language_string()

Returns the sring for the current language from a serialized set of language strings Defaults to the string for the current locale, the en_US string, or the first string which ever is present


    
                    get_language_string(string $dbstring[, string $locale = NULL ]) : string

Parameters

$dbstring : string: either a serialized languag string array or a single string
$locale : string = NULL: optional locale of the translation desired

Return values

string

getTimezones()

Returns a list of timezones


    
                    getTimezones() : unknown

Return values

unknown

timezoneDiff()

Returns the difference between the server timez one and the local (users) time zone


    
                    timezoneDiff(string $server, string $local) : int

Parameters

$server : string
$local : string

Return values

int

getAllTranslations()

Returns a serialized "multilingual array" of translations of the currently active translations and if there is an gettext translation Used for setting static multi-lingual strings in the db if a dynamic gettexted text doesn't work.


    
                    getAllTranslations(string $text) : mixed

Parameters

$text : string: to be translated

getLanguageSubdomains()

creates an SEO language prefix list


    
                    getLanguageSubdomains() : mixed

getLanguageText()

Returns a canonical language name string for the location


    
                    getLanguageText([string $loc = NULL ][, mixed $separator = NULL ]) : string

Parameters

$loc : string = NULL: the location. If NULL use the current cookie
$separator : mixed = NULL

Return values

string

getSystemLocales()

Gets all locales suppported on the current server as a multidimensional array


    
                    getSystemLocales([bool $plainarray = false ]) : array<string|int, mixed>

Parameters

$plainarray : bool = false: Default false for a multidimensial array grouped by locale base. Set to true to generate a single dimensional array with all locales.

Return values

array<string|int, mixed>

getLanguageDisplayName()

Returns the real language name to the locale passed.


    
                    getLanguageDisplayName(string $locale) : string

If available it will use the native PHP Locale class. It returns the name in the language/locale currently set. Otherwise the far more limited internal Zenphoto catalogue stored in getLanguageArray() will be used.

Parameters

$locale : string: A vaild locale.

Return values

string

printLangAttribute()

Prints the lang="" attribute for the main <html> element.


    
                    printLangAttribute([string $locale = null ]) : mixed

Parameters

$locale : string = null: Default null so the current locale is used. Or a locale like "en_US" which will get the underscores replaced by hyphens to be valid

getFormattedLocaleDate()

Returns a locale aware - e.g. translated day and month names - formatted date. Requires the PHP intl extension to work properly Otherwise returns standard formatted date.


    
                    getFormattedLocaleDate([string $format = 'Y-m-dd' ][, string|int $datetime = '' ]) : string

Parameters

$format : string = 'Y-m-dd': An ICU dateformat string
$datetime : string|int = '': A date() compatible string or a timestamp. If empty "now" is used

Return values

string

imageError()


    
                    imageError(string $status_text, string $errormessage[, string $errorimg = 'err-imagegeneral.png' ][, string $image = '' ][, string $album = '' ][, string $newfilename = '' ]) : mixed

Parameters

$status_text : string
$errormessage : string: the error message to print if $_GET['debug'] is set.
$errorimg : string = 'err-imagegeneral.png': the filename of the error image to display for production. Defaults to 'err-imagegeneral.png'. Images should be located in /zp-core/images_errors .
$image : string = ''
$album : string = ''
$newfilename : string = ''

imageDebug()

Prints debug information from the arguments to i.php.


    
                    imageDebug(string $album, string $image, array<string|int, mixed> $args, string $imgfile) : mixed

Parameters

$album : string: alubm name
$image : string: image name
$args : array<string|int, mixed>: size/crop arguments
$imgfile : string: the filename of the image

propSizes()

Calculates proprotional width and height Used internally by cacheImage


    
                    propSizes(int $size, int $width, int $height, int $w, int $h, int $thumb, int $image_use_side, int $dim) : array<string|int, mixed>

Returns array containing the new width and height

Parameters

$size : int
$width : int
$height : int
$w : int
$h : int
$thumb : int
$image_use_side : int
$dim : int

Return values

array<string|int, mixed>

iptc_make_tag()

iptc_make_tag() function by Thies C. Arntzen


    
                    iptc_make_tag(mixed $rec, mixed $data, mixed $value) : mixed

Parameters

$rec : mixed
$data : mixed
$value : mixed

cacheImage()

Creates the cache folder version of the image, including watermarking


    
                    cacheImage(string $newfilename, string $imgfile, array<string|int, mixed> $args[, bool $allow_watermark = false ][, string $theme = null ][, string $album = null ]) : mixed

Parameters

$newfilename : string: the name of the file when it is in the cache
$imgfile : string: the image name
$args : array<string|int, mixed>: the cropping arguments
$allow_watermark : bool = false: set to true if image may be watermarked
$theme : string = null: the current theme
$album : string = null: the album containing the image

getImageRotation()

Determines the rotation of the image by looking at EXIF information.


    
                    getImageRotation(string $imgfile) : array<string|int, mixed>|false

Returns an array with two indexes "rotate" (= degree to rotate) and "flip" ("horizontal" or "vertical") or false if nothing applies

Parameters

$imgfile : string: the image name

Return values

array<string|int, mixed>|false

addWatermark()

Adds a watermark to a resized image. If no watermark is set it just returns the image


    
                    addWatermark(resource|object $newim, string $watermark_image[, string $imgfile = null ]) : resource|object

Parameters

$newim : resource|object: GD image resource or Imagick object
$watermark_image : string: The path to the watermark to use
$imgfile : string = null: Path to the image being processed (optionally for debugging only)

Return values

resource|object

isGDImage()

Checks if an processed image is a GD library image


    
                    isGDImage(mixed $image) : bool

Parameters

$image : mixed: And Image resource (PHP < 8) or GDImage object (PHP 8+)

Return values

bool

getRules()


    
                    getRules() : mixed

bind_textdomain_codeset()


    
                    bind_textdomain_codeset(mixed $domain, mixed $codeset) : mixed

Parameters

$domain : mixed
$codeset : mixed

textdomain()


    
                    textdomain(mixed $domain) : mixed

Parameters

$domain : mixed

gettext()


    
                    gettext(mixed $msgid) : mixed

Parameters

$msgid : mixed

ngettext()


    
                    ngettext(mixed $msgid1, mixed $msgid2, mixed $n) : mixed

Parameters

$msgid1 : mixed
$msgid2 : mixed
$n : mixed

dgettext()


    
                    dgettext(mixed $plugin, mixed $string) : mixed

Parameters

$plugin : mixed
$string : mixed

dngettext()


    
                    dngettext(mixed $theme, mixed $msgid1, mixed $msgid2, mixed $n) : mixed

Parameters

$theme : mixed
$msgid1 : mixed
$msgid2 : mixed
$n : mixed

hl_attrval()

Validate attribute value and possibly change to a default value if invalid.


    
                    hl_attrval(string $attr, string $value, array<string|int, mixed> $ruleAr) : mixed

Parameters

$attr : string: Attribute name.
$value : string: Attribute value; may be string of multiple separated values.
$ruleAr : array<string|int, mixed>: Array of rules derived from $spec.

Return values

mixed —

0 if invalid $value, or string with validated value or value reset to a default.

hl_bal()


    
                    hl_bal(mixed $t[, mixed $act = 1 ][, mixed $parentEle = 'div' ]) : mixed

Parameters

$t : mixed
$act : mixed = 1
$parentEle : mixed = 'div'

hl_cmtcd()

Handle comment/CDATA section.


    
                    hl_cmtcd(array<string|int, mixed> $t) : string

Filter/sanitize as per $config and disguise special characters.

Parameters

$t : array<string|int, mixed>: Array result of preg_replace, with potential comment/CDATA.

Return values

string —

Sanitized comment/CDATA with disguised special characters.

hl_ent()

Handle entity.


    
                    hl_ent(array<string|int, mixed> $t) : string

As needed, convert between named and hexadecimal form, or neutralize by changing '&' to '&'.

Parameters

$t : array<string|int, mixed>: Array result of preg_replace, with potential entity.

Return values

string —

Neutralized or converted entity.

hl_prot()

Handle URL to convert to relative/absolute type, block scheme, or add anti-spam text.


    
                    hl_prot(mixed $url[, mixed $attr = null ]) : string

Parameters

$url : mixed: URL string, or array with URL value (if $attr is null).
$attr : mixed = null: Attribute name string, or null (if $url is array).

Return values

string —

With URL after any conversion/obfuscation.

hl_regex()

Check regex pattern for PHP error.


    
                    hl_regex(string $t) : int

Parameters

$t : string: Pattern including limiters/modifiers.

Return values

int —

0 or 1 if pattern is invalid or valid, respectively.

hl_spec()

Parse $spec htmLawed argument as array.


    
                    hl_spec(string $t) : array<string|int, mixed>

See documentation on $spec specification.

Parameters

$t : string: Value of $spec.

Return values

array<string|int, mixed> —

Multidimensional array of form: tag -> attribute -> rule.

hl_tag()

Handle tag text with </> limiters.


    
                    hl_tag(array<string|int, mixed> $t) : string

Also handles attributes in opening tags.

Parameters

$t : array<string|int, mixed>: Result of preg_replace call.

Return values

string —

Tag, with any attribute string, or text with </> neutralized into entities, or empty.

hl_tag2()

Transform deprecated element, with any attribute, into a new element.


    
                    hl_tag2(string &$ele, string &$attrStr[, int $act = 1 ]) : mixed

Parameters

$ele : string: Deprecated element.
$attrStr : string: Attribute string of element.
$act : int = 1: No transformation if 2.

Return values

mixed —

New attribute string (may be empty) or 0.

hl_tidy()

Tidy/beautify HTM by adding newline and other spaces (padding), or compact by removing unnecessary spaces.


    
                    hl_tidy(string $t, mixed $format, string $parentEle) : mixed

Parameters

$t : string: HTM.
$format : mixed: -1 (compact) or string (type of padding).
$parentEle : string: Parent element of $t.

Return values

mixed —

Transformed attribute string (may be empty) or 0.

hl_version()

Report version.


    
                    hl_version() : mixed

mb_strtolower()


    
                    mb_strtolower(mixed $str) : mixed

Parameters

$str : mixed

mb_strtoupper()


    
                    mb_strtoupper(mixed $str) : mixed

Parameters

$str : mixed

mb_strlen()


    
                    mb_strlen(mixed $str) : mixed

Parameters

$str : mixed

mb_substr()


    
                    mb_substr(mixed $str, mixed $start[, mixed $length = NULL ]) : mixed

Parameters

$str : mixed
$start : mixed
$length : mixed = NULL

mb_strrpos()


    
                    mb_strrpos(mixed $haystack, mixed $needle) : mixed

Parameters

$haystack : mixed
$needle : mixed

mb_strpos()


    
                    mb_strpos(mixed $haystack, mixed $needle[, mixed $offset = 0 ]) : mixed

Parameters

$haystack : mixed
$needle : mixed
$offset : mixed = 0

mb_substr_count()


    
                    mb_substr_count(mixed $haystack, mixed $needle) : mixed

Parameters

$haystack : mixed
$needle : mixed

elFinderAutoloader()


    
                    elFinderAutoloader(mixed $name) : mixed

Parameters

$name : mixed

imagecreatefrombmp()


    
                    imagecreatefrombmp(mixed $filename_or_stream_or_binary) : mixed

Parameters

$filename_or_stream_or_binary : mixed

printFullAlbumsList()

Prints all albums of the Zenphoto gallery as a partial drop down menu (<option></option> parts).


    
                    printFullAlbumsList() : string

Return values

string

printSubLevelAlbums()

Recursive helper function for printFullAlbumsList() to get all sub albums of each top level album


    
                    printSubLevelAlbums(mixed &$albumobj) : string

Parameters

$albumobj : mixed

Return values

string

unpublishedZenphotoItemCheck()

checks if a album or image is un-published and returns a '*'


    
                    unpublishedZenphotoItemCheck(mixed $obj[, mixed $dropdown = true ]) : string

Parameters

$obj : mixed
$dropdown : mixed = true

Return values

string

shortentitle()

shortens a string, truncate_string() was not exact enough.


    
                    shortentitle(mixed $title, mixed $length) : string

Parameters

$title : mixed: int Title of the image
$length : mixed: int The desired length

Return values

string

printImageslist()

Prints the images and/or albums as thumbnails of the selected album


    
                    printImageslist(mixed $number) : string

Parameters

$number : mixed: int The number of images per page

Return values

string

getImageType()

Returns the object "type" of the "image".


    
                    getImageType(mixed $imageobj) : string

Note: If the root object is a video object then If a mediaplayer is enabled a sub-type of video or audio will be determined from the suffix. If it is not one of the known suffixes or if the mediaplayer is not enabled then 'other' is returned as the object type.

Pure images return empty for an object type.

Parameters

$imageobj : mixed

Return values

string

printNewsArticlesList()

Prints all available articles in Zenpage


    
                    printNewsArticlesList(mixed $number) : string

Parameters

$number : mixed

Return values

string

checkAlbumForImages()

Checks if an album has images for display on the form


    
                    checkAlbumForImages() : bool

Return values

bool

showZenphotoOptions()

Checks if the full Zenphoto include form options should be shown


    
                    showZenphotoOptions() : bool

Return values

bool

printTinyPageNav()

Prints the page navigation for albums or Zenpage news articles


    
                    printTinyPageNav([mixed $pagestotal = "" ][, mixed $currentpage = "" ][, mixed $mode = 'images' ]) : string

Parameters

$pagestotal : mixed = "": int The number page in total
$currentpage : mixed = "": int Number of the current page
$mode : mixed = 'images': string 'images' or 'articles'

Return values

string

printZenpageItems()

Prints the Zenpage items as a partial dropdown (pages, news articles, categories)


    
                    printZenpageItems() : string

Return values

string

printAllNestedList()

Prints all available pages or categories in Zenpage


    
                    printAllNestedList() : string

Return values

string

unpublishedZenpageItemCheck()

checks if a news article or page is un-published and/or protected and returns a '*'


    
                    unpublishedZenpageItemCheck(mixed $page) : string

Parameters

$page : mixed

Return values

string

setTinyZenpageLocale()

Set the locale for gettext translation of this plugin. Somehow ZenPhoto's setupDomain() does not work here.


    
                    setTinyZenpageLocale() : mixed

printTinyZenpageCategorySelector()

Prints the dropdown menu for the category selector for the news articles list


    
                    printTinyZenpageCategorySelector([mixed $currentpage = '' ]) : mixed

Parameters

$currentpage : mixed = ''

upload_extra()


    
                    upload_extra(mixed $uploadlimit, mixed $passedalbum) : mixed

Parameters

$uploadlimit : mixed
$passedalbum : mixed

upload_form()


    
                    upload_form(mixed $uploadlimit, mixed $passedalbum) : mixed

Parameters

$uploadlimit : mixed
$passedalbum : mixed

misc

Table of Contents

Interfaces

Classes

Constants

Functions

Constants

DEBUG_404

DEBUG_ERROR

DEBUG_EXIF

DEBUG_FILTERS

DEBUG_IMAGE

DEBUG_IMAGE_ERR

DEBUG_LOCALE

DEBUG_LOGIN

DEBUG_PLUGINS

ELFINDER_PHP_ROOT_PATH

ENT_SUBSTITUTE

EXPLAIN_SELECTS

GD_FREETYPE

GD_FREETYPE_SAMPLE

GD_FREETYPE_SAMPLE_CHARS

GETID3_HELPERAPPSDIR

GETID3_INCLUDEPATH

GETID3_LIBXML_OPTIONS

GETID3_OS_ISWINDOWS

GETID3_TEMP_DIR

NEWS_POSITION_NORMAL

NEWS_POSITION_STICK_TO_TOP

NEWS_POSITION_STICKY

OFFSET_PATH

OFFSET_PATH

OFFSET_PATH

OFFSET_PATH

PHP_INT_MAX

PHP_INT_MIN

PRE_RELEASE

RECORD_LIMIT

SERVERPATH

SETUPLOG

SITE_LOCALE

TEST_RELEASE

ZENPAGE_COMBINEWS

ZP_ARTICLES_PER_PAGE

ZP_COMBINEWS

ZP_READ_MORE

ZP_SHORTEN_LENGTH

ZP_SHORTENINDICATOR

Functions

RSS_Tags()

Parameters

RSS_Channel()

Parameters

RSS_Retrieve()

Parameters

generateLanguageList()

Parameters

Return values

setMainDomain()

gettext_th()

Parameters

Return values

ngettext_th()

Parameters

Return values

gettext_pl()

Parameters

Return values

ngettext_pl()

Parameters

Return values

i18nSetLocale()

Parameters

Return values

setupDomain()

Parameters

setupCurrentLocale()

Parameters

getLangAttributeLocale()

Parameters