Merge pull request #8220 from owncloud/type-hinting-ldap

Fix PHPdoc in user_ldap

6 files changed, 25 insertions, 4 deletions

diff --git a/apps/user_ldap/group_ldap.php b/apps/user_ldap/group_ldap.php
index 40d9dec1410..3b5f377e108 100644
--- a/apps/user_ldap/group_ldap.php
+++ b/apps/user_ldap/group_ldap.php
@@ -88,6 +88,10 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface {
 		return $isInGroup;
 	}
 
+	/**
+	 * @param string $dnGroup
+	 * @param array|null &$seen
+	 */
 	private function _groupMembers($dnGroup, &$seen = null) {
 		if ($seen === null) {
 			$seen = array();
@@ -163,6 +167,10 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface {
 		return $groups;
 	}
 
+	/**
+	 * @param string $dn
+	 * @param array|null &$seen
+	 */
 	private function getGroupsByMember($dn, &$seen = null) {
 		if ($seen === null) {
 			$seen = array();
@@ -454,6 +462,9 @@ class GROUP_LDAP extends BackendUtility implements \OCP\GroupInterface {
 		return $allGroups;
 	}
 
+	/**
+	 * @param string $group
+	 */
 	public function groupMatchesFilter($group) {
 		return (strripos($group, $this->groupSearch) !== false);
 	}
diff --git a/apps/user_ldap/lib/access.php b/apps/user_ldap/lib/access.php
index 0b3ff4aa15e..8d622dcb794 100644
--- a/apps/user_ldap/lib/access.php
+++ b/apps/user_ldap/lib/access.php
@@ -948,8 +948,8 @@ class Access extends LDAPUtility {
 
 	/**
 	* @brief escapes (user provided) parts for LDAP filter
-	* @param String $input, the provided value
-	* @returns the escaped string
+	* @param string $input, the provided value
+	* @return the escaped string
 	*/
 	public function escapeFilterPart($input) {
 		$search  = array('*', '\\', '(', ')');
diff --git a/apps/user_ldap/lib/connection.php b/apps/user_ldap/lib/connection.php
index 08ac4ac626b..173c4ebcc23 100644
--- a/apps/user_ldap/lib/connection.php
+++ b/apps/user_ldap/lib/connection.php
@@ -134,6 +134,9 @@ class Connection extends LDAPUtility {
 		return $this->ldapConnectionRes;
 	}
 
+	/**
+	 * @param string|null $key
+	 */
 	private function getCacheKey($key) {
 		$prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-';
 		if(is_null($key)) {
diff --git a/apps/user_ldap/lib/proxy.php b/apps/user_ldap/lib/proxy.php
index b27233bcd19..0eb294eb7a0 100644
--- a/apps/user_ldap/lib/proxy.php
+++ b/apps/user_ldap/lib/proxy.php
@@ -80,6 +80,9 @@ abstract class Proxy {
 		return $result;
 	}
 
+	/**
+	 * @param string|null $key
+	 */
 	private function getCacheKey($key) {
 		$prefix = 'LDAP-Proxy-';
 		if(is_null($key)) {
diff --git a/apps/user_ldap/lib/wizard.php b/apps/user_ldap/lib/wizard.php
index 3854af617c1..8ddee8c760c 100644
--- a/apps/user_ldap/lib/wizard.php
+++ b/apps/user_ldap/lib/wizard.php
@@ -485,7 +485,7 @@ class Wizard extends LDAPUtility {
 	/**
 	 * @brief sets the found value for the configuration key in the WizardResult
 	 * as well as in the Configuration instance
-	 * @param $key the configuration key
+	 * @param string $key the configuration key
 	 * @param $value the (detected) value
 	 * @return null
 	 *
@@ -1000,7 +1000,7 @@ class Wizard extends LDAPUtility {
 	/**
 	 * @brief appends a list of values fr
 	 * @param $result resource, the return value from ldap_get_attributes
-	 * @param $attribute string, the attribute values to look for
+	 * @param string $attribute the attribute values to look for
 	 * @param &$known array, new values will be appended here
 	 * @return int, state on of the class constants LRESULT_PROCESSED_OK,
 	 * LRESULT_PROCESSED_INVALID or LRESULT_PROCESSED_SKIP
diff --git a/apps/user_ldap/lib/wizardresult.php b/apps/user_ldap/lib/wizardresult.php
index 542f106cad8..9e0936faa69 100644
--- a/apps/user_ldap/lib/wizardresult.php
+++ b/apps/user_ldap/lib/wizardresult.php
@@ -36,6 +36,10 @@ class WizardResult {
 		$this->markedChange = true;
 	}
 
+	/**
+	 * @param string $key
+	 * @param array|string $values
+	 */
 	public function addOptions($key, $values) {
 		if(!is_array($values)) {
 			$values = array($values);