Docs For Class ActionData

Description

An available action

Located in /inc/actions/actions.php (line 27)

Variable Summary

string $action_class

string $menu

integer $menu_order

boolean $menu_visible

string $name

integer $next_action

integer $permissions

string $title

Method Summary

ActionData ActionData (string $class, string $file, string $name, string $title, string $menu, [integer $permissions = BBROLE_NONE], [integer $menu_order = NULL], [string $next_action = NULL])

void action_class ()

void include_file ()

void menu ()

void menu_order ()

void menu_visible ([ $permissions = -1])

void name ()

void next_action ([ $action = NULL])

void permissions ()

void requires_admin ()

void title ()

Variables

string $action_class (line 35)

var: name of the Action* class that should be instantiated

string $menu (line 33)

var: name of the action for the menu

integer $menu_order = NULL (line 41)

var: menu order number (lowest numbers at top of menu)

boolean $menu_visible (line 37)

var: include the entry on the menu

string $name (line 29)

var: name of the action in action= URL

integer $next_action (line 43)

var: name of the action that should follow next (defaults to $this->name)

integer $permissions (line 39)

var: permissions required for this action

string $title (line 31)

var: title for the html page

Methods

Constructor ActionData (line 57)

Create a new ActionData object

ActionData ActionData (string $class, string $file, string $name, string $title, string $menu, [integer $permissions = BBROLE_NONE], [integer $menu_order = NULL], [string $next_action = NULL])

string $class: name of the class to be instantiated
string $file: name of the php file to be included
string $name
string $title
string $menu
integer $permissions: from permissions.php (default: BBROLE_NONE)
integer $menu_order: use negative number for not shown on menu, default: use in order instantiated into ActionListing
string $next_action

action_class (line 103)

void action_class ()

include_file (line 107)

void include_file ()

menu (line 78)

void menu ()

menu_order (line 85)

void menu_order ()

menu_visible (line 89)

void menu_visible ([ $permissions = -1])

$permissions

name (line 70)

void name ()

next_action (line 97)

void next_action ([ $action = NULL])

$action

permissions (line 81)

void permissions ()

requires_admin (line 93)

void requires_admin ()

title (line 74)

void title ()