docbook Class Reference

Inheritance diagram for docbook:

Inheritance graph
[legend]
List of all members.

Detailed Description

Definition at line 32 of file docbook.php.

Public Member Functions

 init ()
 on_set_node ($event_args)
 on_set_node_id ($event_args)
 on_set_mode ($event_args)
 on_set_lng ($event_args)
 onParse ()
 add_accessright_vars ()
 add variables about access rights of the user
 is_admin ()
 Returns 'true' if the current user is an admin for the current book, otherwise returns 'false'.
 onRender ()
 get_button_vars ()
 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.
 get_edit_rights ()
 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'.
 node_match ($node_list)
 Returns true if one of the node_path expressions in the list matches the current node path, otherwise returns false.
 lang_match ($lang_list)
 Returns true if one of the language ids in the list matches the current language, otherwise returns false.


Member Function Documentation

docbook::init (  ) 

Definition at line 34 of file docbook.php.

docbook::on_set_node ( event_args  ) 

Definition at line 43 of file docbook.php.

References $event_args.

docbook::on_set_node_id ( event_args  ) 

Definition at line 49 of file docbook.php.

References $event_args, $path, and process_index().

docbook::on_set_mode ( event_args  ) 

Definition at line 56 of file docbook.php.

References $event_args, $mode, get_button_vars(), and T_().

docbook::on_set_lng ( event_args  ) 

Definition at line 71 of file docbook.php.

References $book_id, $event_args, $lng, and main::get_book_title().

docbook::onParse (  ) 

Definition at line 82 of file docbook.php.

References $mode, and add_accessright_vars().

docbook::add_accessright_vars (  ) 

add variables about access rights of the user

Definition at line 92 of file docbook.php.

References get_edit_rights(), and is_admin().

Referenced by get_button_vars(), and onParse().

docbook::is_admin (  ) 

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

Definition at line 104 of file docbook.php.

References $arr_books, $book_id, $book_list, $record, and shell().

Referenced by add_accessright_vars(), and get_button_vars().

docbook::onRender (  ) 

Definition at line 121 of file docbook.php.

References get_arr_navigation(), get_button_vars(), get_node_state(), locked_by_somebody(), and T_().

docbook::get_button_vars (  ) 

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.

Definition at line 151 of file docbook.php.

References add_accessright_vars(), and is_admin().

Referenced by on_set_mode(), and onRender().

docbook::get_edit_rights (  ) 

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

Definition at line 201 of file docbook.php.

References $book_id, lang_match(), and node_match().

Referenced by add_accessright_vars().

docbook::node_match ( node_list  ) 

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.

Definition at line 243 of file docbook.php.

Referenced by get_edit_rights().

docbook::lang_match ( lang_list  ) 

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.

Definition at line 262 of file docbook.php.

References $lng.

Referenced by get_edit_rights().


Generated on Wed Jan 9 08:27:36 2008 for DokBookWiki by  doxygen 1.5.2