Docs For Class Module

Class Module_groups

Description

Module page class.

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

Method Summary

tempcode accept ()

tempcode add_to ([boolean $special_permission = false], [?string $username = NULL])

tempcode apply ()

tempcode decline ()

tempcode directory ()

?array get_entry_points ()

?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)

?array info ()

tempcode remove_from ()

tempcode resign ()

tempcode run ()

tempcode usergroup ()

Methods

accept (line 663)

The actualiser to accept a member into a usergroup.

return: The UI

tempcode accept ()

add_to (line 523)

The actualiser to add a member to a usergroup.

return: The UI

tempcode add_to ([boolean $special_permission = false], [?string $username = NULL])

boolean $special_permission: Whether to skip checking permission for usergroup control
?string $username: Username to add (NULL: read from environment)

apply (line 590)

The actualiser to apply to join a usergroup.

return: The UI

tempcode apply ()

decline (line 691)

The actualiser to decline a members joining of a usergroup.

return: The UI

tempcode decline ()

directory (line 148)

The UI to show the usergroup directory.

return: The UI

tempcode directory ()

get_entry_points (line 49)

Standard modular entry-point finder function.

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

?array get_entry_points ()

get_page_links (line 63)

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 92)

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 $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.

info (line 32)

Standard modular info function.

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

?array info ()

remove_from (line 557)

The actualiser to remove a member from a usergroup.

return: The UI

tempcode remove_from ()

resign (line 727)

The actualiser to resign from a usergroup.

return: The UI

tempcode resign ()

run (line 121)

Standard modular run function.

return: The result of execution.

tempcode run ()

usergroup (line 307)

The UI to show a usergroup.

return: The UI

tempcode usergroup ()

Documentation generated on Sun, 02 Jan 2011 23:15:46 +0000 by phpDocumentor 1.4.3