Move \OCP to PSR-4

1 files changed, 109 insertions, 0 deletions

diff --git a/lib/public/IGroup.php b/lib/public/IGroup.php
new file mode 100644
index 00000000000..02f2ef201fd
--- /dev/null
+++ b/lib/public/IGroup.php
@@ -0,0 +1,109 @@
+<?php
+/**
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCP;
+
+/**
+ * Interface IGroup
+ *
+ * @package OCP
+ * @since 8.0.0
+ */
+interface IGroup {
+	/**
+	 * @return string
+	 * @since 8.0.0
+	 */
+	public function getGID();
+
+	/**
+	 * get all users in the group
+	 *
+	 * @return \OCP\IUser[]
+	 * @since 8.0.0
+	 */
+	public function getUsers();
+
+	/**
+	 * check if a user is in the group
+	 *
+	 * @param \OCP\IUser $user
+	 * @return bool
+	 * @since 8.0.0
+	 */
+	public function inGroup($user);
+
+	/**
+	 * add a user to the group
+	 *
+	 * @param \OCP\IUser $user
+	 * @since 8.0.0
+	 */
+	public function addUser($user);
+
+	/**
+	 * remove a user from the group
+	 *
+	 * @param \OCP\IUser $user
+	 * @since 8.0.0
+	 */
+	public function removeUser($user);
+
+	/**
+	 * search for users in the group by userid
+	 *
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return \OCP\IUser[]
+	 * @since 8.0.0
+	 */
+	public function searchUsers($search, $limit = null, $offset = null);
+
+	/**
+	 * returns the number of users matching the search string
+	 *
+	 * @param string $search
+	 * @return int|bool
+	 * @since 8.0.0
+	 */
+	public function count($search = '');
+
+	/**
+	 * search for users in the group by displayname
+	 *
+	 * @param string $search
+	 * @param int $limit
+	 * @param int $offset
+	 * @return \OCP\IUser[]
+	 * @since 8.0.0
+	 */
+	public function searchDisplayName($search, $limit = null, $offset = null);
+
+	/**
+	 * delete the group
+	 *
+	 * @return bool
+	 * @since 8.0.0
+	 */
+	public function delete();
+}