diff options
| author | Nathan Guse <nathaniel.guse@gmail.com> | 2013-07-13 22:47:41 -0700 |
|---|---|---|
| committer | Nathan Guse <nathaniel.guse@gmail.com> | 2013-07-13 22:47:41 -0700 |
| commit | 1e37d97909ccf52b08e2a809ea8a9365c824d8de (patch) | |
| tree | a260c846cb47713e72de11cfb9803d981ea6faaf /phpBB/phpbb/groupposition/interface.php | |
| parent | 4186c05bb4b97374392031a10b796e77b857afaf (diff) | |
| parent | 7030578bbe9e11c18b5becaf8b06e670e3c2e3cd (diff) | |
| download | forums-1e37d97909ccf52b08e2a809ea8a9365c824d8de.tar forums-1e37d97909ccf52b08e2a809ea8a9365c824d8de.tar.gz forums-1e37d97909ccf52b08e2a809ea8a9365c824d8de.tar.bz2 forums-1e37d97909ccf52b08e2a809ea8a9365c824d8de.tar.xz forums-1e37d97909ccf52b08e2a809ea8a9365c824d8de.zip | |
Merge pull request #1559 from naderman/ticket/11698
[WIP][ticket/11698] Moving all autoloadable files to phpbb/
Diffstat (limited to 'phpBB/phpbb/groupposition/interface.php')
| -rw-r--r-- | phpBB/phpbb/groupposition/interface.php | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/phpBB/phpbb/groupposition/interface.php b/phpBB/phpbb/groupposition/interface.php new file mode 100644 index 0000000000..eacc04e1a4 --- /dev/null +++ b/phpBB/phpbb/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_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); +} |