Docs For Class Module_admin

Class Module_admin_themes

Description

Module page class.

Located in /adminzone/pages/modules/admin_themes.php (line 24)

Method Summary

tempcode add_image ()

tempcode add_theme ()

tempcode choose_css ()

tempcode choose_theme (tempcode $title, [boolean $lang_too = false])

tempcode do_next_manager (tempcode $title, tempcode $description, ID_TEXT $theme, ?LANGUAGE_NAME $lang, ID_TEXT $type, ID_TEXT $file)

tempcode edit_css ()

tempcode edit_image ()

tempcode edit_templates ()

tempcode edit_theme ()

tempcode generate_from (array $array, string $stub, string $id)

array get_css_revisions (ID_TEXT $theme, string $find_for)

?array get_entry_points ()

array get_image_form_fields (ID_TEXT $theme, LANGUAGE_NAME $lang, [SHORT_TEXT $id = ''], [URLPATH $path = ''])

array get_template_files_array (ID_TEXT $theme, [string $find_for = ''], [boolean $this_theme_only = false])

array get_template_revisions (PATH $base_dir, PATH $subdir, string $find_for)

tempcode get_theme_fields ([string $name = ''], [string $title = ''], [string $description = ''], [?string $author = NULL], [boolean $use_on_all_zones = false])

?array info ()

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

tempcode list_screen_previews ()

tempcode manage_images ()

tempcode manage_themes ()

tempcode run ()

void save_theme_changes (ID_TEXT $theme)

void uninstall ()

tempcode view_screen_preview ()

tempcode _add_image ()

tempcode _add_theme ()

tempcode _edit_css ()

tempcode _edit_image ()

tempcode _edit_templates ()

tempcode _edit_theme ()

tempcode __edit_templates ()

Methods

add_image (line 1561)

The UI to add a theme image.

return: The UI

tempcode add_image ()

add_theme (line 411)

The UI to add a theme.

return: The UI

tempcode add_theme ()

choose_css (line 659)

The UI to choose a CSS file to edit.

return: The UI

tempcode choose_css ()

choose_theme (line 629)

The UI to choose a theme.

return: The UI

tempcode choose_theme (tempcode $title, [boolean $lang_too = false])

tempcode $title: The title to show when choosing a theme
boolean $lang_too: Whether to also choose a language

do_next_manager (line 557)

The do-next manager for after download content management.

return: The UI

tempcode do_next_manager (tempcode $title, tempcode $description, ID_TEXT $theme, ?LANGUAGE_NAME $lang, ID_TEXT $type, ID_TEXT $file)

tempcode $title: The title (output of get_page_title)
tempcode $description: Some description to show, saying what happened
ID_TEXT $theme: The theme that was just handled
?LANGUAGE_NAME $lang: The language we were working in (NULL: autodetect) (blank: autodetect)
ID_TEXT $type: Code to determine what kind of links to show
ID_TEXT $file: ID of file that an edit link should load (blank: N/A)

edit_css (line 699)

The UI to edit a CSS file.

return: The UI

tempcode edit_css ()

edit_image (line 1682)

The UI to edit a theme image.

return: The UI

tempcode edit_image ()

edit_templates (line 994)

The UI to choose a template to edit.

return: The UI

tempcode edit_templates ()

edit_theme (line 462)

The UI to edit/rename a theme.

return: The UI

tempcode edit_theme ()

generate_from (line 1409)

Helper function to get tempcode for insertion of symbols.

return: The tempcode

tempcode generate_from (array $array, string $stub, string $id)

array $array: A list of pairs (symbol name,arity)
string $stub: The "stub" that determines what language codes to lookup for the given symbols, and generally, the collective naming strategy
string $id: The ID of the actual template editor we are working with

get_css_revisions (line 902)

Get all the revisions for a CSS file in a certain theme.

return: A map of the revisions (file=>timestamp)

array get_css_revisions (ID_TEXT $theme, string $find_for)

