]> source.dussan.org Git - nextcloud-server.git/commitdiff
Fix PHPdoc in user_ldap
authorBart Visscher <bartv@thisnet.nl>
Mon, 14 Apr 2014 15:39:29 +0000 (17:39 +0200)
committerBart Visscher <bartv@thisnet.nl>
Tue, 15 Apr 2014 19:05:49 +0000 (21:05 +0200)
using scrutinizer patch

apps/user_ldap/group_ldap.php
apps/user_ldap/lib/access.php
apps/user_ldap/lib/connection.php
apps/user_ldap/lib/proxy.php
apps/user_ldap/lib/wizard.php
apps/user_ldap/lib/wizardresult.php

index 40d9dec14101d4290c102452074421281d65477c..3b5f377e1085f2431b9e9ab42d2996c62c335b3f 100644 (file)
@@ -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);
        }
index 4d187bab8d56214bbaf35f4bf67182fd467853be..383583fce3230675c398e9b32e37915ba7540fb9 100644 (file)
@@ -923,8 +923,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('*', '\\', '(', ')');
index 08ac4ac626b6a3718eb49fa88c5ee8ef04e366af..173c4ebcc2347008227b8a3ae6835da060304425 100644 (file)
@@ -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)) {
index b27233bcd192d455df1c895a509a1e2c4ee21f6b..0eb294eb7a0d36350c8956490d4b16712d276638 100644 (file)
@@ -80,6 +80,9 @@ abstract class Proxy {
                return $result;
        }
 
+       /**
+        * @param string|null $key
+        */
        private function getCacheKey($key) {
                $prefix = 'LDAP-Proxy-';
                if(is_null($key)) {
index 3854af617c11afaa21548d1f178e019dfb8d2077..8ddee8c760c251d6643b4d3bd23766a259f8b1da 100644 (file)
@@ -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
index 542f106cad8dc2b88a80aeac3bdce6ec400045fe..9c154503f532200d90d37c4ce44e143f129a1809 100644 (file)
@@ -36,6 +36,9 @@ class WizardResult {
                $this->markedChange = true;
        }
 
+       /**
+        * @param string $key
+        */
        public function addOptions($key, $values) {
                if(!is_array($values)) {
                        $values = array($values);