diff options
| author | Andreas Fischer <bantu@phpbb.com> | 2013-10-10 23:39:09 +0200 |
|---|---|---|
| committer | Andreas Fischer <bantu@phpbb.com> | 2013-10-10 23:39:09 +0200 |
| commit | 353ac33d5cea1752047779eb8c70c7ce3a64b6c8 (patch) | |
| tree | 76e08c4e16c68256700506b7111c3cbb547dc877 /phpBB/phpbb/groupposition/groupposition_interface.php | |
| parent | 0228424983e35badc779923a1f0398fc3ab7c8b2 (diff) | |
| parent | b59131f558a6d0fe4c836e2658152c8698f0cd22 (diff) | |
| download | forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar.gz forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar.bz2 forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.tar.xz forums-353ac33d5cea1752047779eb8c70c7ce3a64b6c8.zip | |
Merge remote-tracking branch 'phpbb/develop' into ticket/11621
* phpbb/develop: (542 commits)
[ticket/11901] Pass empty string as relative_url for non-local magic URL.
[ticket/11898] Correct adm_relative_path created by installer
[ticket/11898] Correct admin S_LOGIN_ACTION
[ticket/11892] Fix undefined variables: to_forum_id & to_topic_id
[ticket/11890] Fix untranslated string when deleting posts through MCP.
[ticket/11895] Fix undefined $forum_id
[ticket/10383] Update the results without the overlay popup.
[ticket/10383] Make the content transitions smoother.
[ticket/10383] AJAXify poll voting
[ticket/11888] Update default search backend in namespaces migration
[ticket/11739] Rename “Remember Me” login keys module
[ticket/11893] Remove unnecessary <fieldset> causing a large font size
[ticket/11894] Fix typo in "Delete post" option
[ticket/11888] Use \phpbb\search\fulltext_native as search backend config
[ticket/11608] Mark failed test as incomplete for mysql search backend
[ticket/11608] Update search backend class names to namespaces
[ticket/11608] Move markIncomplete to search backends test
[ticket/11608] Rename base search test class file
[ticket/11608] Remove suffix test from base class
[ticket/11608] Mark postgres search not found test as incomplete
...
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); +} |