From f9a9085faf69a720aacb437cdfc96505bd614acf Mon Sep 17 00:00:00 2001
From: Arthur Schiwon <blizzz@owncloud.com>
Date: Thu, 24 Apr 2014 13:44:25 +0200
Subject: [PATCH] class descriptions
---
apps/user_ldap/lib/user/iusertools.php | 5 +++++
apps/user_ldap/lib/user/manager.php | 6 ++++++
apps/user_ldap/lib/user/user.php | 5 +++++
3 files changed, 16 insertions(+)
diff --git a/apps/user_ldap/lib/user/iusertools.php b/apps/user_ldap/lib/user/iusertools.php
index 248c975c97..e409f3afed 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 7bb9d97ef9..6c635518d9 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 c0f2ebf0fa..d4d2294307 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
--
GitLab