phpBB API Documentation
Class

phpbb\groupposition\teampage

class teampage implements groupposition_interface

Teampage group position class

Teampage position is an ascending list 1, 2, ..., n for items which are displayed. 1 is the first item, n the last.

Constants

GROUP_DISABLED

Group is not displayed

NO_PARENT

No parent item

Methods

__construct(driver_interface $db, user $user, driver_interface $cache)

Constructor

get_group_value($group_id)

Returns the teampage position for a given group, if the group exists.

get_group_values($group_id)

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

get_teampage_value($teampage_id)

Returns the teampage position for a given teampage item, if the item exists.

get_teampage_values($teampage_id)

Returns the teampage row for a given teampage item, if the item exists.

get_group_count()

Get number of groups displayed

add_group($group_id)

Addes a group by group_id

add_group_teampage($group_id, $parent_id)

Adds a group by group_id

add_category_teampage($category_name)

Adds a new category

delete_group($group_id, $skip_group = false)

Deletes a group from the list and closes the gap in the position list.

delete_teampage($teampage_id, $skip_group = false)

Deletes an item from the list and closes the gap in the position list.

move_up($group_id)

Moves a group up by group_id

move_up_teampage($teampage_id)

Moves an item up by teampage_id

move_down($group_id)

Moves a group down by group_id

move_down_teampage($teampage_id)

Moves an item down by teampage_id

move($group_id, $delta)

Moves a group up/down

move_teampage($teampage_id, $delta)

Moves an item up/down

static  group_type_language($group_type)

Get group type language var

Details

at line 58
public __construct(driver_interface $db, user $user, driver_interface $cache)

Constructor

Parameters

driver_interface $db Database object
user $user User object
driver_interface $cache Cache object

at line 72
public get_group_value($group_id)

Returns the teampage position for a given group, if the group exists.

Parameters

$group_id

Exceptions

exception

at line 100
public get_group_values($group_id)

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

Parameters

$group_id

Exceptions

exception

at line 128
public get_teampage_value($teampage_id)

Returns the teampage position for a given teampage item, if the item exists.

Parameters

$teampage_id

Exceptions

exception

at line 153
public get_teampage_values($teampage_id)

Returns the teampage row for a given teampage item, if the item exists.

Parameters

$teampage_id

Exceptions

exception

at line 175
public get_group_count()

Get number of groups displayed

at line 190
public add_group($group_id)

Addes a group by group_id

Parameters

$group_id

at line 202
public add_group_teampage($group_id, $parent_id)

Adds a group by group_id

Parameters

$group_id
$parent_id

at line 266
public add_category_teampage($category_name)

Adds a new category

Parameters

$category_name

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

Deletes a group from the list and closes the gap in the position list.

Parameters

$group_id
$skip_group

at line 326
public delete_teampage($teampage_id, $skip_group = false)

Deletes an item from the list and closes the gap in the position list.

Parameters

$teampage_id
$skip_group

at line 355
public move_up($group_id)

Moves a group up by group_id

Parameters

$group_id

at line 366
public move_up_teampage($teampage_id)

Moves an item up by teampage_id

Parameters

$teampage_id

at line 374
public move_down($group_id)

Moves a group down by group_id

Parameters

$group_id

at line 385
public move_down_teampage($teampage_id)

Moves an item down by teampage_id

Parameters

$teampage_id

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

Moves a group up/down

Parameters

$group_id
$delta

at line 481
public move_teampage($teampage_id, $delta)

Moves an item up/down

Parameters

$teampage_id
$delta

at line 581
static public group_type_language($group_type)

Get group type language var

Parameters

$group_type