/sources/permissions2.php

Description
Functions
get_category_permissions_for_environment (line 135)

Gather the permissions for the specified category as a form field input matrix.

  • return: The form field matrix
tempcode get_category_permissions_for_environment (ID_TEXT $module, ID_TEXT $category, [?ID_TEXT $page = NULL], [?tempcode $help = NULL], [boolean $new_category = false], [?tempcode $pinterface_view = NULL])
  • ID_TEXT $module: The ID code for the module being checked for category access
  • ID_TEXT $category: The ID code for the category being checked for access (often, a number cast to a string)
  • ?ID_TEXT $page: The page this is for (NULL: current page)
  • ?tempcode $help: Extra help to show in interface (NULL: none)
  • boolean $new_category: Whether this is a new category (don't load permissions, default to on)
  • ?tempcode $pinterface_view: Label for view permissions (NULL: default)
get_page_permissions_for_environment (line 391)

Gather the permissions for the specified page as form field inputs.

  • return: The form fields
tempcode get_page_permissions_for_environment (ID_TEXT $zone, ID_TEXT $page, [?tempcode $help = NULL])
  • ID_TEXT $zone: The ID code for the zone
  • ID_TEXT $page: The ID code for the page
  • ?tempcode $help: Extra help to show in interface (NULL: none)
get_permissions_matrix (line 225)

Create a form field input matrix for permission setting.

  • return: The form field matrix
tempcode get_permissions_matrix (ID_TEXT $server_id, array $access, array $overridables, array $specific_permissions, array $default_access, [boolean $no_outer = false], [?tempcode $pinterface_view = NULL])
  • ID_TEXT $server_id: Permission ID (pagelink style) for the resource being set
  • array $access: An inverted list showing what view permissions are set for what we're setting permissions for
  • array $overridables: List of overridable specific-permission codes for what we're setting permissions for
  • array $specific_permissions: List of specific-permission settings relating to what we're setting permissions for, from the database
  • array $default_access: Multi-dimensional array showing what the inherited defaults for this permission would be
  • boolean $no_outer: Whether to not include the stuff to make it fit alongside other form fields in a normal form table
  • ?tempcode $pinterface_view: Label for view permissions (NULL: default)
has_specific_permission_group (line 77)

Find if a group has a specified permission

  • return: Whether the member has the permission
boolean has_specific_permission_group (GROUP $group_id, ID_TEXT $permission, [?ID_TEXT $page = NULL], [?array $cats = NULL])
  • GROUP $group_id: The being checked whether to have the permission
  • ID_TEXT $permission: The ID code for the permission being checked for
  • ?ID_TEXT $page: The ID code for the page being checked (NULL: current page)
  • ?array $cats: A list of cat details to require access to (c-type-1,c-id-1,c-type-2,c-d-2,...) (NULL: N/A)
set_category_permissions_from_environment (line 318)

Assuming that permission details are POSTed, set the permissions for the specified category, in the current page

void set_category_permissions_from_environment (ID_TEXT $module, ID_TEXT $category, [?ID_TEXT $page = NULL])
  • ID_TEXT $module: The ID code for the module being checked for category access
  • ID_TEXT $category: The ID code for the category being checked for access (often, a number cast to a string)
  • ?ID_TEXT $page: The page this is for (NULL: current page)
set_page_permissions_from_environment (line 434)

Assuming that permission details are POSTed, set the permissions for the specified category, in the current page

void set_page_permissions_from_environment (ID_TEXT $zone, ID_TEXT $page)
  • ID_TEXT $zone: The ID code for the zone
  • ID_TEXT $page: The ID code for the page
_handle_permission_check_logging (line 29)

Log permission checks to the permission_checks.log file

void _handle_permission_check_logging (MEMBER $member, ID_TEXT $op, array $params, boolean $result)
  • MEMBER $member: The user checking against
  • ID_TEXT $op: The function that was called to check a permission
  • array $params: Parameters to this permission-checking function
  • boolean $result: Whether the permission was held

Documentation generated on Sun, 02 Jan 2011 23:20:59 +0000 by phpDocumentor 1.4.3