Fix PHPDoc in /apps

9 files changed, 81 insertions, 81 deletions

diff --git a/apps/user_ldap/lib/access.php b/apps/user_ldap/lib/access.php
index c721703bce5..0097c94ba2b 100644
--- a/apps/user_ldap/lib/access.php
+++ b/apps/user_ldap/lib/access.php
@@ -383,7 +383,7 @@ class Access extends LDAPUtility {
 	}
 
 	/**
-	 * @param $dn
+	 * @param string $dn
 	 * @return bool|string
 	 */
 	private function findMappedUser($dn) {
@@ -403,7 +403,7 @@ class Access extends LDAPUtility {
 	}
 
 	/**
-	 * @param $dn
+	 * @param string $dn
 	 * @return bool|string
 	 */
 	private function findMappedGroup($dn) {
@@ -630,8 +630,8 @@ class Access extends LDAPUtility {
 	}
 
 	/**
-	 * @param $filter
-	 * @param $attr
+	 * @param string $filter
+	 * @param string $attr
 	 * @param int $limit
 	 * @param int $offset
 	 * @return array
@@ -641,8 +641,8 @@ class Access extends LDAPUtility {
 	}
 
 	/**
-	 * @param $filter
-	 * @param $attr
+	 * @param string $filter
+	 * @param string $attr
 	 * @param int $limit
 	 * @param int $offset
 	 * @return array
@@ -652,7 +652,7 @@ class Access extends LDAPUtility {
 	}
 
 	/**
-	 * @param $list
+	 * @param array $list
 	 * @param bool $manyAttributes
 	 * @return array
 	 */
@@ -840,9 +840,9 @@ class Access extends LDAPUtility {
 	}
 
 	/**
-	 * @param $searchResults
-	 * @param $limit
-	 * @param $hasHitLimit
+	 * @param array $searchResults
+	 * @param int $limit
+	 * @param bool $hasHitLimit
 	 * @return int
 	 */
 	private function countEntriesInSearchResults($searchResults, $limit, &$hasHitLimit) {
@@ -969,7 +969,7 @@ class Access extends LDAPUtility {
 	}
 
 	/**
-	 * @param $name
+	 * @param string $name
 	 * @return bool|mixed|string
 	 */
 	public function sanitizeUsername($name) {
@@ -1003,7 +1003,7 @@ class Access extends LDAPUtility {
 
 	/**
 	 * @brief combines the input filters with AND
-	 * @param $filters array, the filters to connect
+	 * @param array $filters the filters to connect
 	 * @return string the combined filter
 	 */
 	public function combineFilterWithAnd($filters) {
@@ -1012,7 +1012,7 @@ class Access extends LDAPUtility {
 
 	/**
 	 * @brief combines the input filters with AND
-	 * @param $filters array, the filters to connect
+	 * @param array $filters the filters to connect
 	 * @return string the combined filter
 	 */
 	public function combineFilterWithOr($filters) {
@@ -1021,7 +1021,7 @@ class Access extends LDAPUtility {
 
 	/**
 	 * @brief combines the input filters with given operator
-	 * @param $filters array, the filters to connect
+	 * @param array $filters the filters to connect
 	 * @param string $operator either & or |
 	 * @return string the combined filter
 	 */
@@ -1062,7 +1062,7 @@ class Access extends LDAPUtility {
 	/**
 	 * @brief creates a filter part for searches
 	 * @param string $search the search term
-	 * @param $searchAttributes
+	 * @param array|null $searchAttributes
 	 * @param string $fallbackAttribute a fallback attribute in case the user
 	 * did not define search attributes. Typically the display name attribute.
 	 * @return string the final filter part to use in LDAP searches
@@ -1152,7 +1152,7 @@ class Access extends LDAPUtility {
 	}
 
 	/**
-	 * @param $dn
+	 * @param string $dn
 	 * @param bool $isUser
 	 * @return array|bool|false
 	 */
@@ -1220,7 +1220,7 @@ class Access extends LDAPUtility {
 	/**
 	 * @brief checks if the given DN is part of the given base DN(s)
 	 * @param string $dn the DN
-	 * @param $bases array containing the allowed base DN or DNs
+	 * @param array $bases array containing the allowed base DN or DNs
 	 * @return bool
 	 */
 	private function isDNPartOfBase($dn, $bases) {
diff --git a/apps/user_ldap/lib/configuration.php b/apps/user_ldap/lib/configuration.php
index a9d65963ad5..c6c3c6b89bf 100644
--- a/apps/user_ldap/lib/configuration.php
+++ b/apps/user_ldap/lib/configuration.php
@@ -81,7 +81,7 @@ class Configuration {
 	);
 
 	/**
-	 * @param $configPrefix
+	 * @param string $configPrefix
 	 * @param bool $autoRead
 	 */
 	public function __construct($configPrefix, $autoRead = true) {
@@ -92,7 +92,7 @@ class Configuration {
 	}
 
 	/**
-	 * @param $name
+	 * @param string $name
 	 * @return mixed|void
 	 */
 	public function __get($name) {
@@ -102,8 +102,8 @@ class Configuration {
 	}
 
 	/**
-	 * @param $name
-	 * @param $value
+	 * @param string $name
+	 * @param mixed $value
 	 */
 	public function __set($name, $value) {
 		$this->setConfiguration(array($name => $value));
@@ -120,7 +120,7 @@ class Configuration {
 	 * @brief set LDAP configuration with values delivered by an array, not read
 	 * from configuration. It does not save the configuration! To do so, you
 	 * must call saveConfiguration afterwards.
-	 * @param $config array that holds the config parameters in an associated
+	 * @param array $config array that holds the config parameters in an associated
 	 * array
 	 * @param array &$applied optional; array where the set fields will be given to
 	 * @return false|null
@@ -250,7 +250,7 @@ class Configuration {
 	}
 
 	/**
-	 * @param $varName
+	 * @param string $varName
 	 * @return array|string
 	 */
 	protected function getMultiLine($varName) {
@@ -265,8 +265,8 @@ class Configuration {
 	}
 
 	/**
-	 * @param $varName
-	 * @param $value
+	 * @param string $varName
+	 * @param array|string $value
 	 */
 	protected function setMultiLine($varName, $value) {
 		if(empty($value)) {
@@ -282,7 +282,7 @@ class Configuration {
 	}
 
 	/**
-	 * @param $varName
+	 * @param string $varName
 	 * @return string
 	 */
 	protected function getPwd($varName) {
@@ -290,7 +290,7 @@ class Configuration {
 	}
 
 	/**
-	 * @param $varName
+	 * @param string $varName
 	 * @return string
 	 */
 	protected function getLcValue($varName) {
@@ -298,7 +298,7 @@ class Configuration {
 	}
 
 	/**
-	 * @param $varName
+	 * @param string $varName
 	 * @return string
 	 */
 	protected function getSystemValue($varName) {
@@ -307,7 +307,7 @@ class Configuration {
 	}
 
 	/**
-	 * @param $varName
+	 * @param string $varName
 	 * @return string
 	 */
 	protected function getValue($varName) {
@@ -321,16 +321,16 @@ class Configuration {
 	}
 
 	/**
-	 * @param $varName
-	 * @param $value
+	 * @param string $varName
+	 * @param mixed $value
 	 */
 	protected function setValue($varName, $value) {
 		$this->config[$varName] = $value;
 	}
 
 	/**
-	 * @param $varName
-	 * @param $value
+	 * @param string $varName
+	 * @param string $value
 	 * @return bool
 	 */
 	protected function saveValue($varName, $value) {
@@ -448,4 +448,4 @@ class Configuration {
 		return $array;
 	}
 
-}
\ No newline at end of file
+}
diff --git a/apps/user_ldap/lib/connection.php b/apps/user_ldap/lib/connection.php
index 847a984bb4d..7e2f8d1d957 100644
--- a/apps/user_ldap/lib/connection.php
+++ b/apps/user_ldap/lib/connection.php
@@ -84,7 +84,7 @@ class Connection extends LDAPUtility {
 	}
 
 	/**
-	 * @param $name
+	 * @param string $name
 	 * @return bool|mixed|void
 	 */
 	public function __get($name) {
@@ -100,8 +100,8 @@ class Connection extends LDAPUtility {
 	}
 
 	/**
-	 * @param $name
-	 * @param $value
+	 * @param string $name
+	 * @param mixed $value
 	 */
 	public function __set($name, $value) {
 		$this->doNotValidate = false;
@@ -142,7 +142,7 @@ class Connection extends LDAPUtility {
 	}
 
 	/**
-	 * @param $key
+	 * @param string|null $key
 	 * @return string
 	 */
 	private function getCacheKey($key) {
@@ -154,7 +154,7 @@ class Connection extends LDAPUtility {
 	}
 
 	/**
-	 * @param $key
+	 * @param string $key
 	 * @return mixed|null
 	 */
 	public function getFromCache($key) {
@@ -174,7 +174,7 @@ class Connection extends LDAPUtility {
 	}
 
 	/**
-	 * @param $key
+	 * @param string $key
 	 * @return bool
 	 */
 	public function isCached($key) {
@@ -189,8 +189,8 @@ class Connection extends LDAPUtility {
 	}
 
 	/**
-	 * @param $key
-	 * @param $value
+	 * @param string $key
+	 * @param mixed $value
 	 */
 	public function writeToCache($key, $value) {
 		if(!$this->configured) {
@@ -224,7 +224,7 @@ class Connection extends LDAPUtility {
 
 	/**
 	 * @brief set LDAP configuration with values delivered by an array, not read from configuration
-	 * @param $config array that holds the config parameters in an associated array
+	 * @param array $config array that holds the config parameters in an associated array
 	 * @param array &$setParameters optional; array where the set fields will be given to
 	 * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
 	 */
@@ -523,8 +523,8 @@ class Connection extends LDAPUtility {
 	}
 
 	/**
-	 * @param $host
-	 * @param $port
+	 * @param string $host
+	 * @param string $port
 	 * @return false|void
 	 */
 	private function doConnect($host, $port) {
diff --git a/apps/user_ldap/lib/ildapwrapper.php b/apps/user_ldap/lib/ildapwrapper.php
index 146ada125bb..e26fdfd2c36 100644
--- a/apps/user_ldap/lib/ildapwrapper.php
+++ b/apps/user_ldap/lib/ildapwrapper.php
@@ -52,15 +52,15 @@ interface ILDAPWrapper {
 	 * @param int $pageSize number of results per page
 	 * @param bool $isCritical Indicates whether the pagination is critical of not.
 	 * @param array $cookie structure sent by LDAP server
-	 * @return true on success, false otherwise
+	 * @return bool true on success, false otherwise
 	 */
 	public function controlPagedResult($link, $pageSize, $isCritical, $cookie);
 
 	/**
 	 * @brief Retrieve the LDAP pagination cookie
-	 * @param $link LDAP link resource
-	 * @param $result LDAP result resource
-	 * @param array $cookie structure sent by LDAP server
+	 * @param resource $link LDAP link resource
+	 * @param resource $result LDAP result resource
+	 * @param string $cookie structure sent by LDAP server
 	 * @return bool true on success, false otherwise
 	 *
 	 * Corresponds to ldap_control_paged_result_response
@@ -169,8 +169,8 @@ interface ILDAPWrapper {
 
 	/**
 	 * @brief Sort the result of a LDAP search
-	 * @param $link LDAP link resource
-	 * @param $result LDAP result resource
+	 * @param resource $link LDAP link resource
+	 * @param resource $result LDAP result resource
 	 * @param string $sortFilter attribute to use a key in sort
 	 */
 	public function sort($link, $result, $sortFilter);
diff --git a/apps/user_ldap/lib/jobs.php b/apps/user_ldap/lib/jobs.php
index 49c77719721..dd9d1eef7fb 100644
--- a/apps/user_ldap/lib/jobs.php
+++ b/apps/user_ldap/lib/jobs.php
@@ -34,7 +34,7 @@ class Jobs extends \OC\BackgroundJob\TimedJob {
 	}
 
 	/**
-	 * @param $argument
+	 * @param mixed $argument
 	 */
 	public function run($argument){
 		Jobs::updateGroups();
@@ -69,7 +69,7 @@ class Jobs extends \OC\BackgroundJob\TimedJob {
 	}
 
 	/**
-	 * @param $groups
+	 * @param array $groups
 	 */
 	static private function handleKnownGroups($groups) {
 		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG);
@@ -107,7 +107,7 @@ class Jobs extends \OC\BackgroundJob\TimedJob {
 	}
 
 	/**
-	 * @param $createdGroups
+	 * @param array $createdGroups
 	 */
 	static private function handleCreatedGroups($createdGroups) {
 		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG);
@@ -129,7 +129,7 @@ class Jobs extends \OC\BackgroundJob\TimedJob {
 	}
 
 	/**
-	 * @param $removedGroups
+	 * @param array $removedGroups
 	 */
 	static private function handleRemovedGroups($removedGroups) {
 		\OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG);
diff --git a/apps/user_ldap/lib/ldap.php b/apps/user_ldap/lib/ldap.php
index 9962d1267b8..212eea0d8e9 100644
--- a/apps/user_ldap/lib/ldap.php
+++ b/apps/user_ldap/lib/ldap.php
@@ -49,7 +49,7 @@ class LDAP implements ILDAPWrapper {
 	/**
 	 * @param LDAP $link
 	 * @param LDAP $result
-	 * @param $cookie
+	 * @param string $cookie
 	 * @return bool|LDAP
 	 */
 	public function controlPagedResultResponse($link, $result, &$cookie) {
@@ -65,7 +65,7 @@ class LDAP implements ILDAPWrapper {
 	 * @param LDAP $link
 	 * @param int $pageSize
 	 * @param bool $isCritical
-	 * @param array $cookie
+	 * @param string $cookie
 	 * @return mixed|true
 	 */
 	public function controlPagedResult($link, $pageSize, $isCritical, $cookie) {
@@ -248,7 +248,7 @@ class LDAP implements ILDAPWrapper {
 
 	/**
 	 * @param string $functionName
-	 * @param $args
+	 * @param array $args
 	 */
 	private function preFunctionCall($functionName, $args) {
 		$this->curFunc = $functionName;
diff --git a/apps/user_ldap/lib/proxy.php b/apps/user_ldap/lib/proxy.php
index 50e8071a584..f7ba9082e09 100644
--- a/apps/user_ldap/lib/proxy.php
+++ b/apps/user_ldap/lib/proxy.php
@@ -38,7 +38,7 @@ abstract class Proxy {
 	}
 
 	/**
-	 * @param $configPrefix
+	 * @param string $configPrefix
 	 */
 	private function addAccess($configPrefix) {
 		$connector = new Connection($this->ldap, $configPrefix);
@@ -46,7 +46,7 @@ abstract class Proxy {
 	}
 
 	/**
-	 * @param $configPrefix
+	 * @param string $configPrefix
 	 * @return mixed
 	 */
 	protected function getAccess($configPrefix) {
@@ -57,7 +57,7 @@ abstract class Proxy {
 	}
 
 	/**
-	 * @param $uid
+	 * @param string $uid
 	 * @return string
 	 */
 	protected function getUserCacheKey($uid) {
@@ -65,7 +65,7 @@ abstract class Proxy {
 	}
 
 	/**
-	 * @param $gid
+	 * @param string $gid
 	 * @return string
 	 */
 	protected function getGroupCacheKey($gid) {
@@ -73,25 +73,25 @@ abstract class Proxy {
 	}
 
 	/**
-	 * @param $id
-	 * @param $method
-	 * @param $parameters
+	 * @param string $id
+	 * @param string $method
+	 * @param array $parameters
 	 * @param bool $passOnWhen
 	 * @return mixed
 	 */
 	abstract protected function callOnLastSeenOn($id, $method, $parameters, $passOnWhen);
 
 	/**
-	 * @param $id
-	 * @param $method
-	 * @param $parameters
+	 * @param string $id
+	 * @param string $method
+	 * @param array $parameters
 	 * @return mixed
 	 */
 	abstract protected function walkBackends($id, $method, $parameters);
 
 	/**
 	 * @brief Takes care of the request to the User backend
-	 * @param $id
+	 * @param string $id
 	 * @param string $method string, the method of the user backend that shall be called
 	 * @param array $parameters an array of parameters to be passed
 	 * @param bool $passOnWhen
@@ -106,7 +106,7 @@ abstract class Proxy {
 	}
 
 	/**
-	 * @param $key
+	 * @param string|null $key
 	 * @return string
 	 */
 	private function getCacheKey($key) {
@@ -118,7 +118,7 @@ abstract class Proxy {
 	}
 
 	/**
-	 * @param $key
+	 * @param string $key
 	 * @return mixed|null
 	 */
 	public function getFromCache($key) {
@@ -131,7 +131,7 @@ abstract class Proxy {
 	}
 
 	/**
-	 * @param $key
+	 * @param string $key
 	 * @return bool
 	 */
 	public function isCached($key) {
@@ -140,8 +140,8 @@ abstract class Proxy {
 	}
 
 	/**
-	 * @param $key
-	 * @param $value
+	 * @param string $key
+	 * @param mixed $value
 	 */
 	public function writeToCache($key, $value) {
 		$key   = $this->getCacheKey($key);
diff --git a/apps/user_ldap/lib/wizard.php b/apps/user_ldap/lib/wizard.php
index 8d944c9a957..62dd138d7e3 100644
--- a/apps/user_ldap/lib/wizard.php
+++ b/apps/user_ldap/lib/wizard.php
@@ -909,7 +909,7 @@ class Wizard extends LDAPUtility {
 	 * specified attribute
 	 * @param string[] $filters array, the filters that shall be used in the search
 	 * @param string $attr the attribute of which a list of values shall be returned
-	 * @param $lfw bool, whether the last filter is a wildcard which shall not
+	 * @param bool $lfw whether the last filter is a wildcard which shall not
 	 * be processed if there were already findings, defaults to true
 	 * @param int $dnReadLimit the amount of how many DNs should be analyzed.
 	 * The lower, the faster
@@ -987,7 +987,7 @@ class Wizard extends LDAPUtility {
 	 * @param string $dbkey the dbkey of the setting the feature is connected to
 	 * @param string $confkey the confkey counterpart for the $dbkey as used in the
 	 * Configuration class
-	 * @param $po boolean, whether the objectClass with most result entries
+	 * @param bool $po whether the objectClass with most result entries
 	 * shall be pre-selected via the result
 	 * @return array, list of found items.
 	 * @throws \Exception
@@ -1041,9 +1041,9 @@ class Wizard extends LDAPUtility {
 
 	/**
 	 * @brief appends a list of values fr
-	 * @param $result resource, the return value from ldap_get_attributes
+	 * @param resource $result the return value from ldap_get_attributes
 	 * @param string $attribute the attribute values to look for
-	 * @param &$known array, new values will be appended here
+	 * @param array &$known 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 5ed16732ca0..42b0bc04654 100644
--- a/apps/user_ldap/lib/wizardresult.php
+++ b/apps/user_ldap/lib/wizardresult.php
@@ -29,8 +29,8 @@ class WizardResult {
 	protected $markedChange = false;
 
 	/**
-	 * @param $key
-	 * @param $value
+	 * @param string $key
+	 * @param mixed $value
 	 */
 	public function addChange($key, $value) {
 		$this->changes[$key] = $value;
@@ -72,4 +72,4 @@ class WizardResult {
 		}
 		return $result;
 	}
-}
\ No newline at end of file
+}