| Property | Type | Description | |
|---|---|---|---|
| $acl_forum_id | |||
| $active_module | |||
| $active_module_row_id | |||
| $include_path | |||
| $module_ary | |||
| $p_class | |||
| $p_id | |||
| $p_mode | |||
| $p_name | |||
| $p_parent |
| Method | Description | |
|---|---|---|
| add_mod_info ( $module_class ) | Add custom MOD info language file | |
| adjust_url ( string $url_extra ) | Appending url parameter to the currently active module. | |
| assign_tpl_vars ( $module_url ) | Build navigation structure | |
| build_tree ( &$modules, &$parents ) | Build true binary tree from given array Not in use | |
| display ( $page_title, $display_online_list = false ) | Display module | |
| get_branch ( $left_id, $right_id, $remaining ) | Get tree branch | |
| get_page_title ( ) | Returns the desired page title | |
| get_parents ( $parent_id, $left_id, $right_id, &$all_parents ) | Get parents | |
| get_tpl_name ( ) | Returns desired template name | |
| is_active ( $id, $mode = false ) | Check if a module is active | |
| list_modules ( $p_class ) | List modules | |
| load ( string $class, string $name, string $mode = false ) | Load module as the current active one without the need for registering it | |
| load_active ( string | false $mode = false, string | false $module_url = false, boolean $execute_module = true ) | Loads currently active module | |
| loaded ( string $module_basename, mixed $module_mode = false ) : boolean | Check if a certain main module is accessible/loaded By giving the module mode you are able to additionally check for only one mode within the main module | |
| module_auth ( $module_auth, $forum_id ) | Check module authorisation. | |
| module_auth_self ( $module_auth ) | Check module authorisation. | |
| p_master ( $include_path = false ) | Constuctor Set module include path | |
| set_active ( $id = false, $mode = false ) | Set active module | |
| set_custom_include_path ( string $include_path ) | Set custom include path for modules Schema for inclusion is include_path . modulebase | |
| set_display ( $id, $mode = false, $display = true ) | Toggle whether this module will be displayed or not |
| Method | Description | |
|---|---|---|
| get_module_identifier ( string $basename ) : string | If the basename contains a \ we don't use that for the URL. | |
| get_short_name ( string $basename ) : string | Retrieve shortened module basename for legacy basenames (with xcp_ prefix) | |
| is_full_class ( string $basename ) : boolean | Checks whether the given module basename is a correct class name |
| public add_mod_info ( $module_class ) |
| public adjust_url ( string $url_extra ) | ||
| $url_extra | string | Extra url parameters, e.g.: &u=$user_id |
| public build_tree ( &$modules, &$parents ) |
| protected get_module_identifier ( string $basename ) : string | ||
| $basename | string | Basename of the module |
| return | string | Identifier that should be used for module link creation |
| public get_parents ( $parent_id, $left_id, $right_id, &$all_parents ) |
| protected get_short_name ( string $basename ) : string | ||
| $basename | string | A module basename |
| return | string | The basename if it starts with phpbb_ or the basename with the current p_class (e.g. acp_) stripped. |
| protected is_full_class ( string $basename ) : boolean | ||
| $basename | string | A module basename |
| return | boolean | True if the basename starts with phpbb_ or (x)cp_, false otherwise |
| public list_modules ( $p_class ) |
| public load_active ( string | false $mode = false, string | false $module_url = false, boolean $execute_module = true ) | ||
| $mode | string | false | mode, as passed through to the module |
| $module_url | string | false | If supplied, we use this module url |
| $execute_module | boolean | If true, at the end we execute the main method for the new instance |
| public loaded ( string $module_basename, mixed $module_mode = false ) : boolean | ||
| $module_basename | string | The module base name, for example logs, reports, main (for the mcp). |
| $module_mode | mixed | The module mode to check. If provided the mode will be checked in addition for presence. |
| return | boolean | Returns true if module is loaded and accessible, else returns false |
| static public module_auth ( $module_auth, $forum_id ) |
| public module_auth_self ( $module_auth ) |
| public p_master ( $include_path = false ) |
| public set_custom_include_path ( string $include_path ) | ||
| $include_path | string | include path to be used. |
| public set_display ( $id, $mode = false, $display = true ) |