[ Index ]

PHP Cross Reference of phpBB-3.3.0-deutsch

title

Body

[close]

/phpbb/groupposition/ -> teampage.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 597 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

teampage:: (18 methods):
  __construct()
  get_group_value()
  get_group_values()
  get_teampage_value()
  get_teampage_values()
  get_group_count()
  add_group()
  add_group_teampage()
  add_category_teampage()
  delete_group()
  delete_teampage()
  move_up()
  move_up_teampage()
  move_down()
  move_down_teampage()
  move()
  move_teampage()
  group_type_language()


Class: teampage  - X-Ref

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.
__construct(\phpbb\db\driver\driver_interface $db, \phpbb\user $user, \phpbb\cache\driver\driver_interface $cache)   X-Ref
Constructor

param: \phpbb\db\driver\driver_interface                $db        Database object
param: \phpbb\user                        $user    User object
param: \phpbb\cache\driver\driver_interface    $cache    Cache object

get_group_value($group_id)   X-Ref
Returns the teampage position for a given group, if the group exists.

return: int            position of the group
param: int        $group_id    group_id of the group to be selected

get_group_values($group_id)   X-Ref
Returns the row for a given group, if the group exists.

return: array            Data row of the group
param: int        $group_id    group_id of the group to be selected

get_teampage_value($teampage_id)   X-Ref
Returns the teampage position for a given teampage item, if the item exists.

return: int            Teampage position of the item
param: int        $teampage_id    Teampage_id of the selected item

get_teampage_values($teampage_id)   X-Ref
Returns the teampage row for a given teampage item, if the item exists.

return: array            Teampage row of the item
param: int        $teampage_id    Teampage_id of the selected item

get_group_count()   X-Ref
{@inheritDoc}


add_group($group_id)   X-Ref
{@inheritDoc}


add_group_teampage($group_id, $parent_id)   X-Ref
Adds a group by group_id

return: bool        True if the group was added successfully
param: int        $group_id    group_id of the group to be added
param: int        $parent_id    Teampage ID of the parent item

add_category_teampage($category_name)   X-Ref
Adds a new category

return: bool        True if the category was added successfully
param: string    $category_name    Name of the category to be added

delete_group($group_id, $skip_group = false)   X-Ref
Deletes a group from the list and closes the gap in the position list.

return: bool        True if the group was deleted successfully
param: int        $group_id        group_id of the group to be deleted
param: bool    $skip_group        Skip setting the value for this group, to save the query, when you need to update it anyway.

delete_teampage($teampage_id, $skip_group = false)   X-Ref
Deletes an item from the list and closes the gap in the position list.

return: bool        True if the item was deleted successfully
param: int        $teampage_id    teampage_id of the item to be deleted
param: bool    $skip_group        Skip setting the group to GROUP_DISABLED, to save the query, when you need to update it anyway.

move_up($group_id)   X-Ref
{@inheritDoc}


move_up_teampage($teampage_id)   X-Ref
Moves an item up by teampage_id

return: bool        True if the group was moved successfully
param: int        $teampage_id    teampage_id of the item to be move

move_down($group_id)   X-Ref
{@inheritDoc}


move_down_teampage($teampage_id)   X-Ref
Moves an item down by teampage_id

return: bool        True if the group was moved successfully
param: int        $teampage_id    teampage_id of the item to be moved

move($group_id, $delta)   X-Ref
{@inheritDoc}


move_teampage($teampage_id, $delta)   X-Ref
Moves an item up/down

return: bool        True if the group was moved successfully
param: int        $teampage_id    teampage_id of the item to be moved
param: int        $delta        number of steps:

group_type_language($group_type)   X-Ref
Get group type language var

return: string        name of the language variable for the given group-type.
param: int        $group_type    group_type from the groups-table



Generated: Tue Apr 7 19:44:41 2020 Cross-referenced by PHPXref 0.7.1