[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/admin/roles/classes/ -> capability_table_base.php (summary)

Base capability table.

Copyright: 1999 onwards Martin Dougiamas (http://dougiamas.com)
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 195 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 7 functions

  __construct()
  add_classes()
  display()
  print_heading_row()
  skip_row()
  get_row_classes()
  get_row_attributes()

Functions
Functions that are not part of a class:

__construct(context $context, $id)   X-Ref
Constructor.

param: context $context the context this table relates to.
param: string $id what to put in the id="" attribute.

add_classes($classnames)   X-Ref
Use this to add class="" attributes to the table. You get the rolecap by
default.

param: array $classnames of class names.

display()   X-Ref
Display the table.


print_heading_row($capability)   X-Ref
Used to output a heading rows when the context level or component changes.

param: stdClass $capability gives the new component and contextlevel.

skip_row($capability)   X-Ref
For subclasses to override. Allows certain capabilties
to be left out of the table.

param: object $capability the capability this row relates to.
return: boolean. If true, this row is omitted from the table.

get_row_classes($capability)   X-Ref
For subclasses to override. A change to reaturn class names that are added
to the class="" attribute on the <tr> for this capability.

param: stdClass $capability the capability this row relates to.
return: array of class name strings.

get_row_attributes($capability)   X-Ref
For subclasses to override. Additional attributes to be added to
each table row for the capability

param: stdClass $capability the capability this row relates to.
return: array attribute names and their values.



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1