mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix doc blocks of LDAP classes

This commit is contained in:
Joas Schilling 2015-10-15 08:27:24 +02:00
parent 5bee7007dd
commit 24420e9eb1
7 changed files with 25 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
apps/user_ldap/lib/backendutility.php
View File

@ -23,7 +23,6 @@
namespace OCA\user_ldap\lib; namespace OCA\user_ldap\lib;
use OCA\user_ldap\lib\Access;
abstract class BackendUtility { abstract class BackendUtility {
protected $access; protected $access;

2
apps/user_ldap/lib/filesystemhelper.php
View File

@ -37,7 +37,7 @@ class FilesystemHelper {
/** /**
* @brief initializes the filesystem for the given user * @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) { public function setup($uid) {
\OC_Util::setupFS($uid); \OC_Util::setupFS($uid);

1
apps/user_ldap/lib/helper.php
View File

@ -27,7 +27,6 @@
namespace OCA\user_ldap\lib; namespace OCA\user_ldap\lib;
use OCA\user_ldap\lib\LDAP;
use OCA\user_ldap\User_Proxy; use OCA\user_ldap\User_Proxy;
class Helper { class Helper {

13
apps/user_ldap/lib/user/deletedusersindex.php
View File

@ -22,7 +22,6 @@
namespace OCA\user_ldap\lib\user; namespace OCA\user_ldap\lib\user;
use OCA\user_ldap\lib\user\OfflineUser;
use OCA\User_LDAP\Mapping\UserMapping; use OCA\User_LDAP\Mapping\UserMapping;
/** /**
@ -51,9 +50,9 @@ class DeletedUsersIndex {
protected $deletedUsers; protected $deletedUsers;
/** /**
* @param OCP\IConfig $config * @param \OCP\IConfig $config
* @param OCP\IDBConnection $db * @param \OCP\IDBConnection $db
* @param OCA\User_LDAP\Mapping\UserMapping $mapping * @param \OCA\User_LDAP\Mapping\UserMapping $mapping
*/ */
public function __construct(\OCP\IConfig $config, \OCP\IDBConnection $db, UserMapping $mapping) { public function __construct(\OCP\IConfig $config, \OCP\IDBConnection $db, UserMapping $mapping) {
$this->config = $config; $this->config = $config;
@ -63,7 +62,7 @@ class DeletedUsersIndex {
/** /**
* reads LDAP users marked as deleted from the database * 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() { private function fetchDeletedUsers() {
$deletedUsers = $this->config->getUsersForUserValue( $deletedUsers = $this->config->getUsersForUserValue(
@ -80,7 +79,7 @@ class DeletedUsersIndex {
/** /**
* returns all LDAP users that are marked as deleted * 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() { public function getUsers() {
if(is_array($this->deletedUsers)) { if(is_array($this->deletedUsers)) {
@ -105,7 +104,7 @@ class DeletedUsersIndex {
/** /**
* marks a user as deleted * marks a user as deleted
* @param string ocName * @param string $ocName
*/ */
public function markUser($ocName) { public function markUser($ocName) {
$this->config->setUserValue($ocName, 'user_ldap', 'isDeleted', '1'); $this->config->setUserValue($ocName, 'user_ldap', 'isDeleted', '1');

14
apps/user_ldap/lib/user/manager.php
View File

@ -75,7 +75,7 @@ class Manager {
* @param \OCP\IAvatarManager $avatarManager * @param \OCP\IAvatarManager $avatarManager
* @param \OCP\Image $image an empty image instance * @param \OCP\Image $image an empty image instance
* @param \OCP\IDBConnection $db * @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, public function __construct(\OCP\IConfig $ocConfig,
FilesystemHelper $ocFilesystem, LogWrapper $ocLog, FilesystemHelper $ocFilesystem, LogWrapper $ocLog,
@ -101,9 +101,9 @@ class Manager {
/** /**
* @brief creates an instance of User and caches (just runtime) it in the * @brief creates an instance of User and caches (just runtime) it in the
* property array * property array
* @param string the DN of the user * @param string $dn the DN of the user
* @param string the internal (owncloud) username * @param string $uid the internal (owncloud) username
* @return \OCA\user_ldap\lib\User * @return \OCA\user_ldap\lib\User\User
*/ */
private function createAndCache($dn, $uid) { private function createAndCache($dn, $uid) {
$this->checkAccess(); $this->checkAccess();
@ -117,7 +117,7 @@ class Manager {
/** /**
* @brief checks whether the Access instance has been set * @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 * @return null
*/ */
private function checkAccess() { private function checkAccess() {
@ -189,7 +189,7 @@ class Manager {
/** /**
* @brief returns a User object by it's ownCloud username * @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 * @return \OCA\user_ldap\lib\user\User|\OCA\user_ldap\lib\user\OfflineUser|null
*/ */
protected function createInstancyByUserName($id) { protected function createInstancyByUserName($id) {
@ -206,7 +206,7 @@ class Manager {
/** /**
* @brief returns a User object by it's DN or ownCloud username * @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 * @return \OCA\user_ldap\lib\user\User|\OCA\user_ldap\lib\user\OfflineUser|null
* @throws \Exception when connection could not be established * @throws \Exception when connection could not be established
*/ */

6
apps/user_ldap/lib/user/offlineuser.php
View File

@ -72,9 +72,9 @@ class OfflineUser {
/** /**
* @param string $ocName * @param string $ocName
* @param OCP\IConfig $config * @param \OCP\IConfig $config
* @param OCP\IDBConnection $db * @param \OCP\IDBConnection $db
* @param OCA\User_LDAP\Mapping\UserMapping $mapping * @param \OCA\User_LDAP\Mapping\UserMapping $mapping
*/ */
public function __construct($ocName, \OCP\IConfig $config, \OCP\IDBConnection $db, UserMapping $mapping) { public function __construct($ocName, \OCP\IConfig $config, \OCP\IDBConnection $db, UserMapping $mapping) {
$this->ocName = $ocName; $this->ocName = $ocName;

16
apps/user_ldap/lib/user/user.php
View File

@ -87,15 +87,15 @@ class User {
/** /**
* @brief constructor, make sure the subclasses call this one! * @brief constructor, make sure the subclasses call this one!
* @param string the internal username * @param string $username the internal username
* @param string the LDAP DN * @param string $dn the LDAP DN
* @param IUserTools $access an instance that implements IUserTools for * @param IUserTools $access an instance that implements IUserTools for
* LDAP interaction * LDAP interaction
* @param \OCP\IConfig * @param \OCP\IConfig $config
* @param FilesystemHelper * @param FilesystemHelper $fs
* @param \OCP\Image any empty instance * @param \OCP\Image $image any empty instance
* @param LogWrapper * @param LogWrapper $log
* @param \OCP\IAvatarManager * @param \OCP\IAvatarManager $avatarManager
*/ */
public function __construct($username, $dn, IUserTools $access, public function __construct($username, $dn, IUserTools $access,
\OCP\IConfig $config, FilesystemHelper $fs, \OCP\Image $image, \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 * @brief checks whether an update method specified by feature was run
* already. If not, it will marked like this, because it is expected that * already. If not, it will marked like this, because it is expected that
* the method will be run, when false is returned. * 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 * @return bool
*/ */
private function wasRefreshed($feature) { private function wasRefreshed($feature) {