nextcloud/lib/private/user/interface.php

82 lines
2.3 KiB
PHP
Raw Normal View History

<?php
/**
2015-02-23 13:28:53 +03:00
* @author Arthur Schiwon <blizzz@owncloud.com>
* @author Christopher Schäpers <kondou@ts.unde.re>
* @author Joas Schilling <nickvergessen@gmx.de>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
2015-02-23 13:28:53 +03:00
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
2015-02-23 13:28:53 +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.
*
2015-02-23 13:28:53 +03:00
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-02-23 13:28:53 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
2015-02-23 13:28:53 +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/>
*
*/
interface OC_User_Interface {
/**
* Check if backend implements actions
* @param int $actions bitwise-or'ed actions
2014-05-11 21:05:28 +04:00
* @return boolean
*
* Returns the supported actions as int to be
* compared with \OC_User_Backend::CREATE_USER etc.
*/
public function implementsActions($actions);
/**
* delete a user
* @param string $uid The username of the user to delete
* @return bool
*/
public function deleteUser($uid);
/**
* Get a list of all users
2014-05-11 21:13:51 +04:00
* @return array an array of all uids
*
* Get a list of all users.
*/
public function getUsers($search = '', $limit = null, $offset = null);
/**
* check if a user exists
* @param string $uid the username
* @return boolean
*/
public function userExists($uid);
/**
* get display name of the user
* @param string $uid user ID of the user
* @return string display name
*/
public function getDisplayName($uid);
/**
* Get a list of all display names
2014-05-11 21:13:51 +04:00
* @return array an array of all displayNames (value) and the corresponding uids (key)
*
* Get a list of all display names and user ids.
*/
public function getDisplayNames($search = '', $limit = null, $offset = null);
/**
* Check if a user list is available or not
* @return boolean if users can be listed or not
*/
public function hasUserListings();
}