[ Index ]

PHP Cross Reference of phpBB-3.3.0-deutsch

title

Body

[close]

/phpbb/groupposition/ -> legend.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: 243 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

legend:: (9 methods):
  __construct()
  get_group_value()
  get_group_count()
  add_group()
  delete_group()
  move_up()
  move_down()
  move()
  group_type_language()


Class: legend  - X-Ref

Legend group position class

group_legend 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::GROUP_DISABLED) the group is not displayed.
__construct(\phpbb\db\driver\driver_interface $db, \phpbb\user $user)   X-Ref
Constructor

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

get_group_value($group_id)   X-Ref
Returns the group_legend 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_count()   X-Ref
Get number of groups, displayed on the legend

return: int        value of the last item displayed

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


delete_group($group_id, $skip_group = false)   X-Ref
Deletes a group by setting the field to self::GROUP_DISABLED and closing the gap in the 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.

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


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


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


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