Docs For Class Module_cms_comcode

Class Module_cms_comcode_pages

Description

Module page class.

Located in /cms/pages/modules/cms_comcode_pages.php (line 24)

Method Summary

tempcode do_next_manager (tempcode $title, ?ID_TEXT $page, ID_TEXT $zone, tempcode $completion_text)

tempcode ed ()

tempcode export ()

PATH find_comcode_page (LANGUAGE_NAME $lang, ID_TEXT $file, ID_TEXT $zone)

array get_comcode_files_array (LANGUAGE_NAME $lang)

array get_comcode_revisions (ID_TEXT $zone, PATH $subdir, string $find_for, [boolean $also_checking_base = false])

?array get_entry_points ()

array get_sp_overrides ()

?array info ()

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

tempcode run ()

void uninstall ()

tempcode _ed ()

tempcode __ed ()

Methods

do_next_manager (line 175)

The do-next manager for after content management.

return: The UI

tempcode do_next_manager (tempcode $title, ?ID_TEXT $page, ID_TEXT $zone, tempcode $completion_text)

tempcode $title: The title (output of get_page_title)
?ID_TEXT $page: The name of the page just handled (NULL: none)
ID_TEXT $zone: The name of the zone just handled (blank: none/welcome-zone)
tempcode $completion_text: The text to show (blank: default)

ed (line 284)

The UI to choose a page to edit.

return: The UI

tempcode ed ()

export (line 882)

The actualiser to export a comcode page.

return: The UI

tempcode export ()

find_comcode_page (line 342)

Find the filebase-relative path of a Comcode page. Allows override via restore_from parameter.

return: The path

PATH find_comcode_page (LANGUAGE_NAME $lang, ID_TEXT $file, ID_TEXT $zone)

LANGUAGE_NAME $lang: The language most preferable
ID_TEXT $file: The page name
ID_TEXT $zone: The zone

get_comcode_files_array (line 193)

Get all pages.

return: The map (page name => path/time)

array get_comcode_files_array (LANGUAGE_NAME $lang)

LANGUAGE_NAME $lang: The language we are searching for pages of

get_comcode_revisions (line 230)

Get a map of page names to paths, under the given specifications.

return: The map (page name => path/time)

array get_comcode_revisions (ID_TEXT $zone, PATH $subdir, string $find_for, [boolean $also_checking_base = false])

ID_TEXT $zone: The zone we are searching in
PATH $subdir: The subdirectory to search for pages in
string $find_for: The file stub to find for
boolean $also_checking_base: Whether we are doing a multi-site check on the base directory

get_entry_points (line 50)

Standard modular entry-point finder function.

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

?array get_entry_points ()

get_sp_overrides (line 60)

Standard modular specific-permission-overide finder function.

return: A map of specific-permissions that are overridable; sp to 0 or 1. 0 means "not category overridable". 1 means "category overridable".

array get_sp_overrides ()

info (line 32)

Standard modular info function.

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

?array info ()

install (line 96)

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)

run (line 150)

Standard modular run function.

return: The result of execution.

tempcode run ()

uninstall (line 68)

Standard modular uninstall function.

void uninstall ()

_ed (line 360)

The UI to edit a page.

return: The UI

tempcode _ed ()

__ed (line 650)

The actualiser to edit a comcode page.

return: The UI

tempcode __ed ()

Documentation generated on Sun, 02 Jan 2011 23:11:14 +0000 by phpDocumentor 1.4.3