[ Index ]

PHP Cross Reference of phpBB-3.3.0-deutsch

title

Body

[close]

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

Defines 1 class

groupposition_interface:: (7 methods):
  get_group_value()
  get_group_count()
  add_group()
  delete_group()
  move_up()
  move_down()
  move()


Interface: groupposition_interface  - X-Ref

Interface to manage group positions in various places of phpbb

The interface provides simple methods to add, delete and move a group
get_group_value($group_id)   X-Ref
Returns the value 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

return: int        value of the last item displayed

add_group($group_id)   X-Ref
Addes 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

delete_group($group_id, $skip_group = false)   X-Ref
Deletes a group by group_id

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
Moves a group up by group_id

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

move_down($group_id)   X-Ref
Moves a group down by group_id

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

move($group_id, $delta)   X-Ref
Moves a group up/down

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



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