[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / IGroupedUserListAction.class.php

<?php
namespace wcf\data;

/**
 * Default interface for action classes providing grouped user lists.
 * 
 * @author	Alexander Ebert
 * @copyright	2001-2018 WoltLab GmbH
 * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @package	WoltLabSuite\Core\Data
 */
interface IGroupedUserListAction {
	/**
	 * Validates parameters to return a parsed list of users.
	 */
	public function validateGetGroupedUserList();
	
	/**
	 * Returns a parsed list of users.
	 * 
	 * @return	array
	 */
	public function getGroupedUserList();
}
Commit	Line	Data
320f4a6d MW	1	<?php
	2	namespace wcf\data;
	3
	4	/**
	5	* Default interface for action classes providing grouped user lists.
	6	*
	7	* @author Alexander Ebert
c839bd49	8	* @copyright 2001-2018 WoltLab GmbH
320f4a6d	9	* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
e71525e4	10	* @package WoltLabSuite\Core\Data
320f4a6d MW	11	*/
	12	interface IGroupedUserListAction {
	13	/**
	14	* Validates parameters to return a parsed list of users.
	15	*/
	16	public function validateGetGroupedUserList();
	17
	18	/**
	19	* Returns a parsed list of users.
	20	*
	21	* @return array
	22	*/
	23	public function getGroupedUserList();
	24	}