summaryrefslogtreecommitdiffstats
path: root/apps/user_ldap
diff options
context:
space:
mode:
authorArthur Schiwon <blizzz@owncloud.com>2014-04-24 13:44:25 +0200
committerArthur Schiwon <blizzz@owncloud.com>2014-06-03 12:59:10 +0200
commitf9a9085faf69a720aacb437cdfc96505bd614acf (patch)
tree6c5223b8516d13da9ef39da38fef6c8f03876c66 /apps/user_ldap
parent5336e9a1569f0cd602890e9ca58aa824c9eb0e00 (diff)
downloadnextcloud-server-f9a9085faf69a720aacb437cdfc96505bd614acf.tar.gz
nextcloud-server-f9a9085faf69a720aacb437cdfc96505bd614acf.zip
class descriptions
Diffstat (limited to 'apps/user_ldap')
-rw-r--r--apps/user_ldap/lib/user/iusertools.php5
-rw-r--r--apps/user_ldap/lib/user/manager.php6
-rw-r--r--apps/user_ldap/lib/user/user.php5
3 files changed, 16 insertions, 0 deletions
diff --git a/apps/user_ldap/lib/user/iusertools.php b/apps/user_ldap/lib/user/iusertools.php
index 248c975c976..e409f3afed3 100644
--- a/apps/user_ldap/lib/user/iusertools.php
+++ b/apps/user_ldap/lib/user/iusertools.php
@@ -23,6 +23,11 @@
namespace OCA\user_ldap\lib\user;
+/**
+ * IUserTools
+ *
+ * defines methods that are required by User class for LDAP interaction
+ */
interface IUserTools {
public function getConnection();
diff --git a/apps/user_ldap/lib/user/manager.php b/apps/user_ldap/lib/user/manager.php
index 7bb9d97ef9f..6c635518d95 100644
--- a/apps/user_ldap/lib/user/manager.php
+++ b/apps/user_ldap/lib/user/manager.php
@@ -28,6 +28,12 @@ use OCA\user_ldap\lib\user\User;
use OCA\user_ldap\lib\LogWrapper;
use OCA\user_ldap\lib\FilesystemHelper;
+/**
+ * Manager
+ *
+ * upon request, returns an LDAP user object either by creating or from run-time
+ * cache
+ */
class Manager {
/**
* @var IUserTools
diff --git a/apps/user_ldap/lib/user/user.php b/apps/user_ldap/lib/user/user.php
index c0f2ebf0fa9..d4d2294307d 100644
--- a/apps/user_ldap/lib/user/user.php
+++ b/apps/user_ldap/lib/user/user.php
@@ -28,6 +28,11 @@ use OCA\user_ldap\lib\Connection;
use OCA\user_ldap\lib\FilesystemHelper;
use OCA\user_ldap\lib\LogWrapper;
+/**
+ * User
+ *
+ * represents an LDAP user, gets and holds user-specific information from LDAP
+ */
class User {
/**
* @var IUserTools