Class Module_cedi

Description

Module page class.

Located in /site/pages/modules/cedi.php (line 24)


	
			
Method Summary
tempcode changes ()
tempcode do_cedi_merge ()
tempcode do_menu (SHORT_TEXT $chain, BINARY $expanded, AUTO_LINK $id, boolean $include_expansion, [boolean $may_post = true])
array extract_page_link_permissions (string $page_link)
?array get_entry_points ()
array get_markers ()
?array get_page_links ([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])
void get_sitemap_pagelinks (string $callback, MEMBER $member_id, integer $depth, string $pagelink_stub, [?string $parent_pagelink = NULL], [integer $recurse_level = 0], [?array $category_data = NULL])
?array info ()
void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
tempcode move ()
tempcode page ()
tempcode post ()
tempcode random ()
tempcode run ()
tempcode tree ()
void uninstall ()
tempcode _move ()
tempcode _post ()
Methods
changes (line 620)

The UI to show changes.

  • return: The UI
tempcode changes ()
do_cedi_merge (line 727)

The actualiser for merging CEDI posts.

  • return: The UI.
tempcode do_cedi_merge ()
do_cedi_merge_interface (line 691)

The UI for merging CEDI posts.

  • return: The UI.
tempcode do_cedi_merge_interface ()
do_menu (line 563)

Show the buttons on the CEDI page viewing page.

  • return: The button tempcode
tempcode do_menu (SHORT_TEXT $chain, BINARY $expanded, AUTO_LINK $id, boolean $include_expansion, [boolean $may_post = true])
  • SHORT_TEXT $chain: The ID chain being used to get to this page
  • BINARY $expanded: Whether the images embedded in the tempcode are expanded
  • AUTO_LINK $id: The ID of the page we are showing the menu on
  • boolean $include_expansion: Whether to include the expansion/contraction button
  • boolean $may_post: Whether posting is generally allowed (may be passed false if too many posts)
extract_page_link_permissions (line 316)

Convert a page link to a category ID and category permission module type.

  • return: The pair
array extract_page_link_permissions (string $page_link)
  • string $page_link: The page link
get_entry_points (line 221)

Standard modular entry-point finder function.

  • return: A map of entry points (type-code=>language-code) (NULL: disabled).
?array get_entry_points ()
get_markers (line 676)

Get markers of posts from the POST/GET.

  • return: A list of markers.
array get_markers ()
get_page_links (line 235)

Standard modular page-link finder function (does not return the main entry-points that are not inside the tree).

  • return: A tuple: 1) full tree structure [made up of (pagelink, permission-module, permissions-id, title, children, ?entry point for the children, ?children permission module, ?whether there are children) OR a list of maps from a get_* function] 2) permissions-page 3) optional base entry-point for the tree 4) optional permission-module 5) optional permissions-id (NULL: disabled).
?array get_page_links ([?integer $max_depth = NULL], [boolean $require_permission_support = false], [?string $start_at = NULL], [boolean $dont_care_about_categories = false])
  • ?integer $max_depth: The number of tree levels to computer (NULL: no limit)
  • boolean $require_permission_support: Whether to not return stuff that does not support permissions (unless it is underneath something that does).
  • ?string $start_at: Position to start at in the tree. Does not need to be respected. (NULL: from root)
  • boolean $dont_care_about_categories: Whether to avoid returning categories.
get_sitemap_pagelinks (line 265)

Standard modular new-style deep page-link finder function (does not return the main entry-points).

void get_sitemap_pagelinks (string $callback, MEMBER $member_id, integer $depth, string $pagelink_stub, [?string $parent_pagelink = NULL], [integer $recurse_level = 0], [?array $category_data = NULL])
  • string $callback: Callback function to send discovered page-links to.
  • MEMBER $member_id: The member we are finding stuff for (we only find what the member can view).
  • integer $depth: Code for how deep we are tunnelling down, in terms of whether we are getting entries as well as categories.
  • string $pagelink_stub: Stub used to create page-links. This is passed in because we don't want to assume a zone or page name within this function.
  • ?string $parent_pagelink: Where we're looking under (NULL: root of tree). We typically will NOT show a root node as there's often already an entry-point representing it.
  • integer $recurse_level: Our recursion depth (used to calculate importance of page-link, used for instance by Google sitemap). Deeper is typically less important.
  • ?array $category_data: Non-standard for API [extra parameter tacked on] (NULL: yet unknown). Contents of database table for performance.
info (line 32)

Standard modular info function.

  • return: Map of module info (NULL: module is disabled).
?array info ()
install (line 89)

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)
move (line 763)

The UI for moving a CEDI post.

  • return: The UI.
tempcode move ()
page (line 377)

The UI to show a page.

  • return: The UI
tempcode page ()
post (line 836)

The UI for making a CEDI post.

  • return: The UI.
tempcode post ()
random (line 358)

Redirect to a random page.

  • return: The UI
tempcode random ()
run (line 328)

Standard modular run function.

  • return: The result of execution.
tempcode run ()
tree (line 1051)

The UI to show the CEDI tree.

  • return: The UI
tempcode tree ()
uninstall (line 48)

Standard modular uninstall function.

void uninstall ()
_move (line 795)

The actualiser for moving a CEDI post.

  • return: The UI.
tempcode _move ()
_post (line 957)

The actualiser for making a CEDI post.

  • return: The UI.
tempcode _post ()

Documentation generated on Sun, 02 Jan 2011 23:10:37 +0000 by phpDocumentor 1.4.3