Docs For Class docbook

Description

Handles the content of the book, editing, approving, navigation, etc.

Located in /templates/docbook/docbook.php (line 32)

WebObject
   |
   --docbook

Method Summary

void add_accessright_vars ()

void get_button_vars ()

void get_edit_rights ()

void init ()

void is_admin ()

void lang_match ( $lang_list)

void node_match ( $node_list)

void onParse ()

void onRender ()

void on_set_lng ( $event_args)

void on_set_mode ( $event_args)

void on_set_node ( $event_args)

void on_set_node_id ( $event_args)

Methods

add_accessright_vars (line 92)

add variables about access rights of the user

void add_accessright_vars ()

get_button_vars (line 151)

Returns an associative array with keys 'edit', 'approve' and 'admin' and whith values 'true' or 'false', according to the access rights of the current user.

void get_button_vars ()

get_edit_rights (line 201)

Reads the user edit rights file 'admin/access_rights/username'

which contains lines like this: allow:edit,approve:node_path_1,node_path_2:lng1,lng2 deny:approve:node_path_3,node_path_4:lng2 After matching the current node and language with these lines, returns array($edit, $approve) with values 'true' or 'false'.

void get_edit_rights ()

init (line 34)

void init ()

is_admin (line 104)

Returns 'true' if the current user is an admin for the current book, otherwise returns 'false'.

void is_admin ()

lang_match (line 262)

Returns true if one of the language ids in the list matches the current language, otherwise returns false. The lang_list is a comma separated list of languages, or 'ALL'.

'ALL' matches any language.

void lang_match ( $lang_list)

$lang_list

node_match (line 243)

Returns true if one of the node_path expressions in the list matches the current node path, otherwise returns false.

The node_list is a comma separated list of node_path expressions (which are actually regular expressions), or is the string 'ALL'. 'ALL' matches any node path.

void node_match ( $node_list)

$node_list

onParse (line 82)

void onParse ()

onRender (line 121)

void onRender ()

on_set_lng (line 71)

void on_set_lng ( $event_args)

$event_args

on_set_mode (line 56)

void on_set_mode ( $event_args)

$event_args

on_set_node (line 43)

void on_set_node ( $event_args)

$event_args

on_set_node_id (line 49)

void on_set_node_id ( $event_args)

$event_args