phpBB API Documentation
Class

acp_modules

class acp_modules

Properties

$module_class
$parent_id
$u_action

Methods

main($id, $mode)

get_module_row($module_id)

Get row for specified module

get_module_infos($module = '', $module_class = false)

Get available module information from module files

make_module_select($select_id = false, $ignore_id = false, $ignore_acl = false, $ignore_nonpost = false, $ignore_emptycat = true, $ignore_noncat = false)

Simple version of jumpbox, just lists modules

get_module_branch($module_id, $type = 'all', $order = 'descending', $include_module = true)

Get module branch

remove_cache_file()

Remove modules cache file

lang_name($module_langname)

Return correct language name

update_module_data($module_data, $run_inline = false)

Update/Add module

move_module($from_module_id, $to_parent_id)

Move module around the tree

delete_module($module_id)

Remove module from tree

move_module_by($module_row, $action = 'move_up', $steps = 1)

Move module position by $steps up/down

Details

at line 38
public main($id, $mode)

Parameters

$id
$mode

at line 508
public get_module_row($module_id)

Get row for specified module

Parameters

$module_id

at line 531
public get_module_infos($module = '', $module_class = false)

Get available module information from module files

Parameters

$module
$module_class

at line 599
public make_module_select($select_id = false, $ignore_id = false, $ignore_acl = false, $ignore_nonpost = false, $ignore_emptycat = true, $ignore_noncat = false)

Simple version of jumpbox, just lists modules

Parameters

$select_id
$ignore_id
$ignore_acl
$ignore_nonpost
$ignore_emptycat
$ignore_noncat

at line 671
public get_module_branch($module_id, $type = 'all', $order = 'descending', $include_module = true)

Get module branch

Parameters

$module_id
$type
$order
$include_module

at line 718
public remove_cache_file()

Remove modules cache file

at line 734
public lang_name($module_langname)

Return correct language name

Parameters

$module_langname

at line 746
public update_module_data($module_data, $run_inline = false)

Update/Add module

Parameters

$module_data
$run_inline

at line 856
public move_module($from_module_id, $to_parent_id)

Move module around the tree

Parameters

$from_module_id
$to_parent_id

at line 939
public delete_module($module_id)

Remove module from tree

Parameters

$module_id

at line 984
public move_module_by($module_row, $action = 'move_up', $steps = 1)

Move module position by $steps up/down

Parameters

$module_row
$action
$steps