2012-07-20 15:09:09 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Arthur Schiwon <blizzz@owncloud.com>
|
|
|
|
* @author Christopher Schäpers <kondou@ts.unde.re>
|
|
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
2015-10-05 21:54:56 +03:00
|
|
|
* @author Lukas Reschke <lukas@owncloud.com>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2016-01-12 17:02:16 +03:00
|
|
|
* @author Robin McCorkell <robin@mccorkell.me.uk>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
2012-07-20 15:09:09 +04:00
|
|
|
*
|
2016-01-12 17:02:16 +03:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
2015-03-26 13:44:34 +03:00
|
|
|
* @license AGPL-3.0
|
2012-07-20 15:09:09 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* 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.
|
2012-07-20 15:09:09 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2012-07-20 15:09:09 +04:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 13:44:34 +03:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2012-07-20 15:09:09 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* 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/>
|
2012-07-20 15:09:09 +04:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 13:37:37 +03:00
|
|
|
|
2012-07-20 15:09:09 +04:00
|
|
|
interface OC_User_Interface {
|
|
|
|
|
|
|
|
/**
|
2015-06-27 21:37:07 +03:00
|
|
|
* Check if backend implements actions
|
|
|
|
* @param int $actions bitwise-or'ed actions
|
|
|
|
* @return boolean
|
|
|
|
*
|
|
|
|
* Returns the supported actions as int to be
|
|
|
|
* compared with \OC_User_Backend::CREATE_USER etc.
|
|
|
|
*/
|
2012-07-20 15:09:09 +04:00
|
|
|
public function implementsActions($actions);
|
|
|
|
|
|
|
|
/**
|
2015-06-27 21:37:07 +03:00
|
|
|
* delete a user
|
|
|
|
* @param string $uid The username of the user to delete
|
|
|
|
* @return bool
|
|
|
|
*/
|
2012-07-20 15:09:09 +04:00
|
|
|
public function deleteUser($uid);
|
|
|
|
|
|
|
|
/**
|
2015-06-27 21:35:47 +03:00
|
|
|
* Get a list of all users
|
|
|
|
*
|
|
|
|
* @param string $search
|
|
|
|
* @param null|int $limit
|
|
|
|
* @param null|int $offset
|
|
|
|
* @return string[] an array of all uids
|
|
|
|
*/
|
2012-09-01 22:49:50 +04:00
|
|
|
public function getUsers($search = '', $limit = null, $offset = null);
|
2012-07-20 15:09:09 +04:00
|
|
|
|
|
|
|
/**
|
2015-06-27 21:37:07 +03:00
|
|
|
* check if a user exists
|
|
|
|
* @param string $uid the username
|
|
|
|
* @return boolean
|
|
|
|
*/
|
2012-07-20 15:09:09 +04:00
|
|
|
public function userExists($uid);
|
|
|
|
|
2013-01-29 23:09:41 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* get display name of the user
|
2014-05-12 00:51:30 +04:00
|
|
|
* @param string $uid user ID of the user
|
|
|
|
* @return string display name
|
2013-01-29 23:09:41 +04:00
|
|
|
*/
|
|
|
|
public function getDisplayName($uid);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a list of all display names and user ids.
|
2015-06-27 21:35:47 +03:00
|
|
|
*
|
|
|
|
* @param string $search
|
|
|
|
* @param string|null $limit
|
|
|
|
* @param string|null $offset
|
|
|
|
* @return array an array of all displayNames (value) and the corresponding uids (key)
|
2013-01-29 23:09:41 +04:00
|
|
|
*/
|
|
|
|
public function getDisplayNames($search = '', $limit = null, $offset = null);
|
|
|
|
|
2013-02-12 01:01:52 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Check if a user list is available or not
|
2013-02-12 01:01:52 +04:00
|
|
|
* @return boolean if users can be listed or not
|
|
|
|
*/
|
|
|
|
public function hasUserListings();
|
2013-08-18 13:02:08 +04:00
|
|
|
}
|