phpBB API Documentation
Interface

phpbb\groupposition\groupposition_interface

interface groupposition_interface

Interface to manage group positions in various places of phpbb

The interface provides simple methods to add, delete and move a group

Methods

get_group_value($group_id)

Returns the value for a given group, if the group exists.

get_group_count()

Get number of groups displayed

add_group($group_id)

Addes a group by group_id

delete_group($group_id, $skip_group = false)

Deletes a group by group_id

move_up($group_id)

Moves a group up by group_id

move_down($group_id)

Moves a group down by group_id

move($group_id, $delta)

Moves a group up/down

Details

at line 28
public get_group_value($group_id)

Returns the value for a given group, if the group exists.

Parameters

$group_id

at line 35
public get_group_count()

Get number of groups displayed

at line 43
public add_group($group_id)

Addes a group by group_id

Parameters

$group_id

at line 52
public delete_group($group_id, $skip_group = false)

Deletes a group by group_id

Parameters

$group_id
$skip_group

at line 60
public move_up($group_id)

Moves a group up by group_id

Parameters

$group_id

at line 68
public move_down($group_id)

Moves a group down by group_id

Parameters

$group_id

at line 79
public move($group_id, $delta)

Moves a group up/down

Parameters

$group_id
$delta