nextcloud/lib/group/backend.php

156 lines
4.0 KiB
PHP
Raw Normal View History

<?php
/**
* ownCloud
*
* @author Frank Karlitschek
2012-05-26 21:14:24 +04:00
* @copyright 2012 Frank Karlitschek frank@owncloud.org
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
2012-04-13 03:58:53 +04:00
/**
* error code for functions not provided by the group backend
*/
define('OC_GROUP_BACKEND_NOT_IMPLEMENTED', -501);
2012-04-13 03:58:53 +04:00
/**
* actions that user backends can define
*/
define('OC_GROUP_BACKEND_CREATE_GROUP', 0x00000001);
define('OC_GROUP_BACKEND_DELETE_GROUP', 0x00000010);
define('OC_GROUP_BACKEND_ADD_TO_GROUP', 0x00000100);
define('OC_GROUP_BACKEND_REMOVE_FROM_GOUP', 0x00001000);
/**
* Abstract base class for user management
*/
abstract class OC_Group_Backend implements OC_Group_Interface {
2012-04-13 03:58:53 +04:00
protected $possibleActions = array(
OC_GROUP_BACKEND_CREATE_GROUP => 'createGroup',
OC_GROUP_BACKEND_DELETE_GROUP => 'deleteGroup',
OC_GROUP_BACKEND_ADD_TO_GROUP => 'addToGroup',
OC_GROUP_BACKEND_REMOVE_FROM_GOUP => 'removeFromGroup',
);
2012-06-05 16:02:00 +04:00
/**
2012-04-13 03:58:53 +04:00
* @brief Get all supported actions
2012-09-23 04:39:11 +04:00
* @return int bitwise-or'ed actions
2012-04-13 03:58:53 +04:00
*
* Returns the supported actions as int to be
* compared with OC_USER_BACKEND_CREATE_USER etc.
*/
2012-09-07 17:22:01 +04:00
public function getSupportedActions() {
2012-04-13 03:58:53 +04:00
$actions = 0;
2012-09-07 17:22:01 +04:00
foreach($this->possibleActions AS $action => $methodName) {
2012-04-13 03:58:53 +04:00
if(method_exists($this, $methodName)) {
$actions |= $action;
}
}
2012-04-13 03:58:53 +04:00
return $actions;
}
2012-06-05 16:02:00 +04:00
/**
2012-04-13 03:58:53 +04:00
* @brief Check if backend implements actions
2012-09-23 04:39:11 +04:00
* @param int $actions bitwise-or'ed actions
* @return boolean
2012-04-13 03:58:53 +04:00
*
* Returns the supported actions as int to be
* compared with OC_GROUP_BACKEND_CREATE_GROUP etc.
*/
2012-09-07 17:22:01 +04:00
public function implementsActions($actions) {
2012-04-13 03:58:53 +04:00
return (bool)($this->getSupportedActions() & $actions);
}
/**
* @brief is user in group?
2012-09-23 04:39:11 +04:00
* @param string $uid uid of the user
* @param string $gid gid of the group
* @return bool
*
* Checks whether the user is member of a group or not.
*/
2012-09-07 17:22:01 +04:00
public function inGroup($uid, $gid) {
return in_array($gid, $this->getUserGroups($uid));
}
/**
* @brief Get all groups a user belongs to
2012-09-23 04:39:11 +04:00
* @param string $uid Name of the user
* @return array with group names
*
* This function fetches all groups a user belongs to. It does not check
* if the user exists at all.
*/
2012-09-07 17:22:01 +04:00
public function getUserGroups($uid) {
return array();
}
/**
* @brief get a list of all groups
2012-09-23 04:39:11 +04:00
* @param string $search
* @param int $limit
* @param int $offset
* @return array with group names
*
* Returns a list with all groups
*/
public function getGroups($search = '', $limit = -1, $offset = 0) {
return array();
}
/**
* check if a group exists
* @param string $gid
* @return bool
*/
2012-09-07 17:22:01 +04:00
public function groupExists($gid) {
return in_array($gid, $this->getGroups($gid, 1));
}
/**
* @brief get a list of all users in a group
2012-09-23 04:39:11 +04:00
* @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return array with user ids
*/
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) {
return array();
}
2013-02-22 20:21:57 +04:00
/**
* @brief get a list of all display names in a group
* @param string $gid
* @param string $search
* @param int $limit
* @param int $offset
* @return array with display names (value) and user ids (key)
*/
2013-03-04 21:08:41 +04:00
public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) {
$displayNames = array();
2013-02-22 20:21:57 +04:00
$users = $this->usersInGroup($gid, $search, $limit, $offset);
2013-03-04 21:08:41 +04:00
foreach ($users as $user) {
$displayNames[$user] = $user;
2013-02-22 20:21:57 +04:00
}
2013-03-04 21:08:41 +04:00
return $displayNames;
}
}