ID_TEXT $theme: The theme to find for
string $find_for: The file to find revisions of

get_entry_points (line 187)

Standard modular entry-point finder function.

return: A map of entry points (type-code=>language-code) (NULL: disabled).

?array get_entry_points ()

get_image_form_fields (line 1533)

Get tempcode for a theme image adding/editing form.

return: A pair: the tempcode for the visible fields, and the tempcode for the hidden fields

array get_image_form_fields (ID_TEXT $theme, LANGUAGE_NAME $lang, [SHORT_TEXT $id = ''], [URLPATH $path = ''])

ID_TEXT $theme: The theme the theme image is in
LANGUAGE_NAME $lang: The language the theme image is for
SHORT_TEXT $id: The theme image ID
URLPATH $path: The URL to the theme image

get_template_files_array (line 930)

Get all the templates for a theme (optionally, revisions of a single template).

return: A map of the files (for revisions, file=>timestamp, generally, file=>path)

array get_template_files_array (ID_TEXT $theme, [string $find_for = ''], [boolean $this_theme_only = false])

ID_TEXT $theme: The theme to search for
string $find_for: The file to find revisions of (blank: we're not looking for revisions)
boolean $this_theme_only: Just for this theme

get_template_revisions (line 956)

Get all the revisions for a template file in a certain directory.

return: A map of the revisions (file=>timestamp)

array get_template_revisions (PATH $base_dir, PATH $subdir, string $find_for)

PATH $base_dir: The path to search relative to
PATH $subdir: The subdirectory to search
string $find_for: The file to find revisions of

get_theme_fields (line 319)

Get standard form input fields for inputting a theme.

return: The fields

tempcode get_theme_fields ([string $name = ''], [string $title = ''], [string $description = ''], [?string $author = NULL], [boolean $use_on_all_zones = false])

string $name: The name of the theme
string $title: The theme title
string $description: The theme description
?string $author: The theme author (NULL: current member)
boolean $use_on_all_zones: Whether to use this theme on all zones

info (line 32)

Standard modular info function.

return: Map of module info (NULL: module is disabled).

?array info ()

install (line 71)

Standard modular install function.

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])

?integer $upgrade_from: What version we're upgrading from (NULL: new install)
?integer $upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)

list_screen_previews (line 1801)

Shows the list of templates

return: The UI

tempcode list_screen_previews ()

manage_images (line 1641)

The UI to select a theme image to edit.

return: The UI

tempcode manage_images ()

manage_themes (line 238)

The UI to manage themes.

return: The UI

tempcode manage_themes ()

run (line 197)

Standard modular run function.

return: The result of execution.

tempcode run ()

save_theme_changes (line 362)

Common theme change saving for adding and editing themes.

void save_theme_changes (ID_TEXT $theme)

ID_TEXT $theme: The name of the theme

uninstall (line 48)

Standard modular uninstall function.

void uninstall ()

view_screen_preview (line 1912)

Shows the preview of a screen

return: The UI

tempcode view_screen_preview ()

_add_image (line 1596)

The actualiser to add a theme image.

return: The UI

tempcode _add_image ()

_add_theme (line 436)

The actualiser to add a theme.

return: The UI

tempcode _add_theme ()

_edit_css (line 827)

The actualiser to edit a CSS file.

return: The UI

tempcode _edit_css ()

_edit_image (line 1762)

The actualiser to edit a theme image.

return: The UI

tempcode _edit_image ()

_edit_templates (line 1047)

The UI to edit a template.

return: The UI

tempcode _edit_templates ()

_edit_theme (line 495)

The actualiser to edit/rename a theme.

return: The UI

tempcode _edit_theme ()

__edit_templates (line 1426)

The actualiser to edit a template. Always saves to the most overridden version.

return: The UI

tempcode __edit_templates ()

Documentation generated on Sun, 02 Jan 2011 23:08:05 +0000 by phpDocumentor 1.4.3