API Documentation
Table of Contents
Namespaces
Interfaces
- elFinderSessionInterface
- elFinder - file manager for web.
Classes
- _zp_captcha
- Standins for when no captcha is enabled
- _zp_HTML_cache
- stand-in for when there is no HTML cache plugin enabled
- Administrator
- This is a simple class so that we have a convienient "handle" for manipulating Administrators.
- Zenphoto_Administrator
- This is a simple class so that we have a convienient "handle" for manipulating Administrators.
- Album
- Album Class
- AlbumBase
- Album Base Class
- Authority
- Provides the methods used for user authorization and management store an instantiation of this class in `$_zp_authority`.
- Zenphoto_Authority
- Provides the methods used for user authorization and management store an instantiation of this class in `$_zp_authority`.
- backupRestore
- Class for creating and restoring database backups.
- dbBase
- Database base class if no supported database is configured in PHP
- dbMySQLi
- Database core class for the MySQLi library
- dbPDO_MySQL
- Database core class for the PDO::MySQL library
- dynamicAlbum
- Dynamic Album Class for "saved searches"
- external_auth
- Root class for external authorizaton plugins
- feed
- Base feed class from which all others descend.
- Gallery
- Gallery Class
- graphicsBase
- Base class that kicks in if neither GD or Imagick are available for image handling Provides basic check method to see what library is available
- graphicsGD
- class for image handling using the GD library
- graphicsImagick
- Class for image handling using the Imagick library
- graphicsOptions
- Option class for graphics handlers
- Image
- Image Class
- imageMetaFormatter
- Class to handle metadata formatting
- maintenanceMode
- Maintenance mode utility class based on the former site_upgrade plugin
- MediaObject
- Root class for images and albums
- mimeTypes
- Library for mimetypes
- PersistentObject
- Persistent Object Class
- SearchEngine
- search class
- ThemeObject
- The basic ThemeObject class. Extends PersistentObject, is extended by various Theme related objects.
- Transientimage
- Transient image class
- userDataExport
- Class for exporting possible privacy related user data
- zpMutex
- Zenphoto Mutex class
- utf8
- UTF-8 friendly replacement functions - v0.2 Copyright (C) 2004-2006 Niels Leenheer & Andy Matsubara
- ZipStream
- setup
- setup support class
- setupMutex
- Zenphoto Mutex class
- admin_approval
- auto_backup
- Option handler class
- bxslider
- Plugin option handling class
- cachemanager_internal_deprecations
- cacheManager
- Standard options interface
- AnyFile_Options
- Option class for textobjects objects
- AnyFile
- Core class for handling "non-image" files
- TextObject
- Core class for handling "non-image" files
- TextObject_Options
- Option class for textobjects objects
- getid3_lib
- getID3
- getid3_handler
- getid3_exception
- getid3_mpeg
- getid3_quicktime
- getid3_aac
- getid3_mp3
- getid3_apetag
- getid3_id3v1
- getid3_id3v2
- getid3_lyrics3
- VideoObject_Options
- Option class for video objects
- Video
- Image Class
- pseudoPlayer
- WEBdocs_Options
- Option class for textobjects objects
- WEBdocs
- Core class for handling "non-image" files
- cloneZenphoto
- colorbox
- Comment
- Comment Class
- comment_form
- fieldExtender
- This is the root class for use by plugins to extend the Zenphoto database table fields. The administrative tabs for the objects will have input items for these new fields. They will be placed in the proximate location of the "custom data" field on the page.
- JSMin
- jsmin.php - PHP implementation of Douglas Crockford's JSMin.
- 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
- contactformOptions
- Plugin option handling class
- contactForm
- The plugin class
- cookieConsent
- crop_image
- defaultCodeblocks
- internal_deprecations
- Zenphoto general deprecated functions
- zpFunctions
- deprecated_functions
- DownloadList
- Plugin option handling class
- AlbumZip
- dynamic_locale
- elFinderEditor
- Abstract class of editor plugins.
- elFinderEditorOnlineConvert
- Abstract class of editor plugins.
- elFinderEditorZipArchive
- Abstract class of editor plugins.
- elFinderEditorZohoOffice
- Abstract class of editor plugins.
- elFinderConnector
- Default elFinder connector
- elFinderVolumeFlysystemGoogleDriveCache
- elFinderVolumeFlysystemGoogleDriveNetmount
- elFinderPlugin
- elFinder Plugin Abstract
- elFinderSession
- elFinder - file manager for web.
- 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
- elFinderPluginAutoResize
- elFinder Plugin AutoResize Auto resize on file upload.
- elFinderPluginAutoRotate
- elFinder Plugin AutoRotate Auto rotation on file upload of JPEG file by EXIF Orientation.
- elFinderPluginNormalizer
- elFinder Plugin Normalizer UTF-8 Normalizer of file-name and file-path etc.
- elFinderPluginSanitizer
- elFinder Plugin Sanitizer Sanitizer of file-name and file-path etc.
- elFinderPluginWatermark
- elFinder Plugin Watermark Print watermark on file upload.
- elFinderPluginWinRemoveTailDots
- This class describes elFinder plugin window remove tail dots.
- elFinder_options
- Option handler class
- email_new_user
- exampleMacros
- favorites
- This is the class declaration
- favoritesOptions
- featuredImage
- flag_thumbnail
- Plugin option handling class
- Combi
- Zenpage root classes
- galleryArticles
- Standard options interface
- Googlemaps
- CodeIgniter Google Maps API V3 Class
- GoogleMap
- googleMap
- CI_load
- CI_jsmin
- codeIgniter_kludge
- hitcounter
- Plugin option handling class
- htmlmetatags
- securityheadersOptions
- Options handler for http_security_headers plugin
- securityHeaders
- Static class to generate the headers as set on the plugin options
- ipBlocker
- Option handler class
- jplayer_options
- jPlayer
- lazyloadOptions
- Options for the lazyload plugin
- lazyload
- Filter HTML to add JS lazyloading using the script lazysizes
- matomoStats
- menu_manager
- option handler
- MergedRSSOptions
- MergedRSS
- ComposerAutoloaderInitd5350eb3a139c07c29d30a628169cbde
- mobileTheme
- mobile
- Child class of MobileDetect. isMobile() and isTablet()
- multipleLayoutOptions
- Plugin option handling class
- openStreetMapOptions
- openStreetMap
- The class for all OSM map related functionality
- pagedthumbsOptions
- Plugin option handling class
- pagedThumbsNav
- zp_PHPMailer
- Option handler class
- print_album_menu
- Plugin option handling class
- publishContent
- quota_manager
- Option handler class
- jquery_rating
- Option handler class
- reCaptcha
- Standins for when no captcha is enabled
- redirectorOptions
- redirector plugin options
- redirector
- redirection handler class
- registerUserOptions
- Options class
- registerUser
- Plugin class
- register_user
- Plugin class
- rewriteRules
- rewriteTokens
- rss_options
- RSS
- Base feed class from which all others descend.
- scriptlessSocialsharingOptions
- scriptlessSocialsharing
- Static class wrapper
- search_statistics
- Option handler class
- security_logger
- Option handler class
- seo_locale
- null_seo
- Option handler class
- zenphoto_seo
- Option handler class
- show_not_loggedin
- zpSimpleSpam
- This implements the standard SpamFilter class for the Simple spam filter.
- sitemapOptions
- Plugin option handling class
- sitemap
- Sitemap class
- cycle
- Plugin option handling class
- staticHTMLCacheOptions
- static_html_cache
- tagsuggest
- themeSwitcher
- tinymceOptions
- Plugin option handling class
- tinymce4Options
- Plugin option handling class
- tinyURL
- zpTrivialSpam
- This implements the standard SpamFilter class for the none spam filter.
- UploadHandler
- UploadHandlerZP
- jQuery File Upload Plugin PHP Class based on the https://github.com/blueimp/jQuery-File-Upload
- uploaderjQueryOptions
- user_expiry
- Option handler class
- user_groups
- user_logout_options
- Plugin option handling class
- userAddressFields
- This is the root class for use by plugins to extend the Zenphoto database table fields. The administrative tabs for the objects will have input items for these new fields. They will be placed in the proximate location of the "custom data" field on the page.
- Zenpage
- Zenpage root classes
- ZenpageCategory
- zenpage news category class
- ZenpageItems
- Base class from which Zenpage news articles and pages derive
- ZenpageNews
- zenpage news class
- ZenpagePage
- zenpage page class
- ZenpageRoot
- Base class from which all Zenpage classes derive
- Zenpage_internal_deprecations
- These are the Zenpage functions which have been deprecated
- zenpagecms
- zenphoto_org_news
- zenphotoDonate
Constants
- ACK_DISPLAY_ERRORS = 2
- ADMIN_IMAGES_STEP = 5
- ADMIN_PLUGIN = 4096
- Defines the bitmask for load order priority of admin plugins
- ADMIN_RIGHTS = 1
- ALBUM_FOLDER_EMPTY = \getAlbumFolder('')
- ALBUM_FOLDER_SERVERPATH = \getAlbumFolder(\SERVERPATH)
- ALBUM_FOLDER_WEBPATH = \getAlbumFolder(\WEBPATH)
- ALBUM_MENU_COUNT = \getOption('print_album_menu_count')
- ALBUM_MENU_SHOWSUBS = \getOption('print_album_menu_showsubs')
- ALBUMFOLDER = 'albums'
- Defines the name of the albums folder
- ALL_ALBUMS_RIGHTS = \VIEW_ALL_RIGHTS
- ALL_NEWS_RIGHTS = \VIEW_ALL_RIGHTS
- ALL_PAGES_RIGHTS = \VIEW_ALL_RIGHTS
- BACKUPFOLDER = 'backup'
- Defines the name of the backup folder
- BASEPATH = true
- CACHE_HASH_LENGTH = \strlen(\sha1(\strval(\HASH_SEED)))
- CACHEFOLDER = 'cache'
- Defines the name of the image cache folder
- CASE_INSENSITIVE = \file_exists(\dirname(__FILE__) . '/VERSION.PHP')
- Defines if the server file system is case insensitive
- CHMOD_VALUE = \fileperms(\dirname(__FILE__)) & 0666
- CLASS_PLUGIN = 8192
- Defines the bitmask for load order priority of class plugins
- COMMENT_BODY_REQUIRED = 16
- COMMENT_DATACONFIRMATION = 64
- COMMENT_EMAIL_REQUIRED = 1
- COMMENT_MATHQUIZ = 256
- COMMENT_NAME_REQUIRED = 2
- COMMENT_SEND_EMAIL = 32
- COMMENT_TEXTQUIZ = 128
- COMMENT_WEB_REQUIRED = 4
- COMMENTS_PER_PAGE = \max(1, \getOption('comment_form_comments_per_page'))
- COMMON_FOLDER = \PLUGIN_FOLDER . '/common'
- Defines the name of the shared "common" folder within/for core extensions
- CONFIGFILE = 'zenphoto.cfg.php'
- Defines the name of the config file
- COOKIE_PATH = \WEBPATH
- COOKIE_PERSISTENCE = $persistence
- CUSTOM_OPTION_PREFIX = '_ZP_CUSTOM_'
- DATA_FOLDER = 'zp-data'
- Defines the name of the zp-data folder outside the core folder
- DATA_MOD = \fileperms(\SERVERPATH . '/' . \DATA_FOLDER . '/' . \CONFIGFILE) & 0777
- DATABASE_DESIRED_VERSION = '5.7.0'
- DATABASE_DESIRED_VERSION = '0.0.0'
- DATABASE_MARIADB_DESIRED_VERSION = '10.1.0'
- DATABASE_MARIADB_DESIRED_VERSION = '0.0.0'
- DATABASE_MARIADB_MIN_VERSION = '5.5.0'
- DATABASE_MARIADB_MIN_VERSION = '0.0.0'
- DATABASE_MIN_VERSION = '5.5.3'
- DATABASE_MIN_VERSION = '0.0.0'
- DATABASE_PREFIX = $mysql_prefix
- DATABASE_SOFTWARE = $_zp_conf_vars['db_software']
- DATABASE_SOFTWARE = 'Database setup'
- DATE_FORMAT = \trim(\strval(\getOption('date_format')))
- DATETIME_DISPLAYFORMAT = \DATETIME_FORMAT
- DATETIME_FORMAT = \DATE_FORMAT . ' ' . \TIME_FORMAT
- DEBUG_404 = isset($_zp_conf_vars['debug_404']) && $_zp_conf_vars['debug_404'] || \TEST_RELEASE
- set to true to log 404 error processing debug information.
- DEBUG_ERROR = isset($_zp_conf_vars['debug_error']) && $_zp_conf_vars['debug_error'] || \TEST_RELEASE
- set to true to supplies the calling sequence with zp_error messages
- DEBUG_EXIF = isset($_zp_conf_vars['debug_exif']) && $_zp_conf_vars['debug_exif']
- set to true to log start/finish of exif processing. Useful to find problematic images.
- DEBUG_FILTERS = isset($_zp_conf_vars['debug_filters']) && $_zp_conf_vars['debug_filters']
- set to true to log filter application sequence.
- DEBUG_IMAGE = isset($_zp_conf_vars['debug_image']) && $_zp_conf_vars['debug_image']
- set to true to log image processing debug information.
- DEBUG_IMAGE_ERR = isset($_zp_conf_vars['debug_image_err']) && $_zp_conf_vars['debug_image_err'] || \TEST_RELEASE
- set to true to flag image processing errors.
- DEBUG_LOCALE = isset($_zp_conf_vars['debug_locale']) && $_zp_conf_vars['debug_locale']
- used for examining language selection problems
- DEBUG_LOG_SIZE = \getOption('debug_log_size')
- DEBUG_LOGIN = isset($_zp_conf_vars['debug_login']) && $_zp_conf_vars['debug_login']
- set to true to log admin saves and login attempts
- DEBUG_PLUGINS = isset($_zp_conf_vars['debug_plugins']) && $_zp_conf_vars['debug_plugins']
- set to true to log plugin load sequence.
- EDITOR_SANITIZE_LEVEL = 1
- EDITOR_SANITIZE_LEVEL = 4
- EDITOR_SANITIZE_LEVEL = 4
- ELFINDER_PHP_ROOT_PATH = \dirname(__FILE__)
- ENT_SUBSTITUTE = \defined('ENT_IGNORE') ? \ENT_IGNORE : 8
- EXACT_TAG_MATCH = \getOption('exact_tag_match')
- EXPLAIN_SELECTS = isset($_zp_conf_vars['explain_selects']) && $_zp_conf_vars['explain_selects']
- set to true to log the "EXPLAIN" of SELECT queries in the debug log
- FEATURE_PLUGIN = 2048
- Defines the bitmask for load order priority of feature plugins
- FILE_MOD = \CHMOD_VALUE & 0666
- FILESYSTEM_CHARSET = $data
- FILESYSTEM_CHARSET = 'UTF-8'
- FOLDER_MOD = \CHMOD_VALUE | 0311
- FULLIMAGE_WATERMARK = \getOption('fullsizeimage_watermark')
- FULLWEBPATH = \SERVER_HTTP_HOST . \WEBPATH
- GALLERY_SECURITY = @$data['gallery_security']
- GALLERY_SESSION = @$data['album_session']
- 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_INCLUDEPATH = \SERVERPATH . '/' . \ZENFOLDER . '/' . \PLUGIN_FOLDER . '/class-video/getid3/'
- GETID3_LIBXML_OPTIONS = \LIBXML_NOENT | \LIBXML_NONET | \LIBXML_NOWARNING
- GETID3_OS_ISWINDOWS = \stripos(\PHP_OS, 'WIN') === 0
- GETID3_TEMP_DIR = $temp_dir
- GOOGLE_SITEMAP = \getOption('sitemap_google')
- GRAPHICS_LIBRARY = $_zp_cachefile_suffix['Library']
- HASH_SEED = \getOption('extra_auth_hash_text')
- HTACCESS_VERSION = '1.4.12'
- IM_SUFFIX = \getOption('mod_rewrite_image_suffix')
- IMAGE_CACHE_SUFFIX = \getOption('image_cache_suffix')
- IMAGE_SORT_DIRECTION = \getOption('image_sortdirection')
- IMAGE_SORT_TYPE = \getOption('image_sorttype')
- IMAGE_WATERMARK = \getOption('fullimage_watermark')
- IMAGEMAGICK_REQUIRED_VERSION = '6.3.8'
- IMAGICK_REQUIRED_VERSION = '3.0.0'
- IP_TIED_COOKIES = \getOption('IP_tied_cookies')
- LIST_RIGHTS = \NO_RIGHTS
- LOCAL_CHARSET = $data
- LOCAL_CHARSET = 'UTF-8'
- LOCALE_TYPE = 0
- LOGS_MOD = \DATA_MOD
- MANAGED_OBJECT_RIGHTS_EDIT = 1
- MANAGED_OBJECT_RIGHTS_UPLOAD = 2
- MANAGED_OBJECT_RIGHTS_VIEW = 4
- MAX_SIZE = \getOption('image_max_size')
- MEMBERS_ONLY_COMMENTS = \getOption('comment_form_members_only')
- MENU_TRUNCATE_INDICATOR = \getOption('menu_truncate_indicator')
- MENU_TRUNCATE_STRING = \getOption('menu_truncate_string')
- METATAG_LOCALE_TYPE = 0
- MOD_REWRITE = \getOption('mod_rewrite')
- MUTEX_FOLDER = '.mutex'
- Defines the mutex folder
- NEWS_POSITION_NORMAL = 0
- NEWS_POSITION_STICK_TO_TOP = 9
- NEWS_POSITION_STICKY = 1
- NO_WATERMARK = '!'
- OBJECT_CACHE_DEPTH = 150
- OFFSET_PATH = 1
- used in sorting the images within and album
- OFFSET_PATH = 1
- This script is used to create dynamic albums from a search.
- OFFSET_PATH = 1
- admin-edit.php editing of albums.
- OFFSET_PATH = 1
- user_groups log--tabs
- OFFSET_PATH = 1
- provides the Options tab of admin
- OFFSET_PATH = 1
- provides the Plugins tab of admin
- OFFSET_PATH = 2
- This template is used to reload metadata from images. Running it will process the entire gallery, supplying an album name (ex: loadAlbums.php?album=newalbum) will only process the album named.
- OFFSET_PATH = 1
- provides the TAGS tab of admin
- OFFSET_PATH = 1
- Theme file editor
- OFFSET_PATH = 1
- provides the Themes tab of admin
- OFFSET_PATH = 1
- OFFSET_PATH = 1
- provides the Upload tab of admin
- OFFSET_PATH = 1
- provides the Options tab of admin
- OFFSET_PATH = 1
- admin.php is the main script for administrative functions.
- OFFSET_PATH = 1
- OFFSET_PATH = 1
- OFFSET_PATH = 0
- OFFSET_PATH = 2
- OFFSET_PATH = 1
- OFFSET_PATH = 2
- OFFSET_PATH = 2
- OFFSET_PATH = 2
- Used for changing permissions on a mass basis
- OFFSET_PATH = 2
- Used for setting theme/plugin default options
- OFFSET_PATH = 2
- Used for setting theme/plugin default options
- OFFSET_PATH = 3
- OFFSET_PATH = 3
- Database quick reference
- OFFSET_PATH = 3
- Detailed Gallery Statistics
- OFFSET_PATH = 3
- Displays which HTTP headers your site sends
- OFFSET_PATH = 3
- Displays locale information of the system
- OFFSET_PATH = 3
- Maintenance mode utility based on the former site_upgrade plugin
- OFFSET_PATH = 3
- Displays the PHP configuration information
- OFFSET_PATH = 3
- Use this utility to reset your album thumbnails to either "random" or from an ordered field query
- OFFSET_PATH = 3
- GDPR data export tool
- OFFSET_PATH = 3
- This template is used to generate cache images. Running it will process the entire gallery, supplying an album name (ex: loadAlbums.php?album=newalbum) will only process the album named.
- OFFSET_PATH = 3
- This template is used to generate cache images. Running it will process the entire gallery, supplying an album name (ex: loadAlbums.php?album=newalbum) will only process the album named.
- OFFSET_PATH = 4
- Zenphoto site cloner
- OFFSET_PATH = 4
- OFFSET_PATH = 1
- provides the Comments tab of admin
- OFFSET_PATH = 3
- OFFSET_PATH = 4
- Check for use of deprecated functions
- OFFSET_PATH = 3
- Detailed Gallery Statistics
- OFFSET_PATH = 3
- OFFSET_PATH = 3
- OFFSET_PATH = 3
- The Matomo statistis page if widgets are defined
- OFFSET_PATH = 4
- OFFSET_PATH = 4
- OFFSET_PATH = 3
- OFFSET_PATH = 4
- OFFSET_PATH = 3
- OFFSET_PATH = 3
- This is the "rewrite rules" tab
- OFFSET_PATH = 4
- Collects and analyzes searches
- OFFSET_PATH = 3
- OFFSET_PATH = 3
- Sitemap Tools
- OFFSET_PATH = 3
- OFFSET_PATH = 3
- OFFSET_PATH = 3
- OFFSET_PATH = 3
- OFFSET_PATH = 3
- OFFSET_PATH = 3
- OFFSET_PATH = 4
- user_groups plugin--tabs
- OFFSET_PATH = 4
- user_groups plugin--tabs
- OFFSET_PATH = 3
- OFFSET_PATH = 4
- zenpage admin-categories.php
- OFFSET_PATH = 4
- zenpage admin-edit.php
- OFFSET_PATH = 4
- zenpage admin-news-articles.php
- OFFSET_PATH = 4
- zenpage admin-pages.php
- OPEN_IMAGE_CACHE = !\getOption('protected_image_cache')
- OPTION_TYPE_CHECKBOX = 1
- OPTION_TYPE_CHECKBOX_ARRAY = 6
- OPTION_TYPE_CHECKBOX_UL = 7
- OPTION_TYPE_CLEARTEXT = 9
- OPTION_TYPE_COLOR_PICKER = 8
- OPTION_TYPE_CUSTOM = 2
- OPTION_TYPE_NOTE = 10
- OPTION_TYPE_PASSWORD = 11
- OPTION_TYPE_RADIO = 4
- OPTION_TYPE_RICHTEXT = 12
- OPTION_TYPE_SELECTOR = 5
- OPTION_TYPE_TEXTAREA = 3
- OPTION_TYPE_TEXTBOX = 0
- Generates the HTML for custom options (e.g. theme options, plugin options, etc.) Note: option names may not contain '.', '+', nor '%' as PHP POST handling will replace these with an underscore.
- PHP_INT_MAX = 2147483647
- PHP_INT_MIN = ~PHP_INT_MAX
- PLUGIN_FOLDER = 'zp-extensions'
- Defines the name of the core extensions folder
- PLUGIN_PRIORITY = 1023
- Defines the bitmask for load order priority of standard plugins
- PLUGINS_PER_PAGE = \max(1, \getOption('plugins_per_page'))
- PLUGINS_PER_PAGE = \max(1, \getOption('plugins_per_page'))
- PRIMARY_INSTALLATION = true
- PROTOCOL = 'http'
- PROTOCOL = 'http'
- RECORD_LIMIT = 5
- SAFE_MODE = \false
- SAFE_MODE_ALBUM_SEP = ''
- SEARCH_CACHE_DURATION = \getOption('search_cache_duration')
- SEARCH_DURATION = 3000
- SEO_FULLWEBPATH = \FULLWEBPATH
- SEO_FULLWEBPATH = \seo_locale::localePath(\true)
- SEO_WEBPATH = \WEBPATH
- SEO_WEBPATH = \seo_locale::localePath()
- SERVER_HTTP_HOST = \PROTOCOL . "://" . $_SERVER['HTTP_HOST']
- SERVER_PROTOCOL = 'http'
- SERVERCACHE = \SERVERPATH . '/' . \CACHEFOLDER
- SERVERPATH = $const_serverpath
- SERVERPATH = $_zp_setup_serverpath
- SERVERPATH = $_zp_setup_serverpath
- SETUPLOG = $_zp_setup_serverpath . '/' . \DATA_FOLDER . '/setup.log'
- SITE_LOCALE = 'en_US'
- SITEMAP_CHUNK = \getOption('sitemap_processing_chunk')
- SITEMAP_LOCALE_TYPE = 0
- SORT_FLAG_CASE = 0
- Defines sort flag case
- SORT_NATURAL = 0
- Defines if sorting should be natural order
- STATIC_CACHE_FOLDER = "cache_html"
- Defines the name of the html cache folder
- SYMLINK = \function_exists('symlink') && \strpos(@\ini_get("suhosin.executor.func.blacklist"), 'symlink') === \false
- Defines if symlinks are supported on the server
- TEST_RELEASE = isset($_zp_conf_vars['test_release']) && $_zp_conf_vars['test_release'] || \preg_match('~-[^RC]~', \ZENPHOTO_VERSION)
- Enables test release mode, supports the markRelease plugin
- TEXT_INPUT_SIZE = 48
- TEXT_INPUT_SIZE_SHORT = 30
- TEXTAREA_COLUMNS = 50
- TEXTAREA_COLUMNS_SHORT = 32
- THEME_PLUGIN = 1024
- Defines the bitmask for load order priority of theme plugins
- THEMEFOLDER = 'themes'
- Defines the name of the themes folder
- THUMB_WATERMARK = \getOption('Image_watermark')
- TIME_FORMAT = \trim(\strval(\getOption('time_format')))
- UPLOAD_ERR_BLOCKED = -2
- UPLOAD_ERR_QUOTA = -1
- Initialize globals for Admin
- UPLOAD_FOLDER = 'uploaded'
- Defines name of the non albums upload folder
- USE_CAPTCHA = 8
- USER_PLUGIN_FOLDER = 'plugins'
- Defines the user 3rd party plugin folder outside the Zenphoto core folder
- USER_RIGHTS = \NO_RIGHTS
- USERS_PER_PAGE = \max(1, \getOption('users_per_page'))
- USERS_PER_PAGE = \max(1, \getOption('users_per_page'))
- UTF8_IMAGE_URI = \getOption('UTF8_image_URI')
- UTILITIES_FOLDER = 'utilities'
- Defines the name of the core utlitlites folder
- VIEW_ALL_RIGHTS = \ALL_ALBUMS_RIGHTS | \ALL_PAGES_RIGHTS | \ALL_NEWS_RIGHTS
- VIEW_FULLIMAGE_RIGHTS = \NO_RIGHTS
- VIEW_GALLERY_RIGHTS = \NO_RIGHTS
- VIEW_SEARCH_RIGHTS = \NO_RIGHTS
- WATERMARK_FULL = 4
- WATERMARK_IMAGE = 1
- WATERMARK_THUMB = 2
- WEBPATH = $const_webpath
- WEBPATH = $const_webpath
- ZENFOLDER = 'zp-core'
- Defines the name of the Zenphoto core folder (zp-core)
- ZENPAGE_COMBINEWS = \false
- Some global variable setup
- ZENPHOTO_LOCALE = \setMainDomain()
- ZENPHOTO_VERSION = '1.6.5'
- Defines the Zenphoto version
- ZP_ALBUM = 2
- ZP_ALBUM_LINKED = 64
- ZP_ARTICLES_PER_PAGE = \getOption("zenpage_articles_per_page") >= 1 ? \getOption("zenpage_articles_per_page") : 1
- ZP_COMBINEWS = \false
- ZP_COMMENT = 8
- ZP_IMAGE = 4
- ZP_IMAGE_LINKED = 128
- ZP_INDEX = 1
- ZP_LAST_MODIFIED = \gmdate('D, d M Y H:i:s') . ' GMT'
- Defines the date of the current session for use as a last modified date within the page header()
- ZP_NEWS_ENABLED = \false
- ZP_PAGES_ENABLED = \false
- ZP_READ_MORE = \getOption("zenpage_read_more")
- ZP_SEARCH = 16
- ZP_SEARCH_LINKED = 32
- ZP_SHORTEN_LENGTH = \getOption('zenpage_text_length')
- ZP_SHORTENINDICATOR = $shortenindicator = \getOption('zenpage_textshorten_indicator')
- ZP_ZENPAGE_NEWS_ARTICLE = 512
- ZP_ZENPAGE_NEWS_CATEGORY = 1024
- ZP_ZENPAGE_NEWS_DATE = 2048
- ZP_ZENPAGE_NEWS_PAGE = 256
- ZP_ZENPAGE_PAGE = 4096
- ZP_ZENPAGE_SINGLE = 8192
Functions
- printAdminFooter() : mixed
- Print the footer <div> for the bottom of all admin pages.
- datepickerJS() : mixed
- printAdminHeader() : mixed
- Print the header for all admin pages. Starts at <DOCTYPE> but does not include the </head> tag, in case there is a need to add something further.
- printSortableHead() : mixed
- printLogoAndLinks() : mixed
- Print the html required to display the ZP logo and links in the top section of the admin page.
- printTabs() : mixed
- Print the nav tabs for the admin section. We determine which tab should be highlighted from the $_GET['page']. If none is set, we default to "home".
- getSubtabs() : mixed
- printSubtabs() : mixed
- setAlbumSubtabs() : mixed
- handleDeprecatedMenuGlobals() : mixed
- Roughly fixes outdated usages of old admin "tab" globals and joins them with the actual globals.
- checked() : mixed
- Used for checkbox and radiobox form elements to compare the $checked value with the $current.
- customOptions() : mixed
- processCustomOptionSave() : mixed
- standardThemeOptions() : mixed
- Set defaults for standard theme options incase the theme has not done so
- postIndexEncode() : mixed
- Encodes for use as a $_POST index
- postIndexDecode() : string
- Decodes encoded $_POST index
- generateRadiobuttonsFromArray() : mixed
- Prints radio buttons from an array
- generateUnorderedListFromArray() : mixed
- Creates the body of an unordered list with checkbox label/input fields (scrollable sortables)
- tagSelector() : mixed
- Creates an unordered checklist of the tags
- printAlbumEditForm() : mixed
- emits the html for editing album information called in edit album and mass edit
- printAlbumButtons() : mixed
- puts out the maintenance buttons for an album
- printAlbumLegend() : mixed
- printAlbumEditRow() : mixed
- puts out a row in the edit album table
- processAlbumEdit() : string
- processes the post from the above
- processImageEdit() : mixed
- Process the image edit form posted
- adminPageNav() : mixed
- print_language_string_list() : mixed
- Generates an editable list of language strings
- process_language_string_save() : string
- process the post of a language string form
- getTagOrder() : int
- Returns the desired tagsort order (0 for alphabetic, 1 for most used)
- unzip() : mixed
- Unzips an image archive
- is_zip() : bool
- Checks for a zip file
- isolate() : string
- Extracts and returns a 'statement' from a PHP script so that it may be 'evaled'
- listDirectoryFiles() : array<string|int, mixed>
- Return an array of files from a directory and sub directories
- themeIsEditable() : bool
- Check if a theme is editable (ie not a bundled theme)
- zenPhotoTheme() : mixed
- copyThemeDirectory() : bool|string
- Copy a theme directory to create a new custom theme
- deleteThemeDirectory() : bool
- Deletes a theme
- currentRelativeURL() : string
- Return URL of current admin page
- getParentAlbumsAdmin() : array<string|int, mixed>
- Returns an array of the names of the parents of the current album.
- getAlbumBreadcrumbAdmin() : mixed
- removeParentAlbumNames() : string
- Removes the parent album name so that we can print a album breadcrumb with them
- printAdminRightsTable() : mixed
- Outputs the rights checkbox table for admin
- printManagedObjects() : mixed
- Creates the managed album table for Admin
- processRights() : bit
- processes the post of administrator rights
- processManagedObjects() : mixed
- getCheckboxState() : int
- Returns the value of a checkbox form item
- standardScripts() : array<string|int, mixed>
- Returns an array of "standard" theme scripts. This list is normally used to exclude these scripts form various option seletors.
- getWatermarks() : array<string|int, mixed>
- Returns a merged list of available watermarks
- processOrder() : array<string|int, mixed>
- Processes the serialized array from tree sort.
- postAlbumSort() : mixed
- POST handler for album tree sorts
- printNestedAlbumsList() : bool
- Prints the sortable nested albums list returns true if nesting levels exceede the database container
- printEditDropdown() : mixed
- Prints the dropdown menu for the nesting level depth for the album sorting
- processEditSelection() : mixed
- printBulkActions() : mixed
- Edit tab bulk actions drop-down
- bulkActionRedirect() : mixed
- common redirector for bulk action handling return
- bulkTags() : array<string|int, mixed>
- Process the bulk tags
- processAlbumBulkActions() : mixed
- Processes the check box bulk actions for albums
- processImageBulkActions() : mixed
- Handles Image bulk actions
- processCommentBulkActions() : mixed
- Processes the check box bulk actions for comments
- codeblocktabsJS() : mixed
- Codeblock tabs JavaScript code
- printCodeblockEdit() : mixed
- prints codeblock edit boxes
- processCodeblockSave() : string
- handles saveing of codeblock edits
- admin_securityChecks() : mixed
- Standard admin pages checks
- minDiff() : mixed
- getPageSelector "diff" function
- fullText() : string
- getPageSelector "diff" function
- dateDiff() : string
- getPageSelector "diff" function
- getPageSelector() : array<string|int, mixed>
- returns a selector list based on the "names" of the list items
- printPageSelector() : mixed
- unQuote() : mixed
- Strips off quotes from the strng
- admin_album_list() : string
- Returns an option list of administrators who can own albums or images
- getLogTabs() : array<string|int, mixed>
- Returns an array with the logtabs array, the default log tab and an array of log files to the default (current) log tab (for use in the logfile selector)
- getDefaultLogTabs() : array<string|int, mixed>
- Gets an array log tab names and localized (gettexted) log titles
- getLogFiles() : array<string|int, mixed>
- Gets a nested array with the log type (tab name) and corresponding log files
- printLogSelector() : mixed
- Prints the selector for logfiles of the current log tab
- getPluginTabs() : mixed
- Figures out which plugin tabs to display
- getAdminThumbSizes() : array<string|int, mixed>
- Gets an array with the size values for the admin thumb generation
- getAdminThumb() : string
- Gets the URL of the adminthumb
- getSizeAdminThumb() : array<string|int, mixed>
- Returns an array with width and height of the resized image
- getAdminThumbHTML() : string
- Returns the full HTML element of an admin thumb Applies the filters 'adminthumb_html'
- printAdminThumb() : string
- Prints an admin thumb
- processCredentials() : mixed
- handles save of user/password
- consolidatedEditMessages() : mixed
- getThemeFiles() : array<string|int, mixed>
- returns an array of the theme scripts not in the exclude array
- checkAlbumParentid() : mixed
- Checks for bad parentIDs from old move/copy bug
- clonedFrom() : mixed
- checkAlbumimagesort() : string
- Make sure the albumimagesort is only an allowed value. Otherwise returns nothing.
- printLastChangeInfo() : mixed
- Prints the last change date and last change user notice on backend edit pages Also for albums it prints the updateddate
- getSortByOptions() : array<string|int, mixed>
- Returns the option array for the sort by selectors for gallery, albums and images
- getSortByStatusOptions() : array<string|int, mixed>
- Returns an array of the status order options for all items
- checkSchedulePublishingNotes() : bool
- Helper to check if notes are to be printed (only needed because of the inconvenient legacy table based layout on image edit pages)
- printScheduledPublishingNotes() : mixed
- Prints various notes regarding the scheduled publishing status for single edit pages
- printStatusNotes() : mixed
- Prints various notes regarding the scheduled publishing status for single edit pages
- getStatusNote() : string
- Gets a specific predefined status note for an object (if available) Note: The notes are not status dependend!
- getStatusNotes() : array<string|int, mixed>
- Gets an array of all predefined status notes
- getStatusNotesByContext() : array<string|int, mixed>
- Gets an array with all status notes that apply to $obj currently
- getStatusIcons() : array<string|int, mixed>
- Gets an key => value array of all available object status icons as full <img> elements
- getStatusIcon() : string
- Gets the icon img element for a specific status icon
- printPublishIconLinkGallery() : mixed
- Prints the publish icon link to change the status on the album and thumb image list
- getPublishIcon() : string
- Returns the publish icon for the current status
- printPublished() : string
- Prints the scheduled publishing date for items if set. Also prints the date for Zenpage news articles and pages
- printExpired() : string
- Prints the expiration or expired date for items
- printProtectedIcon() : mixed
- Prints the protected icon if the object is password protected on an edit list
- isIncompatibleExtension() : bool|string
- Checks plugin and theme definition for $plugin_disable / $theme_description['disable'] so plugins/themes are deaktivated respectively cannot be activated if they don't match conditions/requirements. See the plugin/theme documentation for info how to define these.
- processExtensionVariable() : string|bool
- Processes a plugin or theme definition variable.
- printSelectorWithCustomField() : mixed
- Prints a selector (select list) with a custom text field from the values parameter. The following array entries will be created automatically:
- getZenpagePagesOptionsArray() : mixed
- Gets an array of Zenpage pages ready for using with selector, radioboxes and checkbox lists
- printZenpagePageSelector() : mixed
- Prints an select list option for Zenpage pages
- getAdminstratorsOptionsArray() : type
- Gets an array of administrators ready for using with selector, radioboxes and checkbox lists
- printUserSelector() : mixed
- Prints an select list option for users
- isTextFile() : type
- Helper for the theme editor
- getSubalbumImages() : type
- Updates the $_zp_admin_imagelist global used on dynamic album editing
- markUpdated() : mixed
- Updates $_zp_admin_user_updated on user editing
- printImageRotationSelector() : mixed
- Prints the image EXIF rotation/flipping selector
- printDatetimeFormatSelector() : mixed
- Prints option selectors for date and time formats
- getDatetimeFormatlistForSelector() : array<string|int, mixed>
- Helper functions for printDatetimeFormatSelector() ot create the format lists for the selector, not intended to be used standalone
- db_connect() : true
- Connect to the database server and select the database.
- query() : results
- The main query function. Runs the SQL on the connection and handles errors.
- query_single_row() : results
- Runs a SQL query and returns an associative array of the first row.
- query_full_array() : results
- Runs a SQL query and returns an array of associative arrays of every row returned.
- db_quote() : string
- mysqli_real_escape_string standin that insures the DB connection is passed.
- db_insert_id() : mixed
- returns the insert id of the last database insert
- db_fetch_assoc() : mixed
- Fetch a result row as an associative array
- db_error() : mixed
- Returns the text of the error message from previous operation
- db_affected_rows() : mixed
- Get number of affected rows in previous operation
- db_fetch_row() : mixed
- Get a result row as an enumerated array
- db_num_rows() : mixed
- Get number of rows in result
- db_close() : mixed
- Closes the database
- db_software() : mixed
- report the software of the database
- db_create() : mixed
- create the database
- db_permissions() : mixed
- Returns user's permissions on the database
- db_setSQLmode() : mixed
- Sets the SQL session mode to empty
- db_getSQLmode() : mixed
- Queries the SQL session mode
- db_collation() : mixed
- db_create_table() : mixed
- db_table_update() : mixed
- db_show() : mixed
- db_list_fields() : mixed
- db_truncate_table() : mixed
- db_LIKE_escape() : mixed
- db_free_result() : mixed
- prefix() : prefixed
- Prefix a table name with a user-defined string to avoid conflicts.
- getWhereClause() : contructed
- Constructs a WHERE clause ("WHERE uniqueid1='uniquevalue1' AND uniqueid2='uniquevalue2' ...") from an array (map) of variables and their values which identifies a unique record in the database table.
- getSetClause() : contructed
- Constructs a SET clause ("SET uniqueid1='uniquevalue1', uniqueid2='uniquevalue2' ...") from an array (map) of variables and their values which identifies a unique record in the database table. Used to 'move' records. Note: does not check anything.
- db_name() : mixed
- returns the connected database name
- db_count() : int
- Counts entries in a db table
- db_getServerInfo() : string
- Returns the server info
- db_getClientInfo() : string
- Returns the client info
- db_getVersion() : int
- Gets the plain version number
- zp_imageGet() : mixed
- zp_imageOutput() : mixed
- zp_createImage() : mixed
- zp_imageFill() : mixed
- zp_imageColorTransparent() : mixed
- zp_copyCanvas() : mixed
- zp_resampleImage() : mixed
- zp_imageUnsharpMask() : mixed
- zp_imageResizeAlpha() : mixed
- zp_imageCanRotate() : mixed
- zp_rotateImage() : mixed
- zp_imageDims() : mixed
- zp_imageIPTC() : mixed
- zp_imageWidth() : mixed
- zp_imageHeight() : mixed
- zp_imageMerge() : mixed
- zp_imageGray() : mixed
- zp_imageKill() : mixed
- zp_colorAllocate() : mixed
- zp_writeString() : mixed
- zp_drawRectangle() : mixed
- zp_graphicsLibInfo() : mixed
- zp_getFonts() : mixed
- zp_imageLoadFont() : mixed
- zp_imageFontWidth() : mixed
- zp_imageFontHeight() : mixed
- imageBlurGD() : mixed
- zp_imageFromString() : mixed
- js_encode() : string
- encodes a pre-sanitized string to be used as a Javascript parameter
- getOption() : mixed
- Get a option stored in the database.
- setOption() : mixed
- Stores an option value.
- setOptionDefault() : mixed
- Sets the default value of an option.
- loadLocalOptions() : mixed
- Loads option table with album/theme options
- renameOption() : 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.
- purgeOption() : mixed
- Deletes an option from the database
- getOptionList() : array<string|int, mixed>
- Retuns the option array
- hasDynamicAlbumSuffix() : bool
- Returns true if the file has the dynamic album suffix
- isHandledAlbum() : string
- checks if there is a file with the prefix and one of the handled suffixes. Returns the found suffix
- rewrite_get_album_image() : mixed
- Handles the special cases of album/image[rewrite_suffix]
- getImageCacheFilename() : string
- Returns the path of an image for uses in caching it NOTE: character set if for the filesystem
- makeSpecialImageName() : array<string|int, mixed>
- Returns an i.php "image name" for an image not within the albums structure
- getWatermarkParam() : int
- Returns the watermark image to pass to i.php
- getImageCachePostfix() : string
- Returns the crop/sizing string to postfix to a cache image
- getImageParameters() : array<string|int, mixed>
- Validates and edits image size/cropping parameters
- getImageProcessorURI() : string
- forms the i.php parameter list for an image.
- getImageArgs() : array<string|int, mixed>
- Extract the image parameters from the input variables
- getImageProcessorURIFromCacheName() : array<string|int, mixed>
- Extracts the image processor URI from an existing cache filename
- getImageURI() : string
- Returns an URI to the image:
- extractImageExifOrientation() : int
- Extracts integer value (1-9) from the exifOrientation value stored (e.g. '7: 90 deg CCW Mirrored') in the database for images or returns the value if it is an integer
- getImageFlipRotate() : bool|array<string|int, mixed>
- Returns an array with two indexes "rotate" (= degree to rotate) and "flip" ("horizontal" or "vertical") or false if nothing applies
- getAllowedTags() : mixed
- Returns an array of html tags allowed
- rewrite_path() : string
- Returns either the rewrite path or the plain, non-mod_rewrite path based on the mod_rewrite option.
- parse_query() : mixed
- parses a query string WITHOUT url decoding it!
- build_query() : string
- createsa query string from the array passed
- build_url() : string
- Builds a url from parts
- pathurlencode() : string
- rawurlencode function that is path-safe (does not encode /)
- getAlbumFolder() : string
- Returns the fully qualified path to the album folders
- getBackupFolder() : string
- Returns the fully qualified path to the backup folder
- getRootFolder() : string
- Returns the fully qualified path to the root albums or backup folder
- switchLog() : mixed
- Rolls a log over if it has grown too large.
- debugLog() : mixed
- Write output to the debug log Use this for debugging when echo statements would come before headers are sent or would create havoc in the HTML.
- instrument() : mixed
- Tool to log execution times of script bits
- parse_size() : mixed
- Parses a byte size from a size value (eg: 100M) for comparison.
- getAlbumArray() : mixed
- getAlbumArray - returns an array of folder names corresponding to the given album string.
- imgSrcURI() : string
- Returns an img src URI encoded based on the OS of the server
- getSuffix() : string
- Returns the suffix of a file name
- stripSuffix() : string
- returns a file name sans the suffix
- getAlbumInherited() : string
- returns the non-empty value of $field from the album or one of its parents
- themeSetup() : string
- primitive theme setup for image handling scripts
- accessAllAlbums() : mixed
- Checks access for the album root
- getWatermarkPath() : string
- Returns the path to a watermark
- secureServer() : bool
- Checks to see if access was through a secure protocol
- getRequestURI() : string
- Returns the script requesting URI.
- safe_glob() : mixed
- Provide an alternative to glob which does not return filenames with accented charactes in them
- checkInstall() : mixed
- Check to see if the setup script needs to be run
- exitZP() : mixed
- Call when terminating a script.
- installSignature() : array<string|int, mixed>
- Computes the "installation signature" of the Zenphoto install
- zp_session_start() : mixed
- Starts a zenphoto session (perhaps a secure one)
- zp_session_destroy() : mixed
- Ends a zenphoto session if there is one and clear the session cookie
- getDefaultRewriteTokens() : array<string|int, mixed>
- Reads the core default rewrite token define array from the config template file `zenphoto_cfg.txt`.
- addMissingDefaultRewriteTokens() : mixed
- Adds missing individual default rewrite tokens to $_zp_conf_vars['special_pages']
- curlRequest() : bool
- Sends a simple cURL request to the $uri specified.
- generateImageCacheFile() : mixed
- Sends a cURL request to i.php to generate the image requested without printing it.
- httpsRedirect() : mixed
- Checks if protocol not https and redirects if https required
- redirectURL() : mixed
- General url redirection handler using header()
- sanitizeRedirect() : string
- Sanitizes a "redirect" post to always be within the site
- callUserFunction() : mixed
- Wrapper to call a plugin or otherwise possibly undefined function or method to avoid themes breaking if the plugin is not active
- deprecationNotice() : mixed
- Logs a deprecated notice including traces in the debuglog
- convertStrftimeFormat() : string
- Basic conversion for a (deprecated) strftime() date format string
- hasPrimaryScripts() : mixed
- Returns true if the install is not a "clone"
- zpErrorHandler() : void|bool
- Traps errors and insures thy are logged.
- filesystemToInternal() : string
- Converts a file system filename to UTF-8 for zenphoto internal storage
- internalToFilesystem() : string
- Converts a Zenphoto Internal filename string to one compatible with the file system
- sanitize_path() : string
- Takes user input meant to be used within a path to a file or folder and removes anything that could be insecure or malicious, or result in duplicate representations for the same physical file.
- sanitize_numeric() : int
- Checks if the input is numeric, rounds if so, otherwise returns false.
- sanitize_script() : string
- removes script tags
- sanitize() : string
- Make strings generally clean. Takes an input string and cleans out null-bytes, and optionally use KSES library to prevent XSS attacks and other malicious user input.
- ksesProcess() : string
- Internal "helper" function to apply the tag removal
- getBare() : type
- Cleans tags and some content.
- sanitize_string() : string
- returns a sanitized string for the sanitize function
- zp_error() : mixed
- triggers an error
- html_decode() : mixed
- html_encode() : string
- encodes a pre-sanitized string to be used in an HTML text-only field (value, alt, title, etc.)
- html_encodeTagged() : string
- HTML encodes the non-metatag part of the string.
- html_pathurlencode() : string
- Convenience wrapper of html_encode(pathurlencode($url)) Primarily intended for use with img src URLs
- mkdir_recursive() : bool
- Makes directory recursively, returns TRUE if exists or was created sucessfuly.
- debugLogBacktrace() : mixed
- Logs the calling stack
- debugLogVar() : mixed
- Records a Var to the debug log
- zp_getCookie() : mixed
- Returns the value of a cookie from either the cookies or from $_SESSION[]
- zp_cookieEncode() : mixed
- Encodes a cookie value tying it to the user IP
- zp_setCookie() : mixed
- Sets a cookie both in the browser cookies and in $_SESSION[]
- zp_clearCookie() : mixed
- Clears a cookie
- getSerializedArray() : array<string|int, mixed>
- if $string is an serialzied array it is unserialized otherwise an appropriate array is returned
- updateConfigItem() : mixed
- Updates an item in the configuration file
- storeConfig() : mixed
- backs-up and updates the Zenphoto configuration file
- zpRewriteURL() : string
- Creates a "REWRITE" url given the query parameters that represent the link
- fix_path_redirect() : mixed
- Checks to see if the current URL is a query string url when mod_rewrite is active.
- zp_load_page() : mixed
- zp_load_gallery() : mixed
- initializes the gallery.
- zp_load_search() : mixed
- Loads the search object.
- zp_load_album() : the
- zp_load_album - loads the album given by the folder name $folder into the global context, and sets the context appropriately.
- zp_load_image() : the
- zp_load_image - loads the image given by the $folder and $filename into the global context, and sets the context appropriately.
- load_zenpage_pages() : object
- Loads a zenpage pages page Sets up $_zp_current_zenpage_page and returns it as the function result.
- load_zenpage_news() : object
- Loads a zenpage news article Sets up $_zp_current_zenpage_news and returns it as the function result.
- zp_load_request() : bool
- Figures out what is being accessed and calls the appropriate load function
- prepareIndexPage() : string
- sets up for loading the index page
- prepareAlbumPage() : mixed
- sets up for loading an album page
- prepareImagePage() : string
- sets up for loading an image page
- prepareCustomPage() : string
- sets up for loading p=page pages
- redirectionHandler() : mixed
- Handles redirections via filter hook "redirection_handler".
- zp_register_filter() : mixed
- Registers a filtering function Filtering functions are used to post process zenphoto elements or to trigger functions when a filter occur
- zp_filter_unique_id() : string
- Build Unique ID for storage and retrieval.
- zp_apply_filter() : mixed
- Performs a filtering operation on a zenphoto element or event.
- zp_remove_filter() : bool
- Removes a function from a specified filter hook.
- zp_has_filter() : int|bool
- Check if any filter has been registered for a hook.
- get_filterScript() : string
- returns a list of scripts that have attached to the hook
- zp_filter_slot() : mixed
- Returns the position of the function in the hook queue
- getLanguageArray() : mixed
- functions-i18n.php -- support functions for internationalization
- 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 Used for setting default options with multi-lingual strings.
- 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
- reconfigureAction() : mixed
- Executes the configuration change code
- checkSignature() : type
- Checks details of configuration change
- signatureChange() : string
- Notification handler for configuration change
- addReconfigureNote() : mixed
- Adds the reconfigure notification via filters
- printReconfigureNote() : mixed
- prints HTML for the configuration change notification
- getReconfigureNote() : array<string|int, mixed>
- Gets data for the configuration change notification
- printReconfigureError() : mixed
- Prints an error page on the frontend if a mandatory reconfigure issue occurred but the visitor is not loggedin with appropiate rights.
- debuglogReconfigureNote() : mixed
- Adds debuglog entries about the reconfigure note
- ignoreSetupRunRequest() : mixed
- If setup request a run because of a signature change this refreshes the signature on full admin user request so it is ignored until the next signature change.
- isSetupProtected() : array<string|int, mixed>
- Checks if setup files are protected. Returns array of the protected files or empty array
- unprotectSetupFiles() : mixed
- Unprotectes setup files
- protectSetupFiles() : mixed
- Protects setup files
- reconfigureCSS() : mixed
- CSS for the configuration change notification
- rewriteHandler() : mixed
- "Rewrite" handling for Zenphoto
- getRules() : mixed
- parseAllowedTags() : array<string|int, mixed>
- parses the allowed HTML tags for use by htmLawed
- checkObjectsThumb() : string
- Search for a thumbnail for the image
- truncate_string() : string
- Returns a truncated string
- tidyHTML() : string
- Fixes unbalanced HTML tags. Uses the library htmlawed or if available the native PHP extension tidy
- shortenContent() : string
- Returns truncated html formatted content
- lookupSortKey() : string
- Returns a sort field part for querying Note: $sorttype may be a comma separated list of field names. If so, these are peckmarked and returned otherwise unchanged.
- zpFormattedDate() : string
- Returns a formatted date for output
- getDatetimeObject() : object
- Returns a datetime object
- getStandardDateFormats() : array<string|int, mixed>
- Returns an array with datetime (keys) and ICU dateformat (values) strings
- myts_date() : string
- Simple SQL timestamp formatting function.
- zp_mail() : string
- Send an mail to the mailing list. We also attempt to intercept any form injection attacks by slime ball spammers. Returns error message if send failure.
- sortByMultilingual() : array<string|int, mixed>
- Sorts the results of a DB search by the current locale string for $field
- checkAlbumPassword() : bool
- Checks to see access is allowed to an album Returns true if access is allowed.
- getPluginFiles() : array<string|int, mixed>
- Returns a consolidated list of plugins The array structure is key=plugin name, value=plugin path
- getPlugin() : string|false
- Returns the fully qualified file path of a plugin file.
- getEnabledPlugins() : array<string|int, mixed>
- Returns an array of the currently enabled plugins
- extensionEnabled() : bool
- Returns if a plugin is enabled
- enableExtension() : mixed
- Enables a plugin
- disableExtension() : mixed
- Disables an extension
- getManagedAlbumList() : array<string|int, mixed>
- Populates and returns the $_zp_admin_album_list array
- populateManagedObjectsList() : array<string|int, mixed>
- Returns a list of album names managed by $id
- getAllSubAlbumIDs() : array<string|int, mixed>
- Returns an array of album ids whose parent is the folder
- handleSearchParms() : mixed
- recovers search parameters from stored cookie, clears the cookie
- galleryAlbumsPerPage() : int
- Returns the number of album thumbs that go on a gallery page
- setupTheme() : string
- Returns the theme folder If there is an album theme, loads the theme options.
- getAllTagsUnique() : array<string|int, mixed>
- Returns an array of unique tag names
- getAllTagsCount() : array<string|int, mixed>
- Returns an array indexed by 'tag' with the element value the count of the tag
- getTagCountByAccess() : int
- Checks if a tag is assigned at all and if it can be viewed by the current visitor and returns the corrected count Helper function used optionally within getAllTagsCount() and getAllTagsUnique()
- storeTags() : mixed
- Stores tags for an object
- readTags() : unknown
- Retrieves the tags for an object Returns them in an array
- generateListFromArray() : mixed
- Creates the body of a select list
- generateListFromFiles() : mixed
- Generates a selection list from files found on disk
- generateAttributesFromArray() : string
- Helper to generate attributename="attributevalue" for HTML elements based on an array consisting of key => value pairs
- getLinkHTML() : mixed
- printLinkHTML() : mixed
- General link printing function
- shuffle_assoc() : bool
- shuffles an array maintaining the keys
- sortByKey() : mixed
- sorts the found albums (images) by the required key(s)
- sortMultiArray() : array<string|int, mixed>
- multidimensional array column sort
- sortArray() : bool
- General one dimensional array sorting function. Key/value associations are preserved.
- getNotViewableAlbums() : array<string|int, mixed>
- Returns a list of album IDs that the current viewer is not allowed to see
- getNotViewableImages() : array<string|int, mixed>
- Returns a list of image IDs that the current viewer is not allowed to see
- isValidURL() : bool
- Checks to see if a URL is valid
- safe_fnmatch() : bool
- pattern match function Works with characters with diacritical marks where the PHP one does not.
- isValidEmail() : bool
- Returns true if the mail address passed is valid.
- zp_image_types() : string
- returns a list of comment record 'types' for "images"
- dircopy() : the
- Copies a directory recursively
- byteConvert() : string
- Returns a byte size from a size value (eg: 100M).
- dateTimeConvert() : mixed
- Converts a datetime to connoical form
- removeDateTimeZone() : string
- Removes the time zone info from date formats like "2009-05-14T13:30:29+10:00" as stored for e.g. image meta data
- get_context() : mixed
- set_context() : mixed
- in_context() : mixed
- add_context() : mixed
- rem_context() : mixed
- save_context() : mixed
- restore_context() : mixed
- getContextObject() : bool|obj
- Returns the current item object (image, album and Zenpage page, article, category) of the current theme context or false if no context is set or matches
- zp_handle_password() : mixed
- checks password posting
- zp_handle_password_single() : bool
- Handles a passwort
- getOptionFromDB() : mixed
- Gets an option directly from the database.
- setThemeOption() : mixed
- Set options local to theme and/or album
- replaceThemeOption() : 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.
- purgeThemeOption() : mixed
- Deletes an theme option for a specific or the current theme from the database
- purgeThemeOptionTotal() : mixed
- Deletes a theme option for all themes present or not
- setThemeOptionDefault() : mixed
- Used to set default values for theme specific options
- getThemeOption() : mixed
- Returns the value of a theme option
- getUserIP() : string
- Returns the viewer's IP address Deals with transparent proxies
- getAnonymIP() : string
- Anonymizing of IP addresses
- seoFriendly() : string
- Strips out and/or replaces characters from the string that are not "soe" friendly
- seoFriendlyJS() : mixed
- emit the javascript seojs() function
- is_connected() : bool
- Returns true if there is an internet connection
- debug404() : mixed
- produce debugging information on 404 errors
- XSRFdefender() : mixed
- Checks for Cross Site Request Forgeries
- getXSRFToken() : mixed
- returns an XSRF token
- XSRFToken() : mixed
- Emits a "hidden" input for the XSRF token
- cron_starter() : mixed
- Starts a sechedule script run
- zp_loggedin() : bool
- Check if logged in (with specific rights) Returns a true value if there is a user logged on with the required rights
- read_exif_data_protected() : array<string|int, mixed>
- Provides an error protected read of image EXIF/IPTC data
- getLanguageFlag() : string
- fetches the path to the flag image
- getItemByID() : mixed
- Gets an item object by id
- reveal() : mixed
- uses down and up arrow links to show and hide sections of HTML
- applyMacros() : string
- Deals with the [macro parameters] substitutions
- getMacros() : mixed
- getNestedAlbumList() : array<string|int, mixed>
- generates a nested list of albums for the album tab sorting Returns an array of "albums" each element contains: 'name' which is the folder name 'sort_order' which is an array of the sort order set
- setexifvars() : mixed
- initializes the $_zp_exifvars array display state
- removeDir() : bool
- Recursively clears and removes a folder
- tagURLs() : mixed
- inserts location independent WEB path tags in place of site path tags
- unTagURLs() : string
- reverses tagURLs()
- updateImageProcessorLink() : string
- Searches out i.php image links and replaces them with cache links if image is cached
- pluginDebug() : mixed
- removeTrailingSlash() : string
- Removes a trailing slash from a string if one exists, otherwise just returns the string Used primarily within date and tag searches and news date archive results
- getDataUsageNotice() : array<string|int, mixed>
- Returns an array the data privacy policy page and the data usage confirmation text as defined on Options > Security array( 'notice' => '<The defined text>', 'url' => '<url to the define page either custom page url or Zenpage page>', 'linktext' => '<The defined text>' )
- printDataUsageNotice() : mixed
- Prints the data privacy policy page and the data usage confirmation text as defined on Options > Security If there is no page defined it only prints the default text.
- getCookieInfoData() : array<string|int, mixed>
- Returns an array with predefined info about general cookies set by the system and/or plugins
- getCookieInfoHTML() : string
- Returns a definition list with predefined info about general cookies set by the system and/or plugins as a string
- printCookieInfo() : mixed
- Prints a definition list with predefined info about general cookies set by the system and/or plugins
- getCookieInfoMacro() : array<string|int, mixed>
- Registers the content macro(s)
- getImageMetadataValue() : mixed
- Gets a formatted metadata field value for display
- printImageMetadataValue() : mixed
- Prints a formatted metadata field value
- rc4() : mixed
- encryption support functions
- bindtextdomain() : mixed
- Dummy routines so zenphoto will run on servers that do not have PHP getttext support.
- bind_textdomain_codeset() : mixed
- textdomain() : mixed
- gettext() : mixed
- ngettext() : mixed
- dgettext() : mixed
- dngettext() : mixed
- kses() : type
- This function makes sure that only the allowed HTML element names, attribute names and attribute values plus only sane HTML entities will occur in $string. You have to remove any slashes from PHP's magic quotes before you call this function.
- kses_hook() : mixed
- You add any kses hooks here.
- kses_version() : mixed
- This function returns kses' version number.
- kses_split() : mixed
- This function searches for HTML tags, no matter how malformed. It also matches stray ">" characters.
- kses_split2() : string
- This function does a lot of work. It rejects some very malformed things like <:::>. It returns an empty string, if the element isn't allowed (look ma, no strip_tags()!). Otherwise it splits the tag into an element and an attribute list.
- kses_attr() : type
- This function removes all attributes, if none are allowed for this element.
- kses_hair() : type
- This function does a lot of work. It parses an attribute list into an array with attribute data, and tries to do the right thing even if it gets weird input. It will add quotes around attribute values that don't have any quotes or apostrophes around them, to make it easier to produce HTML code that will conform to W3C's HTML specification. It will also remove bad URL protocols from attribute values.
- kses_check_attr_val() : bool
- This function performs different checks for attribute values. The currently implemented checks are "maxlen", "minlen", "maxval", "minval" and "valueless" with even more checks to come soon.
- kses_bad_protocol() : type
- This function removes all non-allowed protocols from the beginning of $string. It ignores whitespace and the case of the letters, and it does understand HTML entities. It does its work in a while loop, so it won't be fooled by a string like "javascript:javascript:alert(57)".
- kses_no_null() : type
- This function removes any NULL characters in $string.
- kses_stripslashes() : type
- This function changes the character sequence \" to just " It leaves all other slashes alone. It's really weird, but the quoting from preg_replace(//e) seems to require this.
- kses_array_lc() : mixed
- This function goes through an array, and changes the keys to all lower case.
- kses_js_entities() : type
- This function removes the HTML JavaScript entities found in early versions of Netscape 4.
- kses_html_error() : type
- This function deals with parsing errors in kses_hair(). The general plan is to remove everything to and including some whitespace, but it deals with quotes and apostrophes as well.
- kses_bad_protocol_once() : type
- This function searches for URL protocols at the beginning of $string, while handling whitespace and HTML entities.
- kses_bad_protocol_once2() : string
- This function processes URL protocols, checks to see if they're in the white- list or not, and returns different data depending on the answer.
- kses_normalize_entities() : type
- This function normalizes HTML entities. It will convert "AT&T" to the correct "AT&T", ":" to ":", "&#XYZZY;" to "&#XYZZY;" and so on.
- kses_normalize_entities2() : type
- This function helps kses_normalize_entities() to only accept 16 bit values and nothing more for &#number; entities.
- kses_decode_entities() : type
- This function decodes numeric HTML entities (A and A). It doesn't do anything with other entities like ä, but we don't need them in the URL protocol whitelisting system anyway.
- mb_strtolower() : mixed
- mb_strtoupper() : mixed
- mb_strlen() : mixed
- mb_substr() : mixed
- mb_strrpos() : mixed
- mb_strpos() : mixed
- mb_substr_count() : mixed
- processCommentBlock() : mixed
- getOption() : mixed
- setOption() : mixed
- setOptionDefault() : mixed
- debugLog() : mixed
- getRequestURI() : mixed
- getVersion() : mixed
- Returns the zenphoto version string
- printVersion() : mixed
- Prints the zenphoto version string
- printZenJavascripts() : mixed
- Print any Javascript required by zenphoto.
- adminToolbox() : mixed
- Prints the clickable drop down toolbox on any theme page with generic admin helpers
- getGalleryTitle() : string
- Returns the raw title of the gallery.
- getBareGalleryTitle() : string
- Returns a text-only title of the gallery.
- printGalleryTitle() : mixed
- Prints the title of the gallery.
- printBareGalleryTitle() : mixed
- getHeadTitle() : mixed
- Function to create the page title to be used within the html <head> <title></title> element.
- printHeadTitle() : mixed
- Function to print the html <title>title</title> within the <head> of a html page based on the current theme page Usefull if you use one header.php for the header of all theme pages instead of individual ones on the theme pages It prints the title and site name including the <title> tag in reversed breadcrumb order: <title><title of current page> | <parent item if present> | <gallery title></title> It supports standard gallery pages as well a custom and Zenpage news articles, categories and pages.
- getGalleryDesc() : string
- Returns the raw description of the gallery.
- getBareGalleryDesc() : string
- Returns a text-only description of the gallery.
- printGalleryDesc() : mixed
- Prints the description of the gallery.
- printBareGalleryDesc() : mixed
- getParentSiteTitle() : string
- Returns the name of the parent website as set by the "Website Title" option on the gallery options tab. Use this if Zenphoto is only a part of your website.
- getParentSiteURL() : string
- Returns the URL of the main website as set by the "Website URL" option on the gallery options tab. Use this if Zenphoto is only a part of your website.
- getMainSiteName() : string
- getMainSiteURL() : string
- getGalleryIndexURL() : string
- Returns the URL of the main gallery index page. If a custom index page is set this returns that page.
- getStandardGalleryIndexURL() : string
- Returns the url to the standard gallery index.php page
- getCustomGalleryIndexURL() : string
- Gets the custom gallery index url if one is set, otherwise false
- getCustomGalleryIndexPage() : string
- Returns the name to the individual custom gallery index page name if set, otherwise returns generic custom gallery page "gallery.php" that is widely supported by themes If you need to check if there is an indovidual custom_index_page set use `getOption('custom_index_page')` or `getCustomGalleryIndexURL()`
- printGalleryIndexURL() : mixed
- If a custom gallery index page is set this first prints a link to the actual site index (home page = index.php) followed by the gallery index page link. Otherwise just the gallery index link
- getSiteHomeURL() : string
- Returns the home page link (WEBPATH) to the Zenphoto theme index.php page Use in breadcrumbs if the theme uses a custom gallery index page so the gallery is not the site's home page
- printSiteHomeURL() : mixed
- Prints the home page link (WEBPATH with trailing slash) to a Zenphoto theme index.php page Use in breadcrumbs if the theme uses a custom gallery index page so the gallery is not the site's home page
- printPrivacyPageLink() : mixed
- If the privacy page url option is set this prints a link to it
- getNumAlbums() : int
- Returns the number of albums.
- getCurrentTheme() : string
- Returns the name of the currently active theme
- next_album() : bool
- WHILE next_album(): context switches to Album.
- getCurrentPage() : int
- Returns the number of the current page without printing it.
- getAllAccessibleAlbums() : mixed
- Gets an array of the album ids of all accessible albums (publich or user dependend)
- getTotalPages() : int
- Returns the number of pages for the current object
- getPageNumURL() : int
- Returns the URL of the page number passed as a parameter
- hasNextPage() : bool
- Returns true if there is a next page
- getNextPageURL() : string
- Returns the URL of the next page. Use within If or while loops for pagination.
- printNextPageURL() : mixed
- Prints the URL of the next page.
- hasPrevPage() : bool
- Returns TRUE if there is a previous page. Use within If or while loops for pagination.
- getPrevPageURL() : string
- Returns the URL of the previous page.
- printPrevPageURL() : mixed
- Returns the URL of the previous page.
- printPageNav() : mixed
- Prints a page navigation including previous and next page links
- printPageList() : mixed
- Prints a list of all pages.
- getPageNavList() : mixed
- returns a page nav list.
- printPageListWithNav() : mixed
- Prints a full page navigation including previous and next page links with a list of all pages in between.
- makeAlbumCurrent() : mixed
- Sets the album passed as the current album
- getAlbumTitle() : string
- Returns the raw title of the current album.
- getBareAlbumTitle() : string
- Returns a text-only title of the current album.
- getAnnotatedAlbumTitle() : string
- Returns an album title taged with of Not visible or password protected status
- printAnnotatedAlbumTitle() : mixed
- printAlbumTitle() : mixed
- Prints an encapsulated title of the current album.
- printBareAlbumTitle() : mixed
- albumNumber() : int
- Gets the 'n' for n of m albums
- getParentAlbums() : array<string|int, mixed>
- Returns an array of the names of the parents of the current album.
- getAlbumBreadcrumb() : array<string|int, mixed>
- returns the breadcrumb item for the current images's album
- printAlbumBreadcrumb() : mixed
- prints the breadcrumb item for the current images's album
- printSearchBreadcrumb() : mixed
- Prints the "breadcrumb" for a search page if the search was for a data range, the breadcrumb is "Archive" otherwise it is "Search"
- getParentBreadcrumb() : array<string|int, mixed>
- returns the breadcrumb navigation for album, gallery and image view.
- printParentBreadcrumb() : mixed
- Prints the breadcrumb navigation for album, gallery and image view.
- printHomeLink() : mixed
- Prints a link to the 'main website', not the Zenphoto site home page! Only prints the link if the url is not empty and does not point back the gallery page
- getAlbumDate() : string
- Returns the formatted date field of the album
- printAlbumDate() : mixed
- Prints the date of the current album
- getAlbumLocation() : string
- Returns the Location of the album.
- printAlbumLocation() : mixed
- Prints the location of the album
- getAlbumDesc() : string
- Returns the raw description of the current album.
- getBareAlbumDesc() : string
- Returns a text-only description of the current album.
- printAlbumDesc() : mixed
- Prints description of the current album
- printBareAlbumDesc() : mixed
- getAlbumCustomData() : string
- Returns the custom_data field of the current album
- printAlbumCustomData() : mixed
- Prints the custom_data field of the current album.
- getAlbumData() : string
- A composit for getting album data
- printAlbumData() : mixed
- Prints arbitrary data from the album object
- getAlbumPage() : int
- Returns the album page number of the current image
- getAlbumURL() : string
- Returns the album link url of the current album.
- printAlbumURL() : mixed
- Prints the album link url of the current album.
- getAlbumThumb() : string
- Returns the name of the defined album thumbnail image.
- getPasswordProtectImage() : string
- Returns an <img> element of the password protect thumb substitute
- getPasswordProtectedImage() : string
- Gets the URL to the password protected images
- printPasswordProtectedImage() : mixed
- Prints an image element with the password protected image.
- printAlbumThumbImage() : mixed
- Prints the album thumbnail image.
- getCustomAlbumThumb() : string
- Returns a link to a custom sized thumbnail of the current album
- printCustomAlbumThumbImage() : string
- Prints a link to a custom sized thumbnail of the current album
- getMaxSpaceContainer() : mixed
- Called by ***MaxSpace functions to compute the parameters to be passed to xxCustomyyy functions.
- getCustomAlbumThumbMaxSpace() : string
- Returns a link to a un-cropped custom sized version of the current album thumb within the given height and width dimensions.
- printCustomAlbumThumbMaxSpace() : mixed
- Prints a un-cropped custom sized album thumb within the given height and width dimensions.
- getNextAlbum() : object
- Returns the next album
- getNextAlbumURL() : string
- Get the URL of the next album in the gallery.
- getPrevAlbum() : object
- Returns the previous album
- getPrevAlbumURL() : string
- Get the URL of the previous album in the gallery.
- isImagePage() : bool
- Returns true if this page has image thumbs on it
- isAlbumPage() : bool
- Returns true if this page has album thumbs on it
- getNumImages() : int
- Returns the number of images in the album.
- getFirstPageImages() : type
- next_image() : bool
- Returns the next image on a page.
- makeImageCurrent() : mixed
- Sets the image passed as the current image
- getImageTitle() : string
- Returns the raw title of the current image.
- getBareImageTitle() : string
- Returns a text-only title of the current image.
- getAnnotatedImageTitle() : string
- Returns the image title taged with not visible annotation.
- printAnnotatedImageTitle() : mixed
- printImageTitle() : mixed
- Prints title of the current image
- printBareImageTitle() : mixed
- imageNumber() : int
- Returns the 'n' of n of m images
- getImageDate() : string
- Returns the image date of the current image in yyyy-mm-dd hh:mm:ss format.
- printImageDate() : mixed
- Prints the date of the current album
- getImageLocation() : string
- Returns the Location field of the current image
- getImageCity() : string
- Returns the City field of the current image
- getImageState() : string
- Returns the State field of the current image
- getImageCountry() : string
- Returns the Country field of the current image
- getImageDesc() : string
- Returns the raw description of the current image.
- getBareImageDesc() : string
- Returns a text-only description of the current image.
- printImageDesc() : mixed
- Prints the description of the current image.
- printBareImageDesc() : mixed
- getImageData() : string
- A composit for getting image data
- getImageCustomData() : string
- Returns the custom_data field of the current image
- printImageCustomData() : string
- Prints the custom_data field of the current image.
- printImageData() : mixed
- Prints arbitrary data from the image object
- getFullImageFilesize() : int
- Returns the file size of the full original image
- hasNextImage() : bool
- True if there is a next image
- hasPrevImage() : bool
- True if there is a previous image
- getNextImageURL() : string
- Returns the url of the next image.
- getPrevImageURL() : string
- Returns the url of the previous image.
- getPrevImageThumb() : string
- Returns the thumbnail of the previous image.
- getNextImageThumb() : string
- Returns the thumbnail of the next image.
- getImageURL() : string
- Returns the url of the current image.
- printImageURL() : mixed
- Prints the link to the current image.
- getImageMetaData() : array<string|int, mixed>
- Returns the Metadata infromation from the current image
- printImageMetadata() : mixed
- Prints the Metadata data of the current image
- getSizeCustomImage() : array<string|int, mixed>
- Returns an array with the height & width
- getSizeDefaultImage() : array<string|int, mixed>
- Returns an array [width, height] of the default-sized image.
- getSizeFullImage() : array<string|int, mixed>
- Returns an array [width, height] of the original image.
- getDefaultWidth() : int
- The width of the default-sized image (in printDefaultSizedImage)
- getDefaultHeight() : int
- Returns the height of the default-sized image (in printDefaultSizedImage)
- getFullWidth() : int
- Returns the width of the original image
- getFullHeight() : int
- Returns the height of the original image
- isLandscape() : bool
- Returns true if the image is landscape-oriented (width is greater than height) or - kept here for backwards compatibility - square (equal widht and height)
- getDefaultSizedImage() : string
- Returns the url to the default sized image.
- printDefaultSizedImage() : mixed
- Show video player with video loaded or display the image.
- getImageThumb() : string
- Returns the url to the thumbnail of the current image.
- printImageThumb() : mixed
- getSizeDefaultThumb() : aray
- Gets the width and height of a default thumb for the <img> tag height/width
- getFullImageURL() : string
- Returns the url to original image.
- getUnprotectedImageURL() : string
- Returns the "raw" url to the image in the albums folder
- getProtectedImageURL() : string
- Returns an url to the password protected/watermarked current image
- getSizedImageURL() : mixed
- Returns a link to the current image custom sized to $size
- getCustomImageURL() : string
- Returns the url to the image with the dimensions you define with this function.
- printCustomSizedImage() : mixed
- Print normal video or custom sized images.
- getCustomSizedImageMaxSpace() : string
- Returns a link to a un-cropped custom sized version of the current image within the given height and width dimensions.
- getCustomSizedImageThumbMaxSpace() : string
- Returns a link to a un-cropped custom sized version of the current image within the given height and width dimensions.
- printCustomSizedImageThumbMaxSpace() : mixed
- Creates image thumbnails which will fit un-cropped within the width & height parameters given
- printCustomSizedImageMaxSpace() : mixed
- Print normal video or un-cropped within the given height and width dimensions. Use for sized images or thumbnails in an album.
- printSizedImageURL() : mixed
- Prints link to an image of specific size
- getTags() : string
- Returns a list of tags for context of the page called where called
- printTags() : mixed
- Prints a list of tags, editable by admin
- printAllTagsAs() : mixed
- Either prints all of the galleries tgs as a UL list or a cloud
- getAllDates() : array<string|int, mixed>
- Retrieves a list of all unique years & months from the images in the gallery
- printAllDates() : mixed
- Prints a compendum of dates and links to a search page that will show results of the date
- getCustomPageURL() : string
- Produces the url to a custom page (e.g. one that is not album.php, image.php, or index.php)
- printCustomPageURL() : mixed
- Prints the url to a custom page (e.g. one that is not album.php, image.php, or index.php)
- isArchive() : bool
- tests if a search page is an "archive" page
- getSearchURL() : string
- Returns a search URL
- printSearchForm() : mixed
- Prints the search form
- getSearchWords() : string
- Returns the a sanitized version of the search string
- getSearchDate() : string
- Returns the date of the search
- checkForGuest() : string
- returns the auth type of a guest login
- checkAccess() : bool
- Checks to see if a password is needed
- getPageRedirect() : string
- Returns a redirection link for the password form
- printPasswordForm() : mixed
- Prints the album password form
- printZenphotoLink() : mixed
- prints the zenphoto logo and link
- exposeZenPhotoInformations() : mixed
- Expose some informations in a HTML comment
- getCodeblock() : string
- Gets the content of a codeblock for an image, album or Zenpage newsarticle or page.
- printCodeblock() : string
- Prints the content of a codeblock for an image, album or Zenpage newsarticle or page.
- checkPageValidity() : bool
- Checks for URL page out-of-bounds for "standard" themes Note: This function assumes that an "index" page will display albums and the pagination be determined by them. Any other "index" page strategy needs to be handled by the theme itself.
- print404status() : mixed
- getOwnerAuthor() : bool
- Gets current item's owner (gallery images and albums) or author (Zenpage articles and pages)
- printOwnerAuthor() : mixed
- Prints current item's owner (gallery images and albums) or author (Zenpage articles and pages)
- getOwnerAuthorURL() : type
- Returns the search url for items the current item's owner (gallery) or author (Zenpage) is assigned to
- printOwnerAuthorURL() : mixed
- Prints the link to the search engine for results of all items the current item's owner (gallery) or author (Zenpage) is assigned to
- getUserURL() : string|null
- Returns a an url for the search engine for results of all items the user with $username is assigned to either as owner (gallery) or author (Zenpage) Note there is no check if the user name is actually a vaild user account name, owner or author! Use the *OwerAuthor() function for that instead
- printUserURL() : mixed
- Prints the link to the search engine for results of all items $username is assigned to either as owner (gallery) or author (Zenpage) Note there is no check if the user name is actually a vaild user account name, owner or author! Use the *OwerAuthor() function for that instead
- printCopyrightNotice() : mixed
- Display the site or image copyright notice if defined and display is enabled
- printGalleryCopyrightNotice() : mixed
- Display the site copyright notice if defined and display is enabled
- printImageCopyrightNotice() : mixed
- Display the image copyright notice if defined and display iss enabled
- getCurrentPageAppendix() : string
- Gets the current page number if it is larger than 1 for use on paginated pages for SEO reason to avoid duplicate titles
- printCurrentPageAppendix() : mixed
- Prints the current page number if it is larger than 1 for use on paginated pages for SEO reason to avoid duplicate titles
- gallerystats_filesize_r() : mixed
- printBarGraph() : mixed
- Prints a table with a bar graph of the values.
- printThumbNav() : mixed
- Prints the jQuery bxslider HTML setup to be replaced by JS
- checkForUpdate() : string
- Searches the zenphoto.org home page for the current zenphoto download locates the version number of the download and compares it to the version we are running.
- admin_showupdate() : mixed
- Displays the "new version available" message on admin pages
- get_AnyFile_suffixes() : mixed
- comment_form_PaginationJS() : mixed
- comment_form_visualEditor() : mixed
- comment_form_print10Most() : mixed
- Admin overview summary
- getCommentAddress() : array<string|int, mixed>
- Processes the post of an address
- getCommentErrors() : string
- Returns an error message if a comment posting was not accepted
- printCommentErrors() : mixed
- Tool to output an error message if a comment posting was not accepted
- comment_form_addComment() : object
- Generic comment adding routine. Called by album objects or image objects to add comments.
- commentFormUseCaptcha() : bool
- Use see if a captcha should be displayed
- comment_form_postcomment() : mixed
- checks if comments are allowed and then processes them if so
- comment_form_handle_comment() : null|bool
- Handles the POSTing of a comment
- getCommentAuthorName() : string
- Returns the comment author's name
- getCommentAuthorEmail() : string
- Returns the comment author's email
- getCommentAuthorSite() : string
- Returns the comment author's website
- getCommentAuthorLink() : mixed
- Prints a link to the author
- printCommentAuthorLink() : mixed
- Prints a link to the author
- getCommentDateTime() : string
- Returns a formatted date and time for the comment.
- getCommentBody() : string
- Returns the body of the current comment
- printEditCommentLink() : mixed
- Creates a link to the admin comment edit page for the current comment
- getLatestComments() : mixed
- Gets latest comments for images, albums, news and pages
- printLatestComments() : mixed
- Prints latest comments for images, albums, news and pages
- getCommentCount() : int
- Retuns the count of comments on the current image
- next_comment() : bool
- Iterate through comments; use the ZP_COMMENT context.
- getCommentStored() : array<string|int, mixed>
- Returns the data from the last comment posted
- commentReply() : string
- Takes a comment and makes the body of an email.
- commentsAllowed() : bool
- Returns true if all the right conditions are set to allow comments for the $type
- getComments() : array<string|int, mixed>
- Gets an array of comments for the current admin
- fetchComments() : array<string|int, mixed>
- Gets an array of comments for the current admin
- isCommentFormRequiredField() : bool
- Checks if a field is required
- getCommentFormRequiredFieldMark() : string
- Gets the star to mark required field names
- getCommentFormRequiredFieldAttr() : string
- Returns the required attribute if the field is required
- isCommentFormReadonlyField() : mixed
- Checks if the field should be set to readonly
- getCommentFormReadonlyFieldAttr() : string
- Gets the readonly attribute for disabled fields
- printCommentFormFieldAttributes() : mixed
- Prints the combined required and readonly attributes as needed
- getCommentformFormAutocompleteAttr() : string
- Returns the autocomplete attribute for the form depending if autocomplete is enabled
- getCommentformAutocompleteAttr() : string
- Gets the autocomplete attribute with the value passed if autocomplete is enabled Note that the value is not validated. See See e.g. https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete for valid values and tokens
- printCommentformAutocompleteAttr() : mixed
- Prints the autocomplete attribute with the value passed if autocomplete is enabled Note that the value is not validated. See See e.g. https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete for valid values and tokens
- getQuizFieldQuestion() : string|bool
- Gets the the question to a quiz field if the field is enabled and setup correctly
- printCommentForm() : mixed
- Prints a form for posting comments
- getField() : string
- Retrieves the post field if it exists
- printContactForm() : mixed
- Prints the mail contact form, handles checks and the mail sending. It uses Zenphoto's check for valid e-mail address and website URL and also supports CAPTCHA.
- showOrNotShowField() : bool
- Helper function that checks if a field should be shown ("required" or "show") or omitted ("ommitt").
- checkRequiredField() : string
- Helper function that checks if the field is a required one. If it returns '*" to be appended to the field name as an indicator.
- printContactFormMacro() : type
- Buffers the contact form print out so it can be passed to its content macro
- getContactFormMacros() : array<string|int, mixed>
- Registers the content macro(s)
- defaultCodeblocks_codebox() : mixed
- 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
- printBarGraph() : mixed
- Prints a table with a bar graph of the values.
- printdownloadList() : mixed
- Prints the actual download list included all subfolders and files
- getdownloadList() : array<string|int, mixed>
- Gets the actual download list included all subfolders and files
- getDownloadURL() : mixed
- Gets the download url for a file
- printDownloadURL() : mixed
- Prints a download link for a file, depending on the plugin options including the downloadcount and filesize
- printFullImageDownloadURL() : mixed
- Prints the dwnload url link for a full image
- printDownloadAlbumZipURL() : mixed
- Prints a download link for an album zip of the current album (therefore to be used only on album.php/image.php).
- printLanguageSelector() : mixed
- prints a form for selecting a locale The POST handling is by getUserLocale() called in functions.php
- elFinderAutoloader() : mixed
- access() : bool|null
- Simple function to demonstrate how to control file access using "accessControl" callback.
- accessImage() : mixed
- accessAlbums() : mixed
- imagecreatefrombmp() : mixed
- elFinder_admin_tabs() : mixed
- elFinder_tinymce() : mixed
- printAddToFavorites() : mixed
- getFavoritesURL() : mixed
- printFavoritesURL() : mixed
- Prints links to the favorites "albums"
- getFeaturedImage() : mixed
- Returns the image object if an featured image is assigned, otherwise false
- getSizedFeaturedImage() : string
- Gets a custom sized version of this image based on the parameters. Multimedia items don't use these.
- printSizedFeaturedImage() : string
- Print a custom sized version of this image based on the parameters. Multimedia items don't use these.
- getFeaturedImageThumb() : string
- Gets the default thumb size of a featured image
- printFeaturedImageThumb() : mixed
- Prints the default thumb size of a featured image
- log_message() : mixed
- get_instance() : mixed
- omsAdditions() : mixed
- getGeoCoord() : mixed
- $returns coordinate informations for an image
- addGeoCoord() : mixed
- Add a point to a map object
- getImageGeodata() : mixed
- Gathers the data for an image
- getAlbumGeodata() : mixed
- Gathers the map data for an album
- printGoogleMap() : mixed
- Output the google map
- getHitcounter() : string
- returns the hitcounter for the current page or for the object passed
- getTotalHitcounter() : int
- Gets the total hitcounter sum of one or several items
- getAlbumStatistic() : array<string|int, mixed>
- Returns a array of album objects of album statistic accordingly to $option
- printAlbumStatistic() : mixed
- Prints album statistic according to $option as an unordered HTML list A css id is attached by default named '$option_album'
- printAlbumStatisticItem() : mixed
- A helper function that only prints a item of the loop within printAlbumStatistic() Not for standalone use.
- getImageStatistic() : array<string|int, mixed>
- Returns a array of image objects of image statistic according to $option
- printImageStatistic() : string
- Prints image statistic according to $option as an unordered HTML list A css id is attached by default named accordingly'$option'
- checkIfNew() : bool
- A little helper function that checks if an image or album is to be considered 'new' within the time range set in relation to getImageDate()/getAlbumDate() Returns true or false.
- getNumAllSubalbums() : bool
- Gets the number of all subalbums of all subalbum levels of either the current album or $albumobj
- getPictureOfTheDay() : object|nill
- Returns an randomly selected image objecet from the gallery per day.
- getjPlayerSkins() : mixed
- Gets the skin names and css files
- getjPlayerSkinCSS() : mixed
- Gets the css files for a skin. Helper function for getjPlayerSkins().
- printjPlayerPlaylist() : mixed
- jplayer class theme function wrapper for user convenience
- macro_admin_tabs() : mixed
- macroList_show() : mixed
- markRelease_button() : mixed
- updateItemsSortorder() : mixed
- Updates the sortorder of the pages list in the database
- printItemsListTable() : mixed
- Prints the table part of a single page item for the sortable pages list
- printItemsList() : bool
- Prints the sortable pages list returns true if nesting levels exceede the database container
- printItemEditLink() : mixed
- Prints the link to the edit page of a menu item. For gallery and Zenpage items it links to their normal edit pages, for custom pages and custom links to menu specific edit page.
- printItemStatusDropdown() : mixed
- Prints the item status selector to choose if all items or only hidden or visible should be listed
- getMenuSetSelector() : mixed
- returns the menu set selector
- publishItem() : mixed
- Sets a menu item to published/visible
- addSubalbumMenus() : mixed
- adds (sub)albums to menu base with their gallery sorting order intact
- addalbumsToDatabase() : int
- Adds albums to the menu set. Returns the next sort order base
- addPagesToDatabase() : int
- Adds Zenpage pages to the menu set
- addCategoriesToDatabase() : mixed
- Adds Zenpage news categories to the menu set
- addItem() : array<string|int, mixed>
- Adds an menu item set via POST
- updateMenuItem() : mixed
- Updates a menu item (custom link, custom page only) set via POST
- deleteItem() : mixed
- Deletes a menu item set via GET
- printAlbumsSelector() : string
- Prints all albums of the Zenphoto gallery as a partial drop down menu (<option></option> parts).
- printZenpagePagesSelector() : string
- Prints all available pages in Zenpage
- printZenpageNewsCategorySelector() : string
- Prints all available articles or categories in Zenpage
- printCustomPageSelector() : string
- Prints the selector for custom pages
- unpublishedZenphotoItemCheck() : string
- checks if a album or image is un-published and returns a '*'
- processMenuBulkActions() : mixed
- Processes the check box bulk actions
- menu_admin_toolbox_global() : mixed
- Add menu to the admin toolbox
- menu_tabs() : unknown
- Adds menu manager to admin tabs
- getMenuItems() : array<string|int, mixed>
- Gets the menu items
- getItem() : array<string|int, mixed>
- Gets a menu item by its id
- checkChosenMenuset() : string
- Checks which menu set is chosen via $_GET. If none is explicity chosen the "default" one (create initially) is used.
- checkChosenItemStatus() : string
- Checks if the menu item is set visible or not
- getItemTitleAndURL() : array<string|int, mixed>
- Gets the title, url and name of a menu item
- getMenuVisibility() : string
- Gets the menu visibility
- inventMenuItem() : int|array<string|int, mixed>|string
- "invents" a menu item for the current page (for when one does not exist) Adds the item to the current menuset and modifies its "parent" as needed
- getCurrentMenuItem() : int|array<string|int, mixed>|string
- Returns the data of the current menu item
- getMenumanagerPredicessor() : string
- Returns the link to the predicessor of the current menu item
- printMenumanagerPrevLink() : mixed
- Prints the previous link of the current menu item
- getMenumanagerSuccessor() : string
- Returns the successor link of the current menu item
- printMenumanagerNextLink() : mixed
- Gets the link to the next menu item
- printMenuemanagerPageListWithNav() : mixed
- Prints a list of all pages.
- printMenuemanagerPageList() : mixed
- Prints a full page navigation including previous and next page links with a list of all pages in between.
- getParentMenuItems() : array<string|int, mixed>|false
- Gets the parent menu items of the current menu item. Returns the array of the items or false.
- printMenumanagerBreadcrumb() : mixed
- Prints the breadcrumbs of the current page
- getMenuFromLink() : array<string|int, mixed>
- Returns the menu item corresponding to $link
- submenuOf() : bool
- Returns true if the current menu item is a sub item of $link
- createMenuIfNotExists() : mixed
- Creates a menu set from the items passed. But only if the menu set does not already exist
- getMenuItemChilds() : array<string|int, mixed>|false
- Gets the direct child menu items of the current menu item. Returns the array of the items or false.
- isCurrentitemParent() : bool
- Checks if the item $item is a parent item of the current item
- isPublicMenuItem() : bool
- Checks if the actual object the menu item represents is actually public
- printCustomMenu() : string
- Prints a context sensitive menu of all pages as a unordered html list
- getSelectedLayout() : string|false
- Gets the selected layout page for this item. Returns false if nothing is selected.
- checkParentLayouts() : array<string|int, mixed>|false
- Checks if there is a layout inherited from a parent items (album, page or category) and returns it. Returns false otherwise.
- checkLayoutUseForImages() : array<string|int, mixed>|false
- Gets the selected layout page for images if the album option to use the equivalent of their album layout is seleted.
- layoutSelector() : string
- returns the layout selector for an object.
- layoutSelector_album() : string
- returns the layout selectors for an album.
- getLayoutSelector() : string
- Worker function for creating layout selectors. Returns the HTML
- getLayout() : string
- Gets the select layout page and returns it to the load_theme_script filter
- saveLayoutSelection() : string
- Saves the layout page assignment via filter on the backend
- saveZenphotoLayoutSelection() : string
- Saves the layout page assignment via filter on the backend for images and albums
- deleteLayoutSelection() : bool
- processes object removals if they have been assigned layouts
- copyLayoutSelection() : mixed
- Copies the layout selection
- printOpenStreetMap() : mixed
- Template function wrapper for the openStreetMap class to show a map with geodata markers for the current image or collected the images of an album.
- printPagedThumbsNav() : mixed
- Prints a paged thumbnail navigation to be used on a theme's image.php, independent of the album.php's thumbs loop
- zenphoto_PHPMailer() : mixed
- printAlbumMenu() : mixed
- Prints a list of all albums context sensitive.
- printAlbumMenuList() : html
- Prints a nested html list of all albums context sensitive.
- printAlbumMenuListAlbum() : mixed
- Handles an album for printAlbumMenuList
- printAlbumMenuJump() : mixed
- Prints a dropdown menu of all albums(not context sensitive) Is used by the wrapper function printAlbumMenu() if the options "jump" is choosen. For standalone use, too.
- checkSelectedAlbum() : string
- A printAlbumMenu() helper function for the jump menu mode of printAlbumMenu() that only checks which the current album so that the entry in the in the dropdown jump menu can be selected Not for standalone use.
- unpublishSubalbums() : mixed
- printRating() : mixed
- Prints the rating star form and the current rating Insert this function call in the page script where you want the star ratings to appear.
- getRating() : float
- Returns the current rating of an object
- printRegistrationForm() : mixed
- Parses the verification and registration if they have occurred places the user registration form
- printRegisterURL() : mixed
- prints the link to the register user page
- getRelatedItems() : mixed
- createRelatedItemsResultArray() : mixed
- Helper function for getRelatedItems() only.
- printRelatedItems() : mixed
- Prints the x related articles based on a tag search
- rulesList() : type
- getRSSLink() : mixed
- Prints a RSS link for if (class_exists('RSS')) printRSSLink() and if (class_exists('RSS')) printRSSHeaderLink()
- printRSSLink() : mixed
- Prints an RSS link
- printRSSHeaderLink() : mixed
- Prints the RSS link for use in the HTML HEAD
- executeRSS() : mixed
- seo_cleanup_button() : mixed
- getE() : mixed
- cleanAlbum() : mixed
- checkFolder() : mixed
- printSlideShowLink() : mixed
- Prints a link to call the slideshow (not shown if there are no images in the album) To be used on album.php and image.php A CSS id names 'slideshowlink' is attached to the link so it can be directly styled.
- printSlideShow() : mixed
- Prints the slideshow using the {@link http://http://www.malsup.com/jquery/cycle2/ jQuery plugin Cycle2 }
- getAllTagsFromAlbum() : array<string|int, mixed>
- Prints a tag cloud list of the tags in one album and optionally its subalbums. Returns FALSE if no value.
- getAllTagsFromZenpage() : mixed
- Gets all tags used by either all Zenpage news articles or pages.
- printAllTagsFromZenpage() : mixed
- Prints a tag cloud list of the tags used by either all Zenpage news articles or pages.
- printAllTagsFromAlbum() : mixed
- Prints a tag cloud list of the tags in one album and optionally its subalbums.
- printAllTags() : mixed
- Prints a tag cloud list of the tags in one album and optionally its subalbums. Base function to printAllTagsFromAlbum().
- getAllTagsFromAlbum_multi_unique() : array<string|int, mixed>
- Removes duplicate entries in multi dimensional array.
- tagSuggestJS_admin() : mixed
- tagSuggestJS_frontend() : mixed
- tagSuggestJS() : 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
- 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
- tinymce4ConfigJS() : mixed
- getTinyMCE4ConfigFiles() : mixed
- upload_head() : mixed
- upload_extra() : mixed
- upload_form() : mixed
- httpUploadHandler() : mixed
- httpUploadHandler_admin_tabs() : mixed
- jQueryUpload_headers() : mixed
- jQueryUpload_head() : mixed
- upload_head() : mixed
- upload_extra() : mixed
- upload_form() : mixed
- jQueryUploadHandler() : mixed
- jQueryUploadHandler_admin_tabs() : mixed
- printUserLogin_out() : mixed
- Prints the logout link if the user is logged in.
- user_mailing_list_button() : mixed
- getExpiryDatePost() : string
- Retrieves posted expiry date and checks it against the current date/time Returns the posted date if it is in the future Returns NULL if the date is past
- processTags() : mixed
- processes the taglist save
- updatePage() : object
- Updates or adds a page and returns the object of that page
- deletePage() : mixed
- Deletes a page (and also if existing its subpages) from the database
- printPagesListTable() : mixed
- Prints the table part of a single page item for the sortable pages list
- updateArticle() : object
- Updates or adds a news article and returns the object of that article
- deleteArticle() : mixed
- Deletes an news article from the database
- printArticleCategories() : mixed
- Print the categories of a news article for the news articles list
- printPageArticleTags() : mixed
- Print the categories of a news article for the news articles list
- printCategorySelection() : mixed
- Prints the checkboxes to select and/or show the category of an news article on the edit or add page
- printArticleDatesDropdown() : mixed
- Prints the dropdown menu for the date archive selector for the news articles list
- getNewsAdminOption() : array<string|int, mixed>
- Compiles an option parameter list
- getNewsAdminOptionPath() : string
- Creates the admin paths for news articles if you use the dropdowns on the admin news article list together
- printUnpublishedDropdown() : mixed
- Prints the dropdown menu for the published/un-publishd selector for the news articles list
- printSortOrderDropdown() : mixed
- Prints the dropdown menu for the sortorder selector for the news articles list
- printCategoryDropdown() : mixed
- Prints the dropdown menu for the category selector for the news articles list
- printArticlesPerPageDropdown() : mixed
- Prints the dropdown menu for the articles per page selector for the news articles list
- printAuthorDropdown() : mixed
- Prints the dropdown menu all authors that currently are authors of news articles
- updateCategory() : mixed
- Updates or adds a category
- deleteCategory() : mixed
- Deletes a category (and also if existing its subpages) from the database
- printCategoryListSortableTable() : string
- Prints the list entry of a single category for the sortable list
- printCategoryCheckboxListEntry() : mixed
- Prints the checkboxes to select and/or show the category of an news article on the edit or add page
- printNestedItemsList() : string
- Prints the nested list for pages and categories
- updateItemSortorder() : array<string|int, mixed>
- Updates the sortorder of the items list in the database
- checkForEmptyTitle() : string
- Checks if no title has been provide for items on new item creation
- zenpagePublish() : string
- Publishes a page or news article
- skipScheduledPublishing() : string
- Skips the scheduled future publishing by setting the date of a page or article to the current date to publish it immediately or the expiration handling by setting the expiredate to null.
- checkHitcounterDisplay() : string
- Checks if there are hitcounts and if they are displayed behind the news article, page or category title
- getNewsPagesStatistic() : mixed
- returns an array of how many pages, articles, categories and news or pages comments we got.
- printPagesStatistic() : mixed
- printNewsStatistic() : mixed
- printCategoriesStatistic() : mixed
- zenpageJSCSS() : mixed
- Prints the links to JavaScript and CSS files zenpage needs.
- printZenpageIconLegend() : mixed
- authorSelector() : mixed
- Prints a dropdown to select the author of a page or news article (Admin rights users only)
- printPublishIconLink() : mixed
- Prints the publish/un-published/scheduled publishing icon with a link for the pages and news articles list.
- checkIfChecked() : mixed
- Checks if a checkbox is selected and checks it if.
- checkIfLockedPage() : bool
- Checks if the current logged in admin user is the author that locked the page/article.
- checkIfLockedNews() : bool
- Checks if the current logged in admin user is the author that locked the article.
- is_AdminEditPage() : bool
- Checks if the current admin-edit.php page is called for news articles or for pages.
- processZenpageBulkActions() : mixed
- Processes the check box bulk actions
- zenpageBulkActionMessage() : mixed
- createTitlelink() : type
- Creates the titlelink from the title passed.
- checkTitlelinkDuplicate() : bool
- Checks if a title link of this itemtype already exists
- addDateToTitlelink() : string
- Append or prepends a date string to a titlelink as defined.
- getNewsIndexURL() : string
- Returns the full path of the news index page
- getNewsArchiveURL() : string
- Returns the full path of the news archive page
- RSS_Tags() : mixed
- RSS_Channel() : mixed
- RSS_Retrieve() : mixed
- printNews() : mixed
- zenphoto_sendmail() : type
Constants
ACK_DISPLAY_ERRORS
public
mixed
ACK_DISPLAY_ERRORS
= 2
ADMIN_IMAGES_STEP
public
mixed
ADMIN_IMAGES_STEP
= 5
ADMIN_PLUGIN
Defines the bitmask for load order priority of admin plugins
public
mixed
ADMIN_PLUGIN
= 4096
ADMIN_RIGHTS
public
mixed
ADMIN_RIGHTS
= 1
ALBUM_FOLDER_EMPTY
public
mixed
ALBUM_FOLDER_EMPTY
= \getAlbumFolder('')
ALBUM_FOLDER_SERVERPATH
public
mixed
ALBUM_FOLDER_SERVERPATH
= \getAlbumFolder(\SERVERPATH)
ALBUM_FOLDER_WEBPATH
public
mixed
ALBUM_FOLDER_WEBPATH
= \getAlbumFolder(\WEBPATH)
ALBUM_MENU_COUNT
public
mixed
ALBUM_MENU_COUNT
= \getOption('print_album_menu_count')
ALBUM_MENU_SHOWSUBS
public
mixed
ALBUM_MENU_SHOWSUBS
= \getOption('print_album_menu_showsubs')
ALBUMFOLDER
Defines the name of the albums folder
public
mixed
ALBUMFOLDER
= 'albums'
ALL_ALBUMS_RIGHTS
public
mixed
ALL_ALBUMS_RIGHTS
= \VIEW_ALL_RIGHTS
ALL_NEWS_RIGHTS
public
mixed
ALL_NEWS_RIGHTS
= \VIEW_ALL_RIGHTS
ALL_PAGES_RIGHTS
public
mixed
ALL_PAGES_RIGHTS
= \VIEW_ALL_RIGHTS
BACKUPFOLDER
Defines the name of the backup folder
public
mixed
BACKUPFOLDER
= 'backup'
BASEPATH
public
mixed
BASEPATH
= true
CACHE_HASH_LENGTH
public
mixed
CACHE_HASH_LENGTH
= \strlen(\sha1(\strval(\HASH_SEED)))
CACHEFOLDER
Defines the name of the image cache folder
public
mixed
CACHEFOLDER
= 'cache'
CASE_INSENSITIVE
Defines if the server file system is case insensitive
public
mixed
CASE_INSENSITIVE
= \file_exists(\dirname(__FILE__) . '/VERSION.PHP')
CHMOD_VALUE
public
mixed
CHMOD_VALUE
= \fileperms(\dirname(__FILE__)) & 0666
CLASS_PLUGIN
Defines the bitmask for load order priority of class plugins
public
mixed
CLASS_PLUGIN
= 8192
COMMENT_BODY_REQUIRED
public
mixed
COMMENT_BODY_REQUIRED
= 16
COMMENT_DATACONFIRMATION
public
mixed
COMMENT_DATACONFIRMATION
= 64
COMMENT_EMAIL_REQUIRED
public
mixed
COMMENT_EMAIL_REQUIRED
= 1
COMMENT_MATHQUIZ
public
mixed
COMMENT_MATHQUIZ
= 256
COMMENT_NAME_REQUIRED
public
mixed
COMMENT_NAME_REQUIRED
= 2
COMMENT_SEND_EMAIL
public
mixed
COMMENT_SEND_EMAIL
= 32
COMMENT_TEXTQUIZ
public
mixed
COMMENT_TEXTQUIZ
= 128
COMMENT_WEB_REQUIRED
public
mixed
COMMENT_WEB_REQUIRED
= 4
COMMENTS_PER_PAGE
public
mixed
COMMENTS_PER_PAGE
= \max(1, \getOption('comment_form_comments_per_page'))
COMMON_FOLDER
Defines the name of the shared "common" folder within/for core extensions
public
mixed
COMMON_FOLDER
= \PLUGIN_FOLDER . '/common'
CONFIGFILE
Defines the name of the config file
public
mixed
CONFIGFILE
= 'zenphoto.cfg.php'
COOKIE_PATH
public
mixed
COOKIE_PATH
= \WEBPATH
COOKIE_PERSISTENCE
public
mixed
COOKIE_PERSISTENCE
= $persistence
CUSTOM_OPTION_PREFIX
public
mixed
CUSTOM_OPTION_PREFIX
= '_ZP_CUSTOM_'
DATA_FOLDER
Defines the name of the zp-data folder outside the core folder
public
mixed
DATA_FOLDER
= 'zp-data'
DATA_MOD
public
mixed
DATA_MOD
= \fileperms(\SERVERPATH . '/' . \DATA_FOLDER . '/' . \CONFIGFILE) & 0777
DATABASE_DESIRED_VERSION
public
mixed
DATABASE_DESIRED_VERSION
= '5.7.0'
DATABASE_DESIRED_VERSION
public
mixed
DATABASE_DESIRED_VERSION
= '0.0.0'
DATABASE_MARIADB_DESIRED_VERSION
public
mixed
DATABASE_MARIADB_DESIRED_VERSION
= '10.1.0'
DATABASE_MARIADB_DESIRED_VERSION
public
mixed
DATABASE_MARIADB_DESIRED_VERSION
= '0.0.0'
DATABASE_MARIADB_MIN_VERSION
public
mixed
DATABASE_MARIADB_MIN_VERSION
= '5.5.0'
DATABASE_MARIADB_MIN_VERSION
public
mixed
DATABASE_MARIADB_MIN_VERSION
= '0.0.0'
DATABASE_MIN_VERSION
public
mixed
DATABASE_MIN_VERSION
= '5.5.3'
DATABASE_MIN_VERSION
public
mixed
DATABASE_MIN_VERSION
= '0.0.0'
DATABASE_PREFIX
public
mixed
DATABASE_PREFIX
= $mysql_prefix
DATABASE_SOFTWARE
public
mixed
DATABASE_SOFTWARE
= $_zp_conf_vars['db_software']
DATABASE_SOFTWARE
public
mixed
DATABASE_SOFTWARE
= 'Database setup'
DATE_FORMAT
public
mixed
DATE_FORMAT
= \trim(\strval(\getOption('date_format')))
DATETIME_DISPLAYFORMAT
public
mixed
DATETIME_DISPLAYFORMAT
= \DATETIME_FORMAT
DATETIME_FORMAT
public
mixed
DATETIME_FORMAT
= \DATE_FORMAT . ' ' . \TIME_FORMAT
DEBUG_404
set to true to log 404 error processing debug information.
public
mixed
DEBUG_404
= isset($_zp_conf_vars['debug_404']) && $_zp_conf_vars['debug_404'] || \TEST_RELEASE
DEBUG_ERROR
set to true to supplies the calling sequence with zp_error messages
public
mixed
DEBUG_ERROR
= isset($_zp_conf_vars['debug_error']) && $_zp_conf_vars['debug_error'] || \TEST_RELEASE
DEBUG_EXIF
set to true to log start/finish of exif processing. Useful to find problematic images.
public
mixed
DEBUG_EXIF
= isset($_zp_conf_vars['debug_exif']) && $_zp_conf_vars['debug_exif']
DEBUG_FILTERS
set to true to log filter application sequence.
public
mixed
DEBUG_FILTERS
= isset($_zp_conf_vars['debug_filters']) && $_zp_conf_vars['debug_filters']
DEBUG_IMAGE
set to true to log image processing debug information.
public
mixed
DEBUG_IMAGE
= isset($_zp_conf_vars['debug_image']) && $_zp_conf_vars['debug_image']
DEBUG_IMAGE_ERR
set to true to flag image processing errors.
public
mixed
DEBUG_IMAGE_ERR
= isset($_zp_conf_vars['debug_image_err']) && $_zp_conf_vars['debug_image_err'] || \TEST_RELEASE
DEBUG_LOCALE
used for examining language selection problems
public
mixed
DEBUG_LOCALE
= isset($_zp_conf_vars['debug_locale']) && $_zp_conf_vars['debug_locale']
DEBUG_LOG_SIZE
public
mixed
DEBUG_LOG_SIZE
= \getOption('debug_log_size')
DEBUG_LOGIN
set to true to log admin saves and login attempts
public
mixed
DEBUG_LOGIN
= isset($_zp_conf_vars['debug_login']) && $_zp_conf_vars['debug_login']
DEBUG_PLUGINS
set to true to log plugin load sequence.
public
mixed
DEBUG_PLUGINS
= isset($_zp_conf_vars['debug_plugins']) && $_zp_conf_vars['debug_plugins']
EDITOR_SANITIZE_LEVEL
public
mixed
EDITOR_SANITIZE_LEVEL
= 1
EDITOR_SANITIZE_LEVEL
public
mixed
EDITOR_SANITIZE_LEVEL
= 4
EDITOR_SANITIZE_LEVEL
public
mixed
EDITOR_SANITIZE_LEVEL
= 4
ELFINDER_PHP_ROOT_PATH
public
mixed
ELFINDER_PHP_ROOT_PATH
= \dirname(__FILE__)
ENT_SUBSTITUTE
public
mixed
ENT_SUBSTITUTE
= \defined('ENT_IGNORE') ? \ENT_IGNORE : 8
EXACT_TAG_MATCH
public
mixed
EXACT_TAG_MATCH
= \getOption('exact_tag_match')
EXPLAIN_SELECTS
set to true to log the "EXPLAIN" of SELECT queries in the debug log
public
mixed
EXPLAIN_SELECTS
= isset($_zp_conf_vars['explain_selects']) && $_zp_conf_vars['explain_selects']
FEATURE_PLUGIN
Defines the bitmask for load order priority of feature plugins
public
mixed
FEATURE_PLUGIN
= 2048
FILE_MOD
public
mixed
FILE_MOD
= \CHMOD_VALUE & 0666
FILESYSTEM_CHARSET
public
mixed
FILESYSTEM_CHARSET
= $data
FILESYSTEM_CHARSET
public
mixed
FILESYSTEM_CHARSET
= 'UTF-8'
FOLDER_MOD
public
mixed
FOLDER_MOD
= \CHMOD_VALUE | 0311
FULLIMAGE_WATERMARK
public
mixed
FULLIMAGE_WATERMARK
= \getOption('fullsizeimage_watermark')
FULLWEBPATH
public
mixed
FULLWEBPATH
= \SERVER_HTTP_HOST . \WEBPATH
GALLERY_SECURITY
public
mixed
GALLERY_SECURITY
= @$data['gallery_security']
GALLERY_SESSION
public
mixed
GALLERY_SESSION
= @$data['album_session']
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_INCLUDEPATH
public
mixed
GETID3_INCLUDEPATH
= \SERVERPATH . '/' . \ZENFOLDER . '/' . \PLUGIN_FOLDER . '/class-video/getid3/'
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
GOOGLE_SITEMAP
public
mixed
GOOGLE_SITEMAP
= \getOption('sitemap_google')
GRAPHICS_LIBRARY
public
mixed
GRAPHICS_LIBRARY
= $_zp_cachefile_suffix['Library']
HASH_SEED
public
mixed
HASH_SEED
= \getOption('extra_auth_hash_text')
HTACCESS_VERSION
public
mixed
HTACCESS_VERSION
= '1.4.12'
IM_SUFFIX
public
mixed
IM_SUFFIX
= \getOption('mod_rewrite_image_suffix')
IMAGE_CACHE_SUFFIX
public
mixed
IMAGE_CACHE_SUFFIX
= \getOption('image_cache_suffix')
IMAGE_SORT_DIRECTION
public
mixed
IMAGE_SORT_DIRECTION
= \getOption('image_sortdirection')
IMAGE_SORT_TYPE
public
mixed
IMAGE_SORT_TYPE
= \getOption('image_sorttype')
IMAGE_WATERMARK
public
mixed
IMAGE_WATERMARK
= \getOption('fullimage_watermark')
IMAGEMAGICK_REQUIRED_VERSION
public
mixed
IMAGEMAGICK_REQUIRED_VERSION
= '6.3.8'
IMAGICK_REQUIRED_VERSION
public
mixed
IMAGICK_REQUIRED_VERSION
= '3.0.0'
IP_TIED_COOKIES
public
mixed
IP_TIED_COOKIES
= \getOption('IP_tied_cookies')
LIST_RIGHTS
public
mixed
LIST_RIGHTS
= \NO_RIGHTS
LOCAL_CHARSET
public
mixed
LOCAL_CHARSET
= $data
LOCAL_CHARSET
public
mixed
LOCAL_CHARSET
= 'UTF-8'
LOCALE_TYPE
public
mixed
LOCALE_TYPE
= 0
LOGS_MOD
public
mixed
LOGS_MOD
= \DATA_MOD
MANAGED_OBJECT_RIGHTS_EDIT
public
mixed
MANAGED_OBJECT_RIGHTS_EDIT
= 1
MANAGED_OBJECT_RIGHTS_UPLOAD
public
mixed
MANAGED_OBJECT_RIGHTS_UPLOAD
= 2
MANAGED_OBJECT_RIGHTS_VIEW
public
mixed
MANAGED_OBJECT_RIGHTS_VIEW
= 4
MAX_SIZE
public
mixed
MAX_SIZE
= \getOption('image_max_size')
MEMBERS_ONLY_COMMENTS
public
mixed
MEMBERS_ONLY_COMMENTS
= \getOption('comment_form_members_only')
MENU_TRUNCATE_INDICATOR
public
mixed
MENU_TRUNCATE_INDICATOR
= \getOption('menu_truncate_indicator')
MENU_TRUNCATE_STRING
public
mixed
MENU_TRUNCATE_STRING
= \getOption('menu_truncate_string')
METATAG_LOCALE_TYPE
public
mixed
METATAG_LOCALE_TYPE
= 0
MOD_REWRITE
public
mixed
MOD_REWRITE
= \getOption('mod_rewrite')
MUTEX_FOLDER
Defines the mutex folder
public
mixed
MUTEX_FOLDER
= '.mutex'
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
NO_WATERMARK
public
mixed
NO_WATERMARK
= '!'
OBJECT_CACHE_DEPTH
public
mixed
OBJECT_CACHE_DEPTH
= 150
OFFSET_PATH
used in sorting the images within and album
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
This script is used to create dynamic albums from a search.
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
admin-edit.php editing of albums.
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
user_groups log--tabs
public
mixed
OFFSET_PATH
= 1
Tags
OFFSET_PATH
provides the Options tab of admin
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
provides the Plugins tab of admin
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
This template is used to reload metadata from images. Running it will process the entire gallery, supplying an album name (ex: loadAlbums.php?album=newalbum) will only process the album named.
public
mixed
OFFSET_PATH
= 2
OFFSET_PATH
provides the TAGS tab of admin
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
Theme file editor
public
mixed
OFFSET_PATH
= 1
Tags
OFFSET_PATH
provides the Themes tab of admin
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
provides the Upload tab of admin
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
provides the Options tab of admin
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
admin.php is the main script for administrative functions.
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
public
mixed
OFFSET_PATH
= 0
OFFSET_PATH
public
mixed
OFFSET_PATH
= 2
OFFSET_PATH
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
public
mixed
OFFSET_PATH
= 2
OFFSET_PATH
public
mixed
OFFSET_PATH
= 2
OFFSET_PATH
Used for changing permissions on a mass basis
public
mixed
OFFSET_PATH
= 2
OFFSET_PATH
Used for setting theme/plugin default options
public
mixed
OFFSET_PATH
= 2
OFFSET_PATH
Used for setting theme/plugin default options
public
mixed
OFFSET_PATH
= 2
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
Database quick reference
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
Detailed Gallery Statistics
public
mixed
OFFSET_PATH
= 3
This plugin shows statistical graphs and info about your gallery's images and albums
OFFSET_PATH
Displays which HTTP headers your site sends
public
mixed
OFFSET_PATH
= 3
Tags
OFFSET_PATH
Displays locale information of the system
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
Maintenance mode utility based on the former site_upgrade plugin
public
mixed
OFFSET_PATH
= 3
Tags
OFFSET_PATH
Displays the PHP configuration information
public
mixed
OFFSET_PATH
= 3
Tags
OFFSET_PATH
Use this utility to reset your album thumbnails to either "random" or from an ordered field query
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
GDPR data export tool
public
mixed
OFFSET_PATH
= 3
Tags
OFFSET_PATH
This template is used to generate cache images. Running it will process the entire gallery, supplying an album name (ex: loadAlbums.php?album=newalbum) will only process the album named.
public
mixed
OFFSET_PATH
= 3
Passing clear=on will purge the designated cache before generating cache images
OFFSET_PATH
This template is used to generate cache images. Running it will process the entire gallery, supplying an album name (ex: loadAlbums.php?album=newalbum) will only process the album named.
public
mixed
OFFSET_PATH
= 3
Passing clear=on will purge the designated cache before generating cache images
OFFSET_PATH
Zenphoto site cloner
public
mixed
OFFSET_PATH
= 4
OFFSET_PATH
public
mixed
OFFSET_PATH
= 4
OFFSET_PATH
provides the Comments tab of admin
public
mixed
OFFSET_PATH
= 1
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
Check for use of deprecated functions
public
mixed
OFFSET_PATH
= 4
Tags
OFFSET_PATH
Detailed Gallery Statistics
public
mixed
OFFSET_PATH
= 3
This plugin shows statistical graphs and info about your gallery's images and albums
This plugin is dependent on the css of the gallery_statistics utility plugin!
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
The Matomo statistis page if widgets are defined
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
public
mixed
OFFSET_PATH
= 4
OFFSET_PATH
public
mixed
OFFSET_PATH
= 4
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
public
mixed
OFFSET_PATH
= 4
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
This is the "rewrite rules" tab
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
Collects and analyzes searches
public
mixed
OFFSET_PATH
= 4
Tags
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
Sitemap Tools
public
mixed
OFFSET_PATH
= 3
Tool to generate sitemaps
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
user_groups plugin--tabs
public
mixed
OFFSET_PATH
= 4
Tags
OFFSET_PATH
user_groups plugin--tabs
public
mixed
OFFSET_PATH
= 4
Tags
OFFSET_PATH
public
mixed
OFFSET_PATH
= 3
OFFSET_PATH
zenpage admin-categories.php
public
mixed
OFFSET_PATH
= 4
Tags
OFFSET_PATH
zenpage admin-edit.php
public
mixed
OFFSET_PATH
= 4
Tags
OFFSET_PATH
zenpage admin-news-articles.php
public
mixed
OFFSET_PATH
= 4
Tags
OFFSET_PATH
zenpage admin-pages.php
public
mixed
OFFSET_PATH
= 4
Tags
OPEN_IMAGE_CACHE
public
mixed
OPEN_IMAGE_CACHE
= !\getOption('protected_image_cache')
OPTION_TYPE_CHECKBOX
public
mixed
OPTION_TYPE_CHECKBOX
= 1
OPTION_TYPE_CHECKBOX_ARRAY
public
mixed
OPTION_TYPE_CHECKBOX_ARRAY
= 6
OPTION_TYPE_CHECKBOX_UL
public
mixed
OPTION_TYPE_CHECKBOX_UL
= 7
OPTION_TYPE_CLEARTEXT
public
mixed
OPTION_TYPE_CLEARTEXT
= 9
OPTION_TYPE_COLOR_PICKER
public
mixed
OPTION_TYPE_COLOR_PICKER
= 8
OPTION_TYPE_CUSTOM
public
mixed
OPTION_TYPE_CUSTOM
= 2
OPTION_TYPE_NOTE
public
mixed
OPTION_TYPE_NOTE
= 10
OPTION_TYPE_PASSWORD
public
mixed
OPTION_TYPE_PASSWORD
= 11
OPTION_TYPE_RADIO
public
mixed
OPTION_TYPE_RADIO
= 4
OPTION_TYPE_RICHTEXT
public
mixed
OPTION_TYPE_RICHTEXT
= 12
OPTION_TYPE_SELECTOR
public
mixed
OPTION_TYPE_SELECTOR
= 5
OPTION_TYPE_TEXTAREA
public
mixed
OPTION_TYPE_TEXTAREA
= 3
OPTION_TYPE_TEXTBOX
Generates the HTML for custom options (e.g. theme options, plugin options, etc.) Note: option names may not contain '.', '+', nor '%' as PHP POST handling will replace these with an underscore.
public
mixed
OPTION_TYPE_TEXTBOX
= 0
PHP_INT_MAX
public
mixed
PHP_INT_MAX
= 2147483647
PHP_INT_MIN
public
mixed
PHP_INT_MIN
= ~PHP_INT_MAX
PLUGIN_FOLDER
Defines the name of the core extensions folder
public
mixed
PLUGIN_FOLDER
= 'zp-extensions'
PLUGIN_PRIORITY
Defines the bitmask for load order priority of standard plugins
public
mixed
PLUGIN_PRIORITY
= 1023
PLUGINS_PER_PAGE
public
mixed
PLUGINS_PER_PAGE
= \max(1, \getOption('plugins_per_page'))
PLUGINS_PER_PAGE
public
mixed
PLUGINS_PER_PAGE
= \max(1, \getOption('plugins_per_page'))
PRIMARY_INSTALLATION
public
mixed
PRIMARY_INSTALLATION
= true
PROTOCOL
public
mixed
PROTOCOL
= 'http'
PROTOCOL
public
mixed
PROTOCOL
= 'http'
RECORD_LIMIT
public
mixed
RECORD_LIMIT
= 5
SAFE_MODE
public
mixed
SAFE_MODE
= \false
SAFE_MODE_ALBUM_SEP
public
mixed
SAFE_MODE_ALBUM_SEP
= ''
SEARCH_CACHE_DURATION
public
mixed
SEARCH_CACHE_DURATION
= \getOption('search_cache_duration')
SEARCH_DURATION
public
mixed
SEARCH_DURATION
= 3000
SEO_FULLWEBPATH
public
mixed
SEO_FULLWEBPATH
= \FULLWEBPATH
SEO_FULLWEBPATH
public
mixed
SEO_FULLWEBPATH
= \seo_locale::localePath(\true)
SEO_WEBPATH
public
mixed
SEO_WEBPATH
= \WEBPATH
SEO_WEBPATH
public
mixed
SEO_WEBPATH
= \seo_locale::localePath()
SERVER_HTTP_HOST
public
mixed
SERVER_HTTP_HOST
= \PROTOCOL . "://" . $_SERVER['HTTP_HOST']
SERVER_PROTOCOL
public
mixed
SERVER_PROTOCOL
= 'http'
SERVERCACHE
public
mixed
SERVERCACHE
= \SERVERPATH . '/' . \CACHEFOLDER
SERVERPATH
public
mixed
SERVERPATH
= $const_serverpath
SERVERPATH
public
mixed
SERVERPATH
= $_zp_setup_serverpath
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'
SITEMAP_CHUNK
public
mixed
SITEMAP_CHUNK
= \getOption('sitemap_processing_chunk')
SITEMAP_LOCALE_TYPE
public
mixed
SITEMAP_LOCALE_TYPE
= 0
SORT_FLAG_CASE
Defines sort flag case
public
mixed
SORT_FLAG_CASE
= 0
SORT_NATURAL
Defines if sorting should be natural order
public
mixed
SORT_NATURAL
= 0
STATIC_CACHE_FOLDER
Defines the name of the html cache folder
public
mixed
STATIC_CACHE_FOLDER
= "cache_html"
SYMLINK
Defines if symlinks are supported on the server
public
mixed
SYMLINK
= \function_exists('symlink') && \strpos(@\ini_get("suhosin.executor.func.blacklist"), 'symlink') === \false
TEST_RELEASE
Enables test release mode, supports the markRelease plugin
public
mixed
TEST_RELEASE
= isset($_zp_conf_vars['test_release']) && $_zp_conf_vars['test_release'] || \preg_match('~-[^RC]~', \ZENPHOTO_VERSION)
TEXT_INPUT_SIZE
public
mixed
TEXT_INPUT_SIZE
= 48
TEXT_INPUT_SIZE_SHORT
public
mixed
TEXT_INPUT_SIZE_SHORT
= 30
TEXTAREA_COLUMNS
public
mixed
TEXTAREA_COLUMNS
= 50
TEXTAREA_COLUMNS_SHORT
public
mixed
TEXTAREA_COLUMNS_SHORT
= 32
THEME_PLUGIN
Defines the bitmask for load order priority of theme plugins
public
mixed
THEME_PLUGIN
= 1024
THEMEFOLDER
Defines the name of the themes folder
public
mixed
THEMEFOLDER
= 'themes'
THUMB_WATERMARK
public
mixed
THUMB_WATERMARK
= \getOption('Image_watermark')
TIME_FORMAT
public
mixed
TIME_FORMAT
= \trim(\strval(\getOption('time_format')))
UPLOAD_ERR_BLOCKED
public
mixed
UPLOAD_ERR_BLOCKED
= -2
UPLOAD_ERR_QUOTA
Initialize globals for Admin
public
mixed
UPLOAD_ERR_QUOTA
= -1
UPLOAD_FOLDER
Defines name of the non albums upload folder
public
mixed
UPLOAD_FOLDER
= 'uploaded'
USE_CAPTCHA
public
mixed
USE_CAPTCHA
= 8
USER_PLUGIN_FOLDER
Defines the user 3rd party plugin folder outside the Zenphoto core folder
public
mixed
USER_PLUGIN_FOLDER
= 'plugins'
USER_RIGHTS
public
mixed
USER_RIGHTS
= \NO_RIGHTS
USERS_PER_PAGE
public
mixed
USERS_PER_PAGE
= \max(1, \getOption('users_per_page'))
USERS_PER_PAGE
public
mixed
USERS_PER_PAGE
= \max(1, \getOption('users_per_page'))
UTF8_IMAGE_URI
public
mixed
UTF8_IMAGE_URI
= \getOption('UTF8_image_URI')
UTILITIES_FOLDER
Defines the name of the core utlitlites folder
public
mixed
UTILITIES_FOLDER
= 'utilities'
VIEW_ALL_RIGHTS
public
mixed
VIEW_ALL_RIGHTS
= \ALL_ALBUMS_RIGHTS | \ALL_PAGES_RIGHTS | \ALL_NEWS_RIGHTS
VIEW_FULLIMAGE_RIGHTS
public
mixed
VIEW_FULLIMAGE_RIGHTS
= \NO_RIGHTS
VIEW_GALLERY_RIGHTS
public
mixed
VIEW_GALLERY_RIGHTS
= \NO_RIGHTS
VIEW_SEARCH_RIGHTS
public
mixed
VIEW_SEARCH_RIGHTS
= \NO_RIGHTS
WATERMARK_FULL
public
mixed
WATERMARK_FULL
= 4
WATERMARK_IMAGE
public
mixed
WATERMARK_IMAGE
= 1
WATERMARK_THUMB
public
mixed
WATERMARK_THUMB
= 2
WEBPATH
public
mixed
WEBPATH
= $const_webpath
WEBPATH
public
mixed
WEBPATH
= $const_webpath
ZENFOLDER
Defines the name of the Zenphoto core folder (zp-core)
public
mixed
ZENFOLDER
= 'zp-core'
ZENPAGE_COMBINEWS
Some global variable setup
public
mixed
ZENPAGE_COMBINEWS
= \false
ZENPHOTO_LOCALE
public
mixed
ZENPHOTO_LOCALE
= \setMainDomain()
ZENPHOTO_VERSION
Defines the Zenphoto version
public
mixed
ZENPHOTO_VERSION
= '1.6.5'
ZP_ALBUM
public
mixed
ZP_ALBUM
= 2
ZP_ALBUM_LINKED
public
mixed
ZP_ALBUM_LINKED
= 64
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_COMMENT
public
mixed
ZP_COMMENT
= 8
ZP_IMAGE
public
mixed
ZP_IMAGE
= 4
ZP_IMAGE_LINKED
public
mixed
ZP_IMAGE_LINKED
= 128
ZP_INDEX
public
mixed
ZP_INDEX
= 1
ZP_LAST_MODIFIED
Defines the date of the current session for use as a last modified date within the page header()
public
mixed
ZP_LAST_MODIFIED
= \gmdate('D, d M Y H:i:s') . ' GMT'
ZP_NEWS_ENABLED
public
mixed
ZP_NEWS_ENABLED
= \false
ZP_PAGES_ENABLED
public
mixed
ZP_PAGES_ENABLED
= \false
ZP_READ_MORE
public
mixed
ZP_READ_MORE
= \getOption("zenpage_read_more")
ZP_SEARCH
public
mixed
ZP_SEARCH
= 16
ZP_SEARCH_LINKED
public
mixed
ZP_SEARCH_LINKED
= 32
ZP_SHORTEN_LENGTH
public
mixed
ZP_SHORTEN_LENGTH
= \getOption('zenpage_text_length')
ZP_SHORTENINDICATOR
public
mixed
ZP_SHORTENINDICATOR
= $shortenindicator = \getOption('zenpage_textshorten_indicator')
ZP_ZENPAGE_NEWS_ARTICLE
public
mixed
ZP_ZENPAGE_NEWS_ARTICLE
= 512
ZP_ZENPAGE_NEWS_CATEGORY
public
mixed
ZP_ZENPAGE_NEWS_CATEGORY
= 1024
ZP_ZENPAGE_NEWS_DATE
public
mixed
ZP_ZENPAGE_NEWS_DATE
= 2048
ZP_ZENPAGE_NEWS_PAGE
public
mixed
ZP_ZENPAGE_NEWS_PAGE
= 256
ZP_ZENPAGE_PAGE
public
mixed
ZP_ZENPAGE_PAGE
= 4096
ZP_ZENPAGE_SINGLE
public
mixed
ZP_ZENPAGE_SINGLE
= 8192
Functions
printAdminFooter()
Print the footer <div> for the bottom of all admin pages.
printAdminFooter([string $addl = '' ]) : mixed
Parameters
- $addl : string = ''
-
additional text to output on the footer.
Tags
datepickerJS()
datepickerJS() : mixed
printAdminHeader()
Print the header for all admin pages. Starts at <DOCTYPE> but does not include the </head> tag, in case there is a need to add something further.
printAdminHeader(string $tab[, string $subtab = NULL ]) : mixed
Parameters
- $tab : string
-
the album page
- $subtab : string = NULL
-
the sub-tab if any
printSortableHead()
printSortableHead() : mixed
printLogoAndLinks()
Print the html required to display the ZP logo and links in the top section of the admin page.
printLogoAndLinks() : mixed
Tags
printTabs()
Print the nav tabs for the admin section. We determine which tab should be highlighted from the $_GET['page']. If none is set, we default to "home".
printTabs() : mixed
Tags
getSubtabs()
getSubtabs() : mixed
printSubtabs()
printSubtabs() : mixed
setAlbumSubtabs()
setAlbumSubtabs(mixed $album) : mixed
Parameters
- $album : mixed
handleDeprecatedMenuGlobals()
Roughly fixes outdated usages of old admin "tab" globals and joins them with the actual globals.
handleDeprecatedMenuGlobals() : mixed
and also throws deprecation notices about this.
Tags
checked()
Used for checkbox and radiobox form elements to compare the $checked value with the $current.
checked(mixed $checked, mixed $current) : mixed
Echos the attribute checked="checked
Parameters
- $checked : mixed
- $current : mixed
customOptions()
customOptions(mixed $optionHandler[, mixed $indent = "" ][, mixed $album = NULL ][, mixed $showhide = false ][, mixed $supportedOptions = NULL ][, mixed $theme = false ][, mixed $initial = 'none' ][, mixed $extension = NULL ]) : mixed
Parameters
- $optionHandler : mixed
- $indent : mixed = ""
- $album : mixed = NULL
- $showhide : mixed = false
- $supportedOptions : mixed = NULL
- $theme : mixed = false
- $initial : mixed = 'none'
- $extension : mixed = NULL
processCustomOptionSave()
processCustomOptionSave(mixed $returntab[, mixed $themename = NULL ][, mixed $themealbum = NULL ]) : mixed
Parameters
- $returntab : mixed
- $themename : mixed = NULL
- $themealbum : mixed = NULL
standardThemeOptions()
Set defaults for standard theme options incase the theme has not done so
standardThemeOptions(string $theme, mixed $album) : mixed
Parameters
- $theme : string
- $album : mixed
postIndexEncode()
Encodes for use as a $_POST index
postIndexEncode(string $str) : mixed
Parameters
- $str : string
postIndexDecode()
Decodes encoded $_POST index
postIndexDecode(string $str) : string
Parameters
- $str : string
Return values
stringgenerateRadiobuttonsFromArray()
Prints radio buttons from an array
generateRadiobuttonsFromArray(string $currentvalue, string $list, string $option[, bool $behind = false ][, mixed $class = 'checkboxlabel' ][, mixed $disabled = NULL ]) : mixed
Parameters
- $currentvalue : string
-
The current selected value
- $list : string
-
the array of the list items form is localtext => buttonvalue
- $option : string
-
the name of the option for the input field name
- $behind : bool = false
-
set true to have the "text" before the button
- $class : mixed = 'checkboxlabel'
- $disabled : mixed = NULL
generateUnorderedListFromArray()
Creates the body of an unordered list with checkbox label/input fields (scrollable sortables)
generateUnorderedListFromArray(array<string|int, mixed> $currentValue, array<string|int, mixed> $list, string $prefix, string $alterrights, bool $sort, bool $localize[, string $class = NULL ][, mixed $extra = NULL ]) : mixed
Parameters
- $currentValue : array<string|int, mixed>
-
list of items to be flagged as checked
- $list : array<string|int, mixed>
-
the elements of the select list
- $prefix : string
-
prefix of the input item
- $alterrights : string
-
are the items changable.
- $sort : bool
-
true for sorted list
- $localize : bool
-
true if the list local key is text for the item
- $class : string = NULL
-
optional class for items
- $extra : mixed = NULL
tagSelector()
Creates an unordered checklist of the tags
tagSelector(object $that, string $postit[, bool $showCounts = false ][, mixed $mostused = false ][, mixed $addnew = true ][, mixed $resizeable = false ][, mixed $class = 'checkTagsAuto' ]) : mixed
Parameters
- $that : object
-
Object for which to get the tags
- $postit : string
-
prefix to prepend for posting
- $showCounts : bool = false
-
set to true to get tag count displayed
- $mostused : mixed = false
- $addnew : mixed = true
- $resizeable : mixed = false
- $class : mixed = 'checkTagsAuto'
printAlbumEditForm()
emits the html for editing album information called in edit album and mass edit
printAlbumEditForm(string $index, object $album[, bool $buttons = true ]) : mixed
Parameters
- $index : string
-
the index of the entry in mass edit or '0' if single album
- $album : object
-
the album object
- $buttons : bool = true
-
set true for "apply" buttons
Tags
printAlbumButtons()
puts out the maintenance buttons for an album
printAlbumButtons(object $album) : mixed
Parameters
- $album : object
-
is the album being emitted
printAlbumLegend()
printAlbumLegend() : mixed
printAlbumEditRow()
puts out a row in the edit album table
printAlbumEditRow(object $album, bool $show_thumb, object $owner) : mixed
Parameters
- $album : object
-
is the album being emitted
- $show_thumb : bool
-
set to false to show thumb standin image rather than album thumb
- $owner : object
-
the parent album (or NULL for gallery)
processAlbumEdit()
processes the post from the above
processAlbumEdit(int $index, object $album, string &$redirectto) : string
Parameters
- $index : int
-
the index of the entry in mass edit or 0 if single album
- $album : object
-
the album object
- $redirectto : string
-
used to redirect page refresh on move/copy/rename
Tags
Return values
string —error flag if passwords don't match
processImageEdit()
Process the image edit form posted
processImageEdit(obj $image, type $index[, bool $massedit = true ]) : mixed
Parameters
- $image : obj
-
Image object
- $index : type
-
Index of the image if within the images list or 0 if single image edit
- $massedit : bool = true
-
Whether editing single image (false) or multiple images at once (true). Note: to determine whether to process additional fields in single image edit mode.
adminPageNav()
adminPageNav(mixed $pagenum, mixed $totalpages, mixed $adminpage, mixed $parms[, mixed $tab = '' ]) : mixed
Parameters
- $pagenum : mixed
- $totalpages : mixed
- $adminpage : mixed
- $parms : mixed
- $tab : mixed = ''
print_language_string_list()
Generates an editable list of language strings
print_language_string_list(string $dbstring, string $name[, bool $textbox = false ][, string $locale = NULL ][, string $edit = '' ][, int $wide = TEXT_INPUT_SIZE ][, string $ulclass = 'language_string_list' ][, int $rows = 6 ]) : mixed
Parameters
- $dbstring : string
-
either a serialized languag string array or a single string
- $name : string
-
the prefix for the label, id, and name tags
- $textbox : bool = false
-
set to true for a textbox rather than a text field
- $locale : string = NULL
-
optional locale of the translation desired
- $edit : string = ''
-
optional class
- $wide : int = TEXT_INPUT_SIZE
-
column size. true or false for the standard or short sizes. Or pass a column size
- $ulclass : string = 'language_string_list'
-
set to the class for the UL element
- $rows : int = 6
-
set to the number of rows to show.
process_language_string_save()
process the post of a language string form
process_language_string_save(string $name[, $sanitize_level = 3 ]) : string
Parameters
- $name : string
-
the prefix for the label, id, and name tags
- $sanitize_level : = 3
-
the type of sanitization required
Return values
stringgetTagOrder()
Returns the desired tagsort order (0 for alphabetic, 1 for most used)
getTagOrder() : int
Return values
intunzip()
Unzips an image archive
unzip(file $file, string $dir) : mixed
Parameters
- $file : file
-
the archive
- $dir : string
-
where the images go
is_zip()
Checks for a zip file
is_zip(string $filename) : bool
Parameters
- $filename : string
-
name of the file
Return values
boolisolate()
Extracts and returns a 'statement' from a PHP script so that it may be 'evaled'
isolate(string $target, string $str) : string
Parameters
- $target : string
-
the assignment variable to match on
- $str : string
-
the PHP script
Return values
stringlistDirectoryFiles()
Return an array of files from a directory and sub directories
listDirectoryFiles(string $dir) : array<string|int, mixed>
This is a non recursive function that digs through a directory. More info here:
Parameters
- $dir : string
-
directory
Tags
Return values
array<string|int, mixed>themeIsEditable()
Check if a theme is editable (ie not a bundled theme)
themeIsEditable( $theme) : bool
Parameters
Tags
Return values
boolzenPhotoTheme()
zenPhotoTheme(mixed $theme) : mixed
Parameters
- $theme : mixed
copyThemeDirectory()
Copy a theme directory to create a new custom theme
copyThemeDirectory( $source, $target, mixed $newname) : bool|string
Parameters
Tags
Return values
bool|string —either true or an error message
deleteThemeDirectory()
Deletes a theme
deleteThemeDirectory(string $source) : bool
Parameters
- $source : string
-
Full serverpath of the theme
Return values
boolcurrentRelativeURL()
Return URL of current admin page
currentRelativeURL() : string
Tags
Return values
string —current URL
getParentAlbumsAdmin()
Returns an array of the names of the parents of the current album.
getParentAlbumsAdmin(object $album) : array<string|int, mixed>
Parameters
- $album : object
-
optional album object to use inseted of the current album
Return values
array<string|int, mixed>getAlbumBreadcrumbAdmin()
getAlbumBreadcrumbAdmin(mixed $album) : mixed
Parameters
- $album : mixed
removeParentAlbumNames()
Removes the parent album name so that we can print a album breadcrumb with them
removeParentAlbumNames(object $album) : string
Parameters
- $album : object
-
Object of the album
Return values
stringprintAdminRightsTable()
Outputs the rights checkbox table for admin
printAdminRightsTable( $id, string $background, string $alterrights, bit $rights) : mixed
Parameters
printManagedObjects()
Creates the managed album table for Admin
printManagedObjects(string $type, array<string|int, mixed> $objlist, string $alterrights, object $userobj, mixed $prefix_id, string $kind, mixed $flag) : mixed
Parameters
- $type : string
-
the kind of list
- $objlist : array<string|int, mixed>
-
list of objects
- $alterrights : string
-
are the items changable
- $userobj : object
-
the user
- $prefix_id : mixed
- $kind : string
-
user, group, or template
- $flag : mixed
processRights()
processes the post of administrator rights
processRights(int $i) : bit
Parameters
- $i : int
-
the admin row number
Return values
bitprocessManagedObjects()
processManagedObjects(mixed $i, mixed &$rights) : mixed
Parameters
- $i : mixed
- $rights : mixed
getCheckboxState()
Returns the value of a checkbox form item
getCheckboxState(string $id) : int
Parameters
- $id : string
-
the $_REQUEST index
Return values
int —(0 or 1)
standardScripts()
Returns an array of "standard" theme scripts. This list is normally used to exclude these scripts form various option seletors.
standardScripts() : array<string|int, mixed>
Return values
array<string|int, mixed>getWatermarks()
Returns a merged list of available watermarks
getWatermarks() : array<string|int, mixed>
Return values
array<string|int, mixed>processOrder()
Processes the serialized array from tree sort.
processOrder( $orderstr) : array<string|int, mixed>
Returns an array in the form [$id=>array(sort orders), $id=>array(sort orders),...]
Parameters
Return values
array<string|int, mixed>postAlbumSort()
POST handler for album tree sorts
postAlbumSort(int $parentid) : mixed
Parameters
- $parentid : int
-
id of owning album
printNestedAlbumsList()
Prints the sortable nested albums list returns true if nesting levels exceede the database container
printNestedAlbumsList(mixed $albums, bool $show_thumb, object $owner) : bool
Parameters
- $albums : mixed
- $show_thumb : bool
-
set false to use thumb standin image.
- $owner : object
-
the album object of the owner or NULL for the gallery
Return values
boolprintEditDropdown()
Prints the dropdown menu for the nesting level depth for the album sorting
printEditDropdown(mixed $subtab, mixed $nestinglevels, mixed $nesting) : mixed
Parameters
- $subtab : mixed
- $nestinglevels : mixed
- $nesting : mixed
processEditSelection()
processEditSelection(mixed $subtab) : mixed
Parameters
- $subtab : mixed
printBulkActions()
Edit tab bulk actions drop-down
printBulkActions(array<string|int, mixed> $checkarray[, bool $checkAll = false ]) : mixed
Parameters
- $checkarray : array<string|int, mixed>
-
the list of actions
- $checkAll : bool = false
-
set true to include check all box
bulkActionRedirect()
common redirector for bulk action handling return
bulkActionRedirect(string $action) : mixed
Parameters
- $action : string
bulkTags()
Process the bulk tags
bulkTags() : array<string|int, mixed>
Return values
array<string|int, mixed>processAlbumBulkActions()
Processes the check box bulk actions for albums
processAlbumBulkActions() : mixed
processImageBulkActions()
Handles Image bulk actions
processImageBulkActions( $album) : mixed
Parameters
processCommentBulkActions()
Processes the check box bulk actions for comments
processCommentBulkActions() : mixed
codeblocktabsJS()
Codeblock tabs JavaScript code
codeblocktabsJS() : mixed
printCodeblockEdit()
prints codeblock edit boxes
printCodeblockEdit(object $obj, int $id) : mixed
Parameters
- $obj : object
- $id : int
processCodeblockSave()
handles saveing of codeblock edits
processCodeblockSave(int $id) : string
Parameters
- $id : int
Return values
stringadmin_securityChecks()
Standard admin pages checks
admin_securityChecks(bit $rights, mixed $return) : mixed
Parameters
- $rights : bit
- $return : mixed
minDiff()
getPageSelector "diff" function
minDiff(string $string1, string2 $string2) : mixed
returns the shortest string difference
Parameters
- $string1 : string
- $string2 : string2
fullText()
getPageSelector "diff" function
fullText(string $string1, string $string2) : string
Used when you want getPgeSelector to show the full text of the items
Parameters
- $string1 : string
- $string2 : string
Return values
stringdateDiff()
getPageSelector "diff" function
dateDiff(string $date1, string $date2) : string
returns the shortest "date" difference
Parameters
- $date1 : string
- $date2 : string
Return values
stringgetPageSelector()
returns a selector list based on the "names" of the list items
getPageSelector(array<string|int, mixed> $list, int $itmes_per_page[, string $diff = 'fullText' ]) : array<string|int, mixed>
Parameters
- $list : array<string|int, mixed>
- $itmes_per_page : int
- $diff : string = 'fullText'
-
"fullText" for the complete names "minDiff" for a truncated string showing just the unique characters of the names "dateDiff" it the "names" are really dates.
Return values
array<string|int, mixed>printPageSelector()
printPageSelector(mixed $pagenumber, mixed $rangeset, mixed $script, mixed $queryParams) : mixed
Parameters
- $pagenumber : mixed
- $rangeset : mixed
- $script : mixed
- $queryParams : mixed
unQuote()
Strips off quotes from the strng
unQuote( $string) : mixed
Parameters
admin_album_list()
Returns an option list of administrators who can own albums or images
admin_album_list(string $owner) : string
Parameters
- $owner : string
Return values
stringgetLogTabs()
Returns an array with the logtabs array, the default log tab and an array of log files to the default (current) log tab (for use in the logfile selector)
getLogTabs() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getDefaultLogTabs()
Gets an array log tab names and localized (gettexted) log titles
getDefaultLogTabs() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getLogFiles()
Gets a nested array with the log type (tab name) and corresponding log files
getLogFiles() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>printLogSelector()
Prints the selector for logfiles of the current log tab
printLogSelector([string $currentlogtab = '' ][, string $currentlogfile = '' ][, array<string|int, mixed> $logfiles = array() ]) : mixed
Parameters
- $currentlogtab : string = ''
-
Current log tab
- $currentlogfile : string = ''
-
Current log file selected
- $logfiles : array<string|int, mixed> = array()
-
Array of logfiles
Tags
getPluginTabs()
Figures out which plugin tabs to display
getPluginTabs() : mixed
getAdminThumbSizes()
Gets an array with the size values for the admin thumb generation
getAdminThumbSizes(obj $imageobj[, string $size = 'small' ]) : array<string|int, mixed>
Parameters
- $imageobj : obj
-
The image object
- $size : string = 'small'
-
Adminthumb sizeame: 'large', 'small', 'large-uncropped', 'small-uncropped'
Tags
Return values
array<string|int, mixed>getAdminThumb()
Gets the URL of the adminthumb
getAdminThumb(obj $imageobj[, string $size = 'small' ]) : string
Parameters
- $imageobj : obj
-
The image object
- $size : string = 'small'
-
Adminthumb sizeame: 'large', 'small', 'large-uncropped', 'small-uncropped'
Return values
stringgetSizeAdminThumb()
Returns an array with width and height of the resized image
getSizeAdminThumb(obj $imageobj[, string $size = 'small' ]) : array<string|int, mixed>
Parameters
- $imageobj : obj
-
The image object
- $size : string = 'small'
-
Adminthumb sizeame: 'large', 'small', 'large-uncropped', 'small-uncropped'
Tags
Return values
array<string|int, mixed>getAdminThumbHTML()
Returns the full HTML element of an admin thumb Applies the filters 'adminthumb_html'
getAdminThumbHTML(obj $imageobj[, string $size = 'small' ][, string $class = null ][, string $id = null ][, string $alt = null ][, string $title = null ]) : string
Parameters
- $imageobj : obj
-
The image object
- $size : string = 'small'
-
Adminthumb sizeame: 'large', 'small', 'large-uncropped', 'small-uncropped'
- $class : string = null
-
Class name(s) to attach
- $id : string = null
-
ID to attach
- $alt : string = null
-
Alt attribute
- $title : string = null
-
Title attribute
Tags
Return values
stringprintAdminThumb()
Prints an admin thumb
printAdminThumb(obj $imageobj[, string $size = 'small' ][, string $class = null ][, string $id = null ][, string $alt = null ][, string $title = null ]) : string
Parameters
- $imageobj : obj
-
The image object
- $size : string = 'small'
-
Adminthumb sizeame: 'large', 'small', 'large-uncropped', 'small-uncropped'
- $class : string = null
-
Class name(s) to attach
- $id : string = null
-
ID to attach
- $alt : string = null
-
Alt attribute
- $title : string = null
-
Title attribute
Tags
Return values
stringprocessCredentials()
handles save of user/password
processCredentials(object $object[, mixed $suffix = '' ]) : mixed
Parameters
- $object : object
- $suffix : mixed = ''
consolidatedEditMessages()
consolidatedEditMessages(mixed $subtab) : mixed
Parameters
- $subtab : mixed
getThemeFiles()
returns an array of the theme scripts not in the exclude array
getThemeFiles(array<string|int, mixed> $exclude) : array<string|int, mixed>
Parameters
- $exclude : array<string|int, mixed>
-
those scripts to ignore
Return values
array<string|int, mixed>checkAlbumParentid()
Checks for bad parentIDs from old move/copy bug
checkAlbumParentid(unknown_type $albumname, unknown_type $id, mixed $recorder) : mixed
Parameters
- $albumname : unknown_type
- $id : unknown_type
- $recorder : mixed
clonedFrom()
clonedFrom() : mixed
checkAlbumimagesort()
Make sure the albumimagesort is only an allowed value. Otherwise returns nothing.
checkAlbumimagesort(string $val[, string $type = 'albumimagesort' ]) : string
Parameters
- $val : string
- $type : string = 'albumimagesort'
-
'albumimagesort' or 'albumimagesort_status'
Return values
stringprintLastChangeInfo()
Prints the last change date and last change user notice on backend edit pages Also for albums it prints the updateddate
printLastChangeInfo(obj $obj) : mixed
Parameters
- $obj : obj
-
Object of any item type
Tags
getSortByOptions()
Returns the option array for the sort by selectors for gallery, albums and images
getSortByOptions(string $type) : array<string|int, mixed>
Parameters
- $type : string
-
"albums" (also for gallery), "albums-dynamic", 'images' "image-edit" (the images edit tab backend only ordering) "pages" and "news" for Zenpage items
Tags
Return values
array<string|int, mixed>getSortByStatusOptions()
Returns an array of the status order options for all items
getSortByStatusOptions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>checkSchedulePublishingNotes()
Helper to check if notes are to be printed (only needed because of the inconvenient legacy table based layout on image edit pages)
checkSchedulePublishingNotes(obj $obj) : bool
Parameters
- $obj : obj
-
Image, album, news article or page object
Tags
Return values
boolprintScheduledPublishingNotes()
Prints various notes regarding the scheduled publishing status for single edit pages
printScheduledPublishingNotes(obj $obj) : mixed
Parameters
- $obj : obj
-
Image, album, news article or page object
Tags
printStatusNotes()
Prints various notes regarding the scheduled publishing status for single edit pages
printStatusNotes(obj $obj) : mixed
Parameters
- $obj : obj
-
Image, album, news article, new category or page object
Tags
getStatusNote()
Gets a specific predefined status note for an object (if available) Note: The notes are not status dependend!
getStatusNote([string $name = '' ]) : string
Parameters
- $name : string = ''
-
Name of the note
Return values
stringgetStatusNotes()
Gets an array of all predefined status notes
getStatusNotes() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getStatusNotesByContext()
Gets an array with all status notes that apply to $obj currently
getStatusNotesByContext(string $obj) : array<string|int, mixed>
Parameters
- $obj : string
Tags
Return values
array<string|int, mixed>getStatusIcons()
Gets an key => value array of all available object status icons as full <img> elements
getStatusIcons() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getStatusIcon()
Gets the icon img element for a specific status icon
getStatusIcon([string $name = '' ]) : string
Parameters
- $name : string = ''
-
(Internal) Name of the icon
Tags
Return values
stringprintPublishIconLinkGallery()
Prints the publish icon link to change the status on the album and thumb image list
printPublishIconLinkGallery(object $obj[, bool $enableedit = false ][, string $owner = null ]) : mixed
Parameters
- $obj : object
-
Image or album object
- $enableedit : bool = false
-
true if allowed to use
- $owner : string = null
-
User name of the owner
Tags
getPublishIcon()
Returns the publish icon for the current status
getPublishIcon(obj $obj) : string
Parameters
- $obj : obj
-
Object of the page or news article to check
Tags
Return values
stringprintPublished()
Prints the scheduled publishing date for items if set. Also prints the date for Zenpage news articles and pages