Textpattern PHP Cross Reference Content Management Systems

Summary: /textpattern/vendors/Textpattern/Admin/Theme.php - 386 lines - 9498 bytes - Source - Print

Description: Base for admin-side themes.

Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 10 functions

__construct()
path()
factory()
init()
names()
based_on()
set_state()
announce()
announce_async()
manifest()

Functions

Functions that are not part of a class:

__construct($name line: 90
Constructor.

param: string $name Theme name
path($name line: 105
Gets a theme's source path.

return: string Source file path for named theme
param: string $name Theme name
factory($name line: 117
Theme factory.

return: \Textpattern\Admin\Theme|bool An initialised theme object or FALSE on failure
param: string $name Theme name
init($name = '')  line: 143
Initialise the theme singleton.

return: \Textpattern\Admin\Theme A valid theme object
param: string $name Theme name
names()  line: 174
Get a list of all theme names.

return: array Alphabetically sorted array of all available theme names
based_on($name line: 204
Inherit from an ancestor theme.

return: bool TRUE on success, FALSE on unavailable/invalid ancestor theme
param: string $name Name of ancestor theme
set_state($area, $event, $is_popup, $message line: 229
Sets Textpatterns menu structure, message contents and other application
states.

return: \Textpattern\Admin\Theme This theme object
param: string $area Currently active top level menu
param: string $event Currently active second level menu
param: bool $is_popup Just a popup window for tag builder et cetera
param: array $message The contents of the notification message pane
announce($thing = array('', 0)  line: 332
Output notification message for synchronous HTML views.

return: string HTML
param: array $thing Message text and status flag
param: bool $modal If TRUE, immediate user interaction suggested
announce_async($thing = array('', 0)  line: 348
Output notification message for asynchronous JavaScript views.

return: string JavaScript
param: array $thing Message text and status flag
param: bool $modal If TRUE, immediate user interaction suggested
manifest()  line: 367
Define bureaucratic details of this theme.

All returned items are optional.

return: array

title

Body