diff options
| author | Nils Adermann <naderman@naderman.de> | 2013-07-14 12:25:28 -0400 |
|---|---|---|
| committer | Nils Adermann <naderman@naderman.de> | 2013-07-14 12:25:28 -0400 |
| commit | b81613e5e57fd208e832637b6886abf9ec806c4b (patch) | |
| tree | 5dfec7ded65655a0cb1ca486d5c58698dd0cc5c2 /phpBB/phpbb/groupposition/groupposition_interface.php | |
| parent | c15bde161a93fc2abc48cacd7e5a71c682880e52 (diff) | |
| download | forums-b81613e5e57fd208e832637b6886abf9ec806c4b.tar forums-b81613e5e57fd208e832637b6886abf9ec806c4b.tar.gz forums-b81613e5e57fd208e832637b6886abf9ec806c4b.tar.bz2 forums-b81613e5e57fd208e832637b6886abf9ec806c4b.tar.xz forums-b81613e5e57fd208e832637b6886abf9ec806c4b.zip | |
[ticket/11700] With namespaces interface will no longer be a valid classname
PHPBB3-11700
Diffstat (limited to 'phpBB/phpbb/groupposition/groupposition_interface.php')
| -rw-r--r-- | phpBB/phpbb/groupposition/groupposition_interface.php | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/phpBB/phpbb/groupposition/groupposition_interface.php b/phpBB/phpbb/groupposition/groupposition_interface.php new file mode 100644 index 0000000000..0f29984588 --- /dev/null +++ b/phpBB/phpbb/groupposition/groupposition_interface.php @@ -0,0 +1,84 @@ +<?php +/** +* +* @package phpBB3 +* @copyright (c) 2012 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +/** +* Interface to manage group positions in various places of phpbb +* +* The interface provides simple methods to add, delete and move a group +* +* @package phpBB3 +*/ +interface phpbb_groupposition_groupposition_interface +{ + /** + * Returns the value for a given group, if the group exists. + * @param int $group_id group_id of the group to be selected + * @return int position of the group + */ + public function get_group_value($group_id); + + /** + * Get number of groups displayed + * + * @return int value of the last item displayed + */ + public function get_group_count(); + + /** + * Addes a group by group_id + * + * @param int $group_id group_id of the group to be added + * @return bool True if the group was added successfully + */ + public function add_group($group_id); + + /** + * Deletes a group by group_id + * + * @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. + * @return bool True if the group was deleted successfully + */ + public function delete_group($group_id, $skip_group = false); + + /** + * Moves a group up by group_id + * + * @param int $group_id group_id of the group to be moved + * @return bool True if the group was moved successfully + */ + public function move_up($group_id); + + /** + * Moves a group down by group_id + * + * @param int $group_id group_id of the group to be moved + * @return bool True if the group was moved successfully + */ + public function move_down($group_id); + + /** + * Moves a group up/down + * + * @param int $group_id group_id of the group to be moved + * @param int $delta number of steps: + * - positive = move up + * - negative = move down + * @return bool True if the group was moved successfully + */ + public function move($group_id, $delta); +} |