Skip to content
Snippets Groups Projects
Select Git revision
  • b296328c61494eaa21f054838ebbef038558aa11
  • master default protected
2 results

interface.php

Blame
  • user avatar
    Robin Appelman authored
    4131b205
    History
    interface.php 2.19 KiB
    <?php
    
    /**
     * ownCloud - group interface
     *
     * @author Arthur Schiwon
     * @copyright 2012 Arthur Schiwon blizzz@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/>.
     *
     */
    
    interface OC_Group_Interface {
    	/**
    	* @brief 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_GROUP_BACKEND_CREATE_GROUP etc.
    	*/
    	public function implementsActions($actions);
    
    	/**
    	 * @brief is user in group?
    	 * @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.
    	 */
    	public function inGroup($uid, $gid);
    
    	/**
    	 * @brief Get all groups a user belongs to
    	 * @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.
    	 */
    	public function getUserGroups($uid);
    
    	/**
    	 * @brief get a list of all groups
    	 * @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);
    
    	/**
    	 * check if a group exists
    	 * @param string $gid
    	 * @return bool
    	 */
    	public function groupExists($gid);
    
    	/**
    	 * @brief get a list of all users in a group
    	 * @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);
    
    }