]> source.dussan.org Git - nextcloud-server.git/commitdiff
move methods to correct interface, deprecate private interface
authorJörn Friedrich Dreyer <jfd@butonic.de>
Thu, 14 Jan 2016 13:28:03 +0000 (14:28 +0100)
committerJörn Friedrich Dreyer <jfd@butonic.de>
Thu, 14 Jan 2016 13:28:03 +0000 (14:28 +0100)
lib/private/group/backend.php
lib/private/group/interface.php
lib/private/user.php
lib/private/user/backend.php
lib/private/user/interface.php
lib/private/user/user.php
lib/public/groupinterface.php
lib/public/userinterface.php

index 29f24fb3070697eba6c678da79b420fc44f51c8f..ed059f63aaf512f14e091501a3fe3572f48e2ee8 100644 (file)
@@ -53,7 +53,7 @@ define('OC_GROUP_BACKEND_COUNT_USERS',       0x00100000);
 /**
  * Abstract base class for user management
  */
-abstract class OC_Group_Backend implements OC_Group_Interface {
+abstract class OC_Group_Backend implements \OCP\GroupInterface {
        /**
         * error code for functions not provided by the group backend
         */
index 5c7d4cf0b39062524f498576de62c6a34220c4df..240a50fe9610ea6a81c9ccbf225e35acdcd5fe0e 100644 (file)
  *
  */
 
-interface OC_Group_Interface {
-       /**
-       * 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);
-
-       /**
-        * 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);
-
-       /**
-        * Get all groups a user belongs to
-        * @param string $uid Name of the user
-        * @return array an array of 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);
-
-       /**
-        * get a list of all groups
-        * @param string $search
-        * @param int $limit
-        * @param int $offset
-        * @return array an array of 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);
-
-       /**
-        * get a list of all users in a group
-        * @param string $gid
-        * @param string $search
-        * @param int $limit
-        * @param int $offset
-        * @return array an array of user ids
-        */
-       public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0);
-
-}
+/**
+ * Interface OC_Group_Interface
+ * @deprecated use the public \OCP\GroupInterface instead
+ */
+interface OC_Group_Interface extends \OCP\GroupInterface {}
index 7f42374e2e3470d93458abbdb5119352459dce96..7d1f21cc409501abcd3afde429246f32ca40f480 100644 (file)
@@ -76,13 +76,13 @@ class OC_User {
        /**
         * Adds the backend to the list of used backends
         *
-        * @param string|OC_User_Interface $backend default: database The backend to use for user management
+        * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
         * @return bool
         *
         * Set the User Authentication Module
         */
        public static function useBackend($backend = 'database') {
-               if ($backend instanceof OC_User_Interface) {
+               if ($backend instanceof \OCP\UserInterface) {
                        self::$_usedBackends[get_class($backend)] = $backend;
                        \OC::$server->getUserManager()->registerBackend($backend);
                } else {
index 075ff9e6e24b4fc255ae378ac4e492de5c4ca1b1..c8e3577d1120a35c5559b8e521e62ba0b30d6ed8 100644 (file)
@@ -63,7 +63,7 @@ define('OC_USER_BACKEND_COUNT_USERS',       1 << 28);
  * Abstract base class for user management. Provides methods for querying backend
  * capabilities.
  */
-abstract class OC_User_Backend implements OC_User_Interface {
+abstract class OC_User_Backend implements \OCP\UserInterface {
        /**
         * error code for functions not provided by the user backend
         */
index c935a92820bc6714d8eafd676a65f4027dcc551d..b487a046c72060aed464e360b9f0acc2cb2c9be8 100644 (file)
  *
  */
 
-interface OC_User_Interface {
-
-       /**
-        * 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.
-        */
-       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
-        *
-        * @param string $search
-        * @param null|int $limit
-        * @param null|int $offset
-        * @return string[] an array of all uids
-        */
-       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 and user ids.
-        *
-        * @param string $search
-        * @param string|null $limit
-        * @param string|null $offset
-        * @return array an array of all displayNames (value) and the corresponding uids (key)
-        */
-       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();
-}
+/**
+ * Interface OC_User_Interface
+ * @deprecated use the public \OCP\UserInterface instead
+ */
+interface OC_User_Interface extends \OCP\UserInterface {}
index c6c608703eb2c17899d04e87a47aa84e655ed3b6..c2a6acc766448cd6337244decdddd3de97b04dc9 100644 (file)
@@ -35,6 +35,7 @@ use OCP\IImage;
 use OCP\IURLGenerator;
 use OCP\IUser;
 use OCP\IConfig;
+use OCP\UserInterface;
 
 class User implements IUser {
        /** @var string $uid */
@@ -43,7 +44,7 @@ class User implements IUser {
        /** @var string $displayName */
        private $displayName;
 
-       /** @var \OC_User_Interface $backend */
+       /** @var UserInterface $backend */
        private $backend;
 
        /** @var bool $enabled */
@@ -69,7 +70,7 @@ class User implements IUser {
 
        /**
         * @param string $uid
-        * @param \OC_User_Interface $backend
+        * @param UserInterface $backend
         * @param \OC\Hooks\Emitter $emitter
         * @param IConfig|null $config
         * @param IURLGenerator $urlGenerator
index dbadbfb0dcb1eec472a34f2d75c9905547c36fd3..a4acc78e856eec48bd4da5cf4e47b10a606db827 100644 (file)
@@ -37,4 +37,70 @@ namespace OCP;
  * @package OCP
  * @since 4.5.0
  */
-interface GroupInterface extends \OC_Group_Interface {}
+interface GroupInterface {
+
+       /**
+        * Check if backend implements actions
+        * @param int $actions bitwise-or'ed actions
+        * @return boolean
+        * @since 4.5.0
+        *
+        * Returns the supported actions as int to be
+        * compared with \OC_Group_Backend::CREATE_GROUP etc.
+        */
+       public function implementsActions($actions);
+
+       /**
+        * is user in group?
+        * @param string $uid uid of the user
+        * @param string $gid gid of the group
+        * @return bool
+        * @since 4.5.0
+        *
+        * Checks whether the user is member of a group or not.
+        */
+       public function inGroup($uid, $gid);
+
+       /**
+        * Get all groups a user belongs to
+        * @param string $uid Name of the user
+        * @return array an array of group names
+        * @since 4.5.0
+        *
+        * This function fetches all groups a user belongs to. It does not check
+        * if the user exists at all.
+        */
+       public function getUserGroups($uid);
+
+       /**
+        * get a list of all groups
+        * @param string $search
+        * @param int $limit
+        * @param int $offset
+        * @return array an array of group names
+        * @since 4.5.0
+        *
+        * Returns a list with all groups
+        */
+       public function getGroups($search = '', $limit = -1, $offset = 0);
+
+       /**
+        * check if a group exists
+        * @param string $gid
+        * @return bool
+        * @since 4.5.0
+        */
+       public function groupExists($gid);
+
+       /**
+        * get a list of all users in a group
+        * @param string $gid
+        * @param string $search
+        * @param int $limit
+        * @param int $offset
+        * @return array an array of user ids
+        * @since 4.5.0
+        */
+       public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0);
+
+}
index 22f8d02c4f1a43bdfb200a0015d84172706e87fe..6d048cb7a03dea90915ab1f8f2006136881d4586 100644 (file)
@@ -37,4 +37,70 @@ namespace OCP;
  * @package OCP
  * @since 4.5.0
  */
-interface UserInterface extends \OC_User_Interface {}
+interface UserInterface {
+
+       /**
+        * 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.
+        * @since 4.5.0
+        */
+       public function implementsActions($actions);
+
+       /**
+        * delete a user
+        * @param string $uid The username of the user to delete
+        * @return bool
+        * @since 4.5.0
+        */
+       public function deleteUser($uid);
+
+       /**
+        * Get a list of all users
+        *
+        * @param string $search
+        * @param null|int $limit
+        * @param null|int $offset
+        * @return string[] an array of all uids
+        * @since 4.5.0
+        */
+       public function getUsers($search = '', $limit = null, $offset = null);
+
+       /**
+        * check if a user exists
+        * @param string $uid the username
+        * @return boolean
+        * @since 4.5.0
+        */
+       public function userExists($uid);
+
+       /**
+        * get display name of the user
+        * @param string $uid user ID of the user
+        * @return string display name
+        * @since 4.5.0
+        */
+       public function getDisplayName($uid);
+
+       /**
+        * Get a list of all display names and user ids.
+        *
+        * @param string $search
+        * @param string|null $limit
+        * @param string|null $offset
+        * @return array an array of all displayNames (value) and the corresponding uids (key)
+        * @since 4.5.0
+        */
+       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
+        * @since 4.5.0
+        */
+       public function hasUserListings();
+
+}