phpBB API Documentation
Class

phpbb\groupposition\legend

class legend implements groupposition_interface

Legend group position class

grouplegend is an ascending list 1, 2, ..., n for groups which are displayed. 1 is the first group, n the last. If the value is 0 (self::GROUPDISABLED) the group is not displayed.

Constants

GROUP_DISABLED

Group is not displayed

Methods

__construct(driver_interface $db, user $user)

Constructor

get_group_value($group_id)

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

get_group_count()

Get number of groups, displayed on the legend

add_group($group_id)

Addes a group by group_id

delete_group($group_id, $skip_group = false)

Deletes a group by setting the field to self::GROUP_DISABLED and closing the gap in the list.

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

static  group_type_language($group_type)

Get group type language var

Details

at line 47
public __construct(driver_interface $db, user $user)

Constructor

Parameters

driver_interface $db Database object
user $user User object

at line 60
public get_group_value($group_id)

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

Parameters

$group_id

Exceptions

exception

at line 83
public get_group_count()

Get number of groups, displayed on the legend

at line 98
public add_group($group_id)

Addes a group by group_id

Parameters

$group_id

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

Deletes a group by setting the field to self::GROUP_DISABLED and closing the gap in the list.

Parameters

$group_id
$skip_group

at line 157
public move_up($group_id)

Moves a group up by group_id

Parameters

$group_id

at line 165
public move_down($group_id)

Moves a group down by group_id

Parameters

$group_id

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

Moves a group up/down

Parameters

$group_id
$delta

at line 227
static public group_type_language($group_type)

Get group type language var

Parameters

$group_type