diff options
| author | Nils Adermann <naderman@naderman.de> | 2013-09-25 07:50:22 -0700 |
|---|---|---|
| committer | Nils Adermann <naderman@naderman.de> | 2013-09-25 07:50:22 -0700 |
| commit | 8da31332381b572f8d03c63d4c32a4f32ed8775f (patch) | |
| tree | 1ef729ea3700bae463cd57b672e8de12311fe00d /phpBB/phpbb/groupposition/groupposition_interface.php | |
| parent | 717e2337b9276d9f9680110dff552ea536d0723c (diff) | |
| parent | 645bd127dd53300b7877b779226ac53a4891620c (diff) | |
| download | forums-8da31332381b572f8d03c63d4c32a4f32ed8775f.tar forums-8da31332381b572f8d03c63d4c32a4f32ed8775f.tar.gz forums-8da31332381b572f8d03c63d4c32a4f32ed8775f.tar.bz2 forums-8da31332381b572f8d03c63d4c32a4f32ed8775f.tar.xz forums-8da31332381b572f8d03c63d4c32a4f32ed8775f.zip | |
Merge pull request #1565 from naderman/ticket/11700
[WIP][ticket/11700] Namespaces
Diffstat (limited to 'phpBB/phpbb/groupposition/groupposition_interface.php')
| -rw-r--r-- | phpBB/phpbb/groupposition/groupposition_interface.php | 86 |
1 files changed, 86 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..a568785185 --- /dev/null +++ b/phpBB/phpbb/groupposition/groupposition_interface.php @@ -0,0 +1,86 @@ +<?php +/** +* +* @package phpBB3 +* @copyright (c) 2012 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +namespace phpbb\groupposition; + +/** +* @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 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); +} |