From ff7465e75f129d23a0f9f4fd6a1c556ec2b7bb13 Mon Sep 17 00:00:00 2001
From: Joas Schilling <nickvergessen@gmx.de>
Date: Tue, 13 Nov 2012 11:22:30 +0100
Subject: [ticket/10411] New class interface and unit tests for legend and
 teampage

PHPBB3-10411
---
 phpBB/includes/groupposition/interface.php | 92 ++++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)
 create mode 100644 phpBB/includes/groupposition/interface.php

(limited to 'phpBB/includes/groupposition/interface.php')

diff --git a/phpBB/includes/groupposition/interface.php b/phpBB/includes/groupposition/interface.php
new file mode 100644
index 0000000000..b5d8a6b097
--- /dev/null
+++ b/phpBB/includes/groupposition/interface.php
@@ -0,0 +1,92 @@
+<?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	null
+	*/
+	public function add_group($group_id);
+
+	/**
+	* Deletes a group by setting the field to self::GROUP_DISABLED and closing the gap in the list.
+	*
+	* @param	int		$group_id		group_id of the group to be deleted
+	* @param	bool	$skip_group		Skip setting the group to GROUP_DISABLED, to save the query, when you need to update it anyway.
+	* @return	null
+	*/
+	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	null
+	*/
+	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	null
+	*/
+	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	null
+	*/
+	public function move($group_id, $delta);
+
+	/**
+	* Error
+	*
+	* @param	string		$message	Error message to display
+	* @return	null
+	*/
+	public function error($message);
+}
-- 
cgit v1.2.1