From 24420e9eb1fdd4e15e1fc7eed1dd6d5b38f5cc0f Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Thu, 15 Oct 2015 08:27:24 +0200 Subject: [PATCH] Fix doc blocks of LDAP classes --- apps/user_ldap/lib/backendutility.php | 1 - apps/user_ldap/lib/filesystemhelper.php | 2 +- apps/user_ldap/lib/helper.php | 1 - apps/user_ldap/lib/user/deletedusersindex.php | 13 ++++++------- apps/user_ldap/lib/user/manager.php | 14 +++++++------- apps/user_ldap/lib/user/offlineuser.php | 6 +++--- apps/user_ldap/lib/user/user.php | 16 ++++++++-------- 7 files changed, 25 insertions(+), 28 deletions(-) diff --git a/apps/user_ldap/lib/backendutility.php b/apps/user_ldap/lib/backendutility.php index 2b50059556..b0fee7cd25 100644 --- a/apps/user_ldap/lib/backendutility.php +++ b/apps/user_ldap/lib/backendutility.php @@ -23,7 +23,6 @@ namespace OCA\user_ldap\lib; -use OCA\user_ldap\lib\Access; abstract class BackendUtility { protected $access; diff --git a/apps/user_ldap/lib/filesystemhelper.php b/apps/user_ldap/lib/filesystemhelper.php index 7c45d25ed3..6d431f6cb4 100644 --- a/apps/user_ldap/lib/filesystemhelper.php +++ b/apps/user_ldap/lib/filesystemhelper.php @@ -37,7 +37,7 @@ class FilesystemHelper { /** * @brief initializes the filesystem for the given user - * @param string the ownCloud username of the user + * @param string $uid the ownCloud username of the user */ public function setup($uid) { \OC_Util::setupFS($uid); diff --git a/apps/user_ldap/lib/helper.php b/apps/user_ldap/lib/helper.php index 57b75823a1..f05a4afad2 100644 --- a/apps/user_ldap/lib/helper.php +++ b/apps/user_ldap/lib/helper.php @@ -27,7 +27,6 @@ namespace OCA\user_ldap\lib; -use OCA\user_ldap\lib\LDAP; use OCA\user_ldap\User_Proxy; class Helper { diff --git a/apps/user_ldap/lib/user/deletedusersindex.php b/apps/user_ldap/lib/user/deletedusersindex.php index acea80bb9d..f8c1406d77 100644 --- a/apps/user_ldap/lib/user/deletedusersindex.php +++ b/apps/user_ldap/lib/user/deletedusersindex.php @@ -22,7 +22,6 @@ namespace OCA\user_ldap\lib\user; -use OCA\user_ldap\lib\user\OfflineUser; use OCA\User_LDAP\Mapping\UserMapping; /** @@ -51,9 +50,9 @@ class DeletedUsersIndex { protected $deletedUsers; /** - * @param OCP\IConfig $config - * @param OCP\IDBConnection $db - * @param OCA\User_LDAP\Mapping\UserMapping $mapping + * @param \OCP\IConfig $config + * @param \OCP\IDBConnection $db + * @param \OCA\User_LDAP\Mapping\UserMapping $mapping */ public function __construct(\OCP\IConfig $config, \OCP\IDBConnection $db, UserMapping $mapping) { $this->config = $config; @@ -63,7 +62,7 @@ class DeletedUsersIndex { /** * reads LDAP users marked as deleted from the database - * @return OCA\user_ldap\lib\user\OfflineUser[] + * @return \OCA\user_ldap\lib\user\OfflineUser[] */ private function fetchDeletedUsers() { $deletedUsers = $this->config->getUsersForUserValue( @@ -80,7 +79,7 @@ class DeletedUsersIndex { /** * returns all LDAP users that are marked as deleted - * @return OCA\user_ldap\lib\user\OfflineUser[] + * @return \OCA\user_ldap\lib\user\OfflineUser[] */ public function getUsers() { if(is_array($this->deletedUsers)) { @@ -105,7 +104,7 @@ class DeletedUsersIndex { /** * marks a user as deleted - * @param string ocName + * @param string $ocName */ public function markUser($ocName) { $this->config->setUserValue($ocName, 'user_ldap', 'isDeleted', '1'); diff --git a/apps/user_ldap/lib/user/manager.php b/apps/user_ldap/lib/user/manager.php index 86f0b8991d..89bbc84988 100644 --- a/apps/user_ldap/lib/user/manager.php +++ b/apps/user_ldap/lib/user/manager.php @@ -75,7 +75,7 @@ class Manager { * @param \OCP\IAvatarManager $avatarManager * @param \OCP\Image $image an empty image instance * @param \OCP\IDBConnection $db - * @throws Exception when the methods mentioned above do not exist + * @throws \Exception when the methods mentioned above do not exist */ public function __construct(\OCP\IConfig $ocConfig, FilesystemHelper $ocFilesystem, LogWrapper $ocLog, @@ -101,9 +101,9 @@ class Manager { /** * @brief creates an instance of User and caches (just runtime) it in the * property array - * @param string the DN of the user - * @param string the internal (owncloud) username - * @return \OCA\user_ldap\lib\User + * @param string $dn the DN of the user + * @param string $uid the internal (owncloud) username + * @return \OCA\user_ldap\lib\User\User */ private function createAndCache($dn, $uid) { $this->checkAccess(); @@ -117,7 +117,7 @@ class Manager { /** * @brief checks whether the Access instance has been set - * @throws Exception if Access has not been set + * @throws \Exception if Access has not been set * @return null */ private function checkAccess() { @@ -189,7 +189,7 @@ class Manager { /** * @brief returns a User object by it's ownCloud username - * @param string the DN or username of the user + * @param string $id the DN or username of the user * @return \OCA\user_ldap\lib\user\User|\OCA\user_ldap\lib\user\OfflineUser|null */ protected function createInstancyByUserName($id) { @@ -206,7 +206,7 @@ class Manager { /** * @brief returns a User object by it's DN or ownCloud username - * @param string the DN or username of the user + * @param string $id the DN or username of the user * @return \OCA\user_ldap\lib\user\User|\OCA\user_ldap\lib\user\OfflineUser|null * @throws \Exception when connection could not be established */ diff --git a/apps/user_ldap/lib/user/offlineuser.php b/apps/user_ldap/lib/user/offlineuser.php index 0727eb5b58..8177e84346 100644 --- a/apps/user_ldap/lib/user/offlineuser.php +++ b/apps/user_ldap/lib/user/offlineuser.php @@ -72,9 +72,9 @@ class OfflineUser { /** * @param string $ocName - * @param OCP\IConfig $config - * @param OCP\IDBConnection $db - * @param OCA\User_LDAP\Mapping\UserMapping $mapping + * @param \OCP\IConfig $config + * @param \OCP\IDBConnection $db + * @param \OCA\User_LDAP\Mapping\UserMapping $mapping */ public function __construct($ocName, \OCP\IConfig $config, \OCP\IDBConnection $db, UserMapping $mapping) { $this->ocName = $ocName; diff --git a/apps/user_ldap/lib/user/user.php b/apps/user_ldap/lib/user/user.php index d8148035d3..756b923e7e 100644 --- a/apps/user_ldap/lib/user/user.php +++ b/apps/user_ldap/lib/user/user.php @@ -87,15 +87,15 @@ class User { /** * @brief constructor, make sure the subclasses call this one! - * @param string the internal username - * @param string the LDAP DN + * @param string $username the internal username + * @param string $dn the LDAP DN * @param IUserTools $access an instance that implements IUserTools for * LDAP interaction - * @param \OCP\IConfig - * @param FilesystemHelper - * @param \OCP\Image any empty instance - * @param LogWrapper - * @param \OCP\IAvatarManager + * @param \OCP\IConfig $config + * @param FilesystemHelper $fs + * @param \OCP\Image $image any empty instance + * @param LogWrapper $log + * @param \OCP\IAvatarManager $avatarManager */ public function __construct($username, $dn, IUserTools $access, \OCP\IConfig $config, FilesystemHelper $fs, \OCP\Image $image, @@ -368,7 +368,7 @@ class User { * @brief checks whether an update method specified by feature was run * already. If not, it will marked like this, because it is expected that * the method will be run, when false is returned. - * @param string email | quota | avatar (can be extended) + * @param string $feature email | quota | avatar (can be extended) * @return bool */ private function wasRefreshed($feature) {