diff options
Diffstat (limited to 'apps/user_ldap/lib')
| -rw-r--r-- | apps/user_ldap/lib/access.php | 78 | ||||
| -rw-r--r-- | apps/user_ldap/lib/backendutility.php | 2 | ||||
| -rw-r--r-- | apps/user_ldap/lib/configuration.php | 4 | ||||
| -rw-r--r-- | apps/user_ldap/lib/connection.php | 18 | ||||
| -rw-r--r-- | apps/user_ldap/lib/helper.php | 8 | ||||
| -rw-r--r-- | apps/user_ldap/lib/ildapwrapper.php | 42 | ||||
| -rw-r--r-- | apps/user_ldap/lib/ldap.php | 6 | ||||
| -rw-r--r-- | apps/user_ldap/lib/ldaputility.php | 2 | ||||
| -rw-r--r-- | apps/user_ldap/lib/proxy.php | 2 | ||||
| -rw-r--r-- | apps/user_ldap/lib/wizard.php | 44 |
10 files changed, 103 insertions, 103 deletions
diff --git a/apps/user_ldap/lib/access.php b/apps/user_ldap/lib/access.php index 441eb40489e..78de14f4ee9 100644 --- a/apps/user_ldap/lib/access.php +++ b/apps/user_ldap/lib/access.php @@ -51,7 +51,7 @@ class Access extends LDAPUtility { } /** - * @brief reads a given attribute for an LDAP record identified by a DN + * reads a given attribute for an LDAP record identified by a DN * @param string $dn the record in question * @param string $attr the attribute that shall be retrieved * if empty, just check the record's existence @@ -115,7 +115,7 @@ class Access extends LDAPUtility { } /** - * @brief checks whether the given attributes value is probably a DN + * checks whether the given attributes value is probably a DN * @param string $attr the attribute in question * @return boolean if so true, otherwise false */ @@ -129,7 +129,7 @@ class Access extends LDAPUtility { } /** - * @brief sanitizes a DN received from the LDAP server + * sanitizes a DN received from the LDAP server * @param array $dn the DN in question * @return array the sanitized DN */ @@ -185,7 +185,7 @@ class Access extends LDAPUtility { } /** - * @brief returns the LDAP DN for the given internal ownCloud name of the group + * returns the LDAP DN for the given internal ownCloud name of the group * @param string $name the ownCloud name in question * @return string with the LDAP DN on success, otherwise false */ @@ -200,7 +200,7 @@ class Access extends LDAPUtility { } /** - * @brief returns the LDAP DN for the given internal ownCloud name of the user + * returns the LDAP DN for the given internal ownCloud name of the user * @param string $name the ownCloud name in question * @return string with the LDAP DN on success, otherwise false */ @@ -216,7 +216,7 @@ class Access extends LDAPUtility { } /** - * @brief returns the LDAP DN for the given internal ownCloud name + * returns the LDAP DN for the given internal ownCloud name * @param string $name the ownCloud name in question * @param boolean $isUser is it a user? otherwise group * @return string with the LDAP DN on success, otherwise false @@ -235,7 +235,7 @@ class Access extends LDAPUtility { } /** - * @brief returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure + * returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure * @param string $dn the dn of the group object * @param string $ldapName optional, the display name of the object * @return string with the name to use in ownCloud, false on DN outside of search DN @@ -252,7 +252,7 @@ class Access extends LDAPUtility { } /** - * @brief returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure + * returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure * @param string $dn the dn of the user object * @param string $ldapName optional, the display name of the object * @return string with with the name to use in ownCloud @@ -269,7 +269,7 @@ class Access extends LDAPUtility { } /** - * @brief returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN + * returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN * @param string $dn the dn of the user object * @param string $ldapName optional, the display name of the object * @param bool $isUser optional, whether it is a user object (otherwise group assumed) @@ -361,7 +361,7 @@ class Access extends LDAPUtility { } /** - * @brief gives back the user names as they are used ownClod internally + * gives back the user names as they are used ownClod internally * @param array $ldapUsers an array with the ldap Users result in style of array ( array ('dn' => foo, 'uid' => bar), ... ) * @return array an array with the user names to use in ownCloud * @@ -372,7 +372,7 @@ class Access extends LDAPUtility { } /** - * @brief gives back the group names as they are used ownClod internally + * gives back the group names as they are used ownClod internally * @param array $ldapGroups an array with the ldap Groups result in style of array ( array ('dn' => foo, 'cn' => bar), ... ) * @return array an array with the group names to use in ownCloud * @@ -452,7 +452,7 @@ class Access extends LDAPUtility { } /** - * @brief caches the user display name + * caches the user display name * @param string $ocName the internal ownCloud username * @param string $displayName the display name */ @@ -462,7 +462,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a unique name for internal ownCloud use for users. Don't call it directly. + * creates a unique name for internal ownCloud use for users. Don't call it directly. * @param string $name the display name of the object * @return string with with the name to use in ownCloud or false if unsuccessful * @@ -484,7 +484,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a unique name for internal ownCloud use for groups. Don't call it directly. + * creates a unique name for internal ownCloud use for groups. Don't call it directly. * @param string $name the display name of the object * @return string with with the name to use in ownCloud or false if unsuccessful. * @@ -532,7 +532,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a unique name for internal ownCloud use. + * creates a unique name for internal ownCloud use. * @param string $name the display name of the object * @param boolean $isUser whether name should be created for a user (true) or a group (false) * @return string with with the name to use in ownCloud or false if unsuccessful @@ -551,7 +551,7 @@ class Access extends LDAPUtility { } /** - * @brief retrieves all known groups from the mappings table + * retrieves all known groups from the mappings table * @return array with the results * * retrieves all known groups from the mappings table @@ -561,7 +561,7 @@ class Access extends LDAPUtility { } /** - * @brief retrieves all known users from the mappings table + * retrieves all known users from the mappings table * @return array with the results * * retrieves all known users from the mappings table @@ -585,7 +585,7 @@ class Access extends LDAPUtility { } /** - * @brief inserts a new user or group into the mappings table + * inserts a new user or group into the mappings table * @param string $dn the record in question * @param string $ocName the name to use in ownCloud * @param bool $isUser is it a user or a group? @@ -670,7 +670,7 @@ class Access extends LDAPUtility { } /** - * @brief executes an LDAP search, optimized for Users + * executes an LDAP search, optimized for Users * @param string $filter the LDAP filter for the search * @param string|string[] $attr optional, when a certain attribute shall be filtered out * @param integer $limit @@ -695,7 +695,7 @@ class Access extends LDAPUtility { } /** - * @brief executes an LDAP search, optimized for Groups + * executes an LDAP search, optimized for Groups * @param string $filter the LDAP filter for the search * @param string|string[] $attr optional, when a certain attribute shall be filtered out * @param integer $limit @@ -709,7 +709,7 @@ class Access extends LDAPUtility { } /** - * @brief prepares and executes an LDAP search operation + * prepares and executes an LDAP search operation * @param string $filter the LDAP filter for the search * @param array $base an array containing the LDAP subtree(s) that shall be searched * @param string|string[] $attr optional, array, one or more attributes that shall be @@ -755,7 +755,7 @@ class Access extends LDAPUtility { } /** - * @brief processes an LDAP paged search operation + * processes an LDAP paged search operation * @param array $sr the array containing the LDAP search resources * @param string $filter the LDAP filter for the search * @param array $base an array containing the LDAP subtree(s) that shall be searched @@ -796,7 +796,7 @@ class Access extends LDAPUtility { } /** - * @brief executes an LDAP search, but counts the results only + * executes an LDAP search, but counts the results only * @param string $filter the LDAP filter for the search * @param array $base an array containing the LDAP subtree(s) that shall be searched * @param string|string[] $attr optional, array, one or more attributes that shall be @@ -861,7 +861,7 @@ class Access extends LDAPUtility { } /** - * @brief Executes an LDAP search + * Executes an LDAP search * @param string $filter the LDAP filter for the search * @param array $base an array containing the LDAP subtree(s) that shall be searched * @param string|string[] $attr optional, array, one or more attributes that shall be @@ -991,7 +991,7 @@ class Access extends LDAPUtility { } /** - * @brief escapes (user provided) parts for LDAP filter + * escapes (user provided) parts for LDAP filter * @param string $input, the provided value * @return string the escaped string */ @@ -1002,7 +1002,7 @@ class Access extends LDAPUtility { } /** - * @brief combines the input filters with AND + * combines the input filters with AND * @param string[] $filters the filters to connect * @return string the combined filter */ @@ -1011,7 +1011,7 @@ class Access extends LDAPUtility { } /** - * @brief combines the input filters with AND + * combines the input filters with AND * @param string[] $filters the filters to connect * @return string the combined filter */ @@ -1020,7 +1020,7 @@ class Access extends LDAPUtility { } /** - * @brief combines the input filters with given operator + * combines the input filters with given operator * @param string[] $filters the filters to connect * @param string $operator either & or | * @return string the combined filter @@ -1038,7 +1038,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a filter part for to perform search for users + * creates a filter part for to perform search for users * @param string $search the search term * @return string the final filter part to use in LDAP searches */ @@ -1049,7 +1049,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a filter part for to perform search for groups + * creates a filter part for to perform search for groups * @param string $search the search term * @return string the final filter part to use in LDAP searches */ @@ -1060,7 +1060,7 @@ class Access extends LDAPUtility { } /** - * @brief creates a filter part for searches + * creates a filter part for searches * @param string $search the search term * @param string[]|null $searchAttributes * @param string $fallbackAttribute a fallback attribute in case the user @@ -1107,7 +1107,7 @@ class Access extends LDAPUtility { } /** - * @brief auto-detects the directory's UUID attribute + * auto-detects the directory's UUID attribute * @param string $dn a known DN used to check against * @param bool $isUser * @param bool $force the detection should be run, even if it is not set to auto @@ -1183,7 +1183,7 @@ class Access extends LDAPUtility { } /** - * @brief converts a binary ObjectGUID into a string representation + * converts a binary ObjectGUID into a string representation * @param string $oguid the ObjectGUID in it's binary form as retrieved from AD * @return string * @link http://www.php.net/manual/en/function.ldap-get-values-len.php#73198 @@ -1209,7 +1209,7 @@ class Access extends LDAPUtility { } /** - * @brief converts a stored DN so it can be used as base parameter for LDAP queries, internally we store them for usage in LDAP filters + * converts a stored DN so it can be used as base parameter for LDAP queries, internally we store them for usage in LDAP filters * @param string $dn the DN * @return string */ @@ -1218,7 +1218,7 @@ class Access extends LDAPUtility { } /** - * @brief checks if the given DN is part of the given base DN(s) + * checks if the given DN is part of the given base DN(s) * @param string $dn the DN * @param string[] $bases array containing the allowed base DN or DNs * @return bool @@ -1240,7 +1240,7 @@ class Access extends LDAPUtility { } /** - * @brief get a cookie for the next LDAP paged search + * get a cookie for the next LDAP paged search * @param string $base a string with the base DN for the search * @param string $filter the search filter to identify the correct search * @param int $limit the limit (or 'pageSize'), to identify the correct search well @@ -1265,7 +1265,7 @@ class Access extends LDAPUtility { } /** - * @brief set a cookie for LDAP paged search run + * set a cookie for LDAP paged search run * @param string $base a string with the base DN for the search * @param string $filter the search filter to identify the correct search * @param int $limit the limit (or 'pageSize'), to identify the correct search well @@ -1281,7 +1281,7 @@ class Access extends LDAPUtility { } /** - * @brief Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search. + * Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search. * @return boolean|null true on success, null or false otherwise */ public function getPagedSearchResultState() { @@ -1291,7 +1291,7 @@ class Access extends LDAPUtility { } /** - * @brief Prepares a paged search, if possible + * Prepares a paged search, if possible * @param string $filter the LDAP filter for the search * @param string[] $bases an array containing the LDAP subtree(s) that shall be searched * @param string[] $attr optional, when a certain attribute shall be filtered outside diff --git a/apps/user_ldap/lib/backendutility.php b/apps/user_ldap/lib/backendutility.php index 8ad26246c6b..c94366ce019 100644 --- a/apps/user_ldap/lib/backendutility.php +++ b/apps/user_ldap/lib/backendutility.php @@ -29,7 +29,7 @@ abstract class BackendUtility { protected $access; /** - * @brief constructor, make sure the subclasses call this one! + * constructor, make sure the subclasses call this one! * @param Access $access an instance of Access for LDAP interaction */ public function __construct(Access $access) { diff --git a/apps/user_ldap/lib/configuration.php b/apps/user_ldap/lib/configuration.php index c6c3c6b89bf..9c455929b4a 100644 --- a/apps/user_ldap/lib/configuration.php +++ b/apps/user_ldap/lib/configuration.php @@ -117,7 +117,7 @@ class Configuration { } /** - * @brief set LDAP configuration with values delivered by an array, not read + * 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 array $config array that holds the config parameters in an associated @@ -212,7 +212,7 @@ class Configuration { } /** - * @brief saves the current Configuration in the database + * saves the current Configuration in the database */ public function saveConfiguration() { $cta = array_flip($this->getConfigTranslationArray()); diff --git a/apps/user_ldap/lib/connection.php b/apps/user_ldap/lib/connection.php index 3a900a6fce4..52f6c5ceb10 100644 --- a/apps/user_ldap/lib/connection.php +++ b/apps/user_ldap/lib/connection.php @@ -42,7 +42,7 @@ class Connection extends LDAPUtility { protected $doNotValidate = false; /** - * @brief Constructor + * Constructor * @param ILDAPWrapper $ldap * @param string $configPrefix a string with the prefix for the configkey column (appconfig table) * @param string $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections @@ -73,7 +73,7 @@ class Connection extends LDAPUtility { } /** - * @brief defines behaviour when the instance is cloned + * defines behaviour when the instance is cloned */ public function __clone() { //a cloned instance inherits the connection resource. It may use it, @@ -117,7 +117,7 @@ class Connection extends LDAPUtility { } /** - * @brief initializes the LDAP backend + * initializes the LDAP backend * @param bool $force read the config settings no matter what */ public function init($force = false) { @@ -126,7 +126,7 @@ class Connection extends LDAPUtility { } /** - * @brief Returns the LDAP handler + * Returns the LDAP handler */ public function getConnectionResource() { if(!$this->ldapConnectionRes) { @@ -210,7 +210,7 @@ class Connection extends LDAPUtility { } /** - * @brief Caches the general LDAP configuration. + * Caches the general LDAP configuration. * @param bool $force optional. true, if the re-read should be forced. defaults * to false. * @return null @@ -223,7 +223,7 @@ class Connection extends LDAPUtility { } /** - * @brief set LDAP configuration with values delivered by an array, not read from configuration + * set LDAP configuration with values delivered by an array, not read from configuration * @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 @@ -243,7 +243,7 @@ class Connection extends LDAPUtility { } /** - * @brief saves the current Configuration in the database and empties the + * saves the current Configuration in the database and empties the * cache * @return null */ @@ -253,7 +253,7 @@ class Connection extends LDAPUtility { } /** - * @brief get the current LDAP configuration + * get the current LDAP configuration * @return array */ public function getConfiguration() { @@ -433,7 +433,7 @@ class Connection extends LDAPUtility { } /** - * @brief Validates the user specified configuration + * Validates the user specified configuration * @return bool true if configuration seems OK, false otherwise */ private function validateConfiguration() { diff --git a/apps/user_ldap/lib/helper.php b/apps/user_ldap/lib/helper.php index 5641db48a32..37caedc6251 100644 --- a/apps/user_ldap/lib/helper.php +++ b/apps/user_ldap/lib/helper.php @@ -26,7 +26,7 @@ namespace OCA\user_ldap\lib; class Helper { /** - * @brief returns prefixes for each saved LDAP/AD server configuration. + * returns prefixes for each saved LDAP/AD server configuration. * @param bool $activeConfigurations optional, whether only active configuration shall be * retrieved, defaults to false * @return array with a list of the available prefixes @@ -79,7 +79,7 @@ class Helper { /** * - * @brief determines the host for every configured connection + * determines the host for every configured connection * @return array an array with configprefix as keys * */ @@ -106,7 +106,7 @@ class Helper { } /** - * @brief deletes a given saved LDAP/AD server configuration. + * deletes a given saved LDAP/AD server configuration. * @param string $prefix the configuration prefix of the config to delete * @return bool true on success, false otherwise */ @@ -176,7 +176,7 @@ class Helper { } /** - * @brief extractsthe domain from a given URL + * extractsthe domain from a given URL * @param string $url the URL * @return string|false domain as string on success, false otherwise */ diff --git a/apps/user_ldap/lib/ildapwrapper.php b/apps/user_ldap/lib/ildapwrapper.php index e17f787dbb6..97ae0810116 100644 --- a/apps/user_ldap/lib/ildapwrapper.php +++ b/apps/user_ldap/lib/ildapwrapper.php @@ -28,7 +28,7 @@ interface ILDAPWrapper { //LDAP functions in use /** - * @brief Bind to LDAP directory + * Bind to LDAP directory * @param resource $link LDAP link resource * @param string $dn an RDN to log in with * @param string $password the password @@ -39,7 +39,7 @@ interface ILDAPWrapper { public function bind($link, $dn, $password); /** - * @brief connect to an LDAP server + * connect to an LDAP server * @param string $host The host to connect to * @param string $port The port to connect to * @return mixed a link resource on success, otherwise false @@ -47,7 +47,7 @@ interface ILDAPWrapper { public function connect($host, $port); /** - * @brief Send LDAP pagination control + * Send LDAP pagination control * @param resource $link LDAP link resource * @param int $pageSize number of results per page * @param bool $isCritical Indicates whether the pagination is critical of not. @@ -57,7 +57,7 @@ interface ILDAPWrapper { public function controlPagedResult($link, $pageSize, $isCritical, $cookie); /** - * @brief Retrieve the LDAP pagination cookie + * Retrieve the LDAP pagination cookie * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @param string $cookie structure sent by LDAP server @@ -68,7 +68,7 @@ interface ILDAPWrapper { public function controlPagedResultResponse($link, $result, &$cookie); /** - * @brief Count the number of entries in a search + * Count the number of entries in a search * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @return int|false number of results on success, false otherwise @@ -76,21 +76,21 @@ interface ILDAPWrapper { public function countEntries($link, $result); /** - * @brief Return the LDAP error number of the last LDAP command + * Return the LDAP error number of the last LDAP command * @param resource $link LDAP link resource * @return string error message as string */ public function errno($link); /** - * @brief Return the LDAP error message of the last LDAP command + * Return the LDAP error message of the last LDAP command * @param resource $link LDAP link resource * @return int error code as integer */ public function error($link); /** - * @brief Return first result id + * Return first result id * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @return Resource an LDAP search result resource @@ -98,7 +98,7 @@ interface ILDAPWrapper { public function firstEntry($link, $result); /** - * @brief Get attributes from a search result entry + * Get attributes from a search result entry * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @return array containing the results, false on error @@ -106,7 +106,7 @@ interface ILDAPWrapper { public function getAttributes($link, $result); /** - * @brief Get the DN of a result entry + * Get the DN of a result entry * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @return string containing the DN, false on error @@ -114,7 +114,7 @@ interface ILDAPWrapper { public function getDN($link, $result); /** - * @brief Get all result entries + * Get all result entries * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @return array containing the results, false on error @@ -122,7 +122,7 @@ interface ILDAPWrapper { public function getEntries($link, $result); /** - * @brief Return next result id + * Return next result id * @param resource $link LDAP link resource * @param resource $result LDAP entry result resource * @return resource an LDAP search result resource @@ -130,7 +130,7 @@ interface ILDAPWrapper { public function nextEntry($link, $result); /** - * @brief Read an entry + * Read an entry * @param resource $link LDAP link resource * @param array $baseDN The DN of the entry to read from * @param string $filter An LDAP filter @@ -140,7 +140,7 @@ interface ILDAPWrapper { public function read($link, $baseDN, $filter, $attr); /** - * @brief Search LDAP tree + * Search LDAP tree * @param resource $link LDAP link resource * @param string $baseDN The DN of the entry to read from * @param string $filter An LDAP filter @@ -152,7 +152,7 @@ interface ILDAPWrapper { public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0); /** - * @brief Sets the value of the specified option to be $value + * Sets the value of the specified option to be $value * @param resource $link LDAP link resource * @param string $option a defined LDAP Server option * @param int $value the new value for the option @@ -161,14 +161,14 @@ interface ILDAPWrapper { public function setOption($link, $option, $value); /** - * @brief establish Start TLS + * establish Start TLS * @param resource $link LDAP link resource * @return bool true on success, false otherwise */ public function startTls($link); /** - * @brief Sort the result of a LDAP search + * Sort the result of a LDAP search * @param resource $link LDAP link resource * @param resource $result LDAP result resource * @param string $sortFilter attribute to use a key in sort @@ -176,7 +176,7 @@ interface ILDAPWrapper { public function sort($link, $result, $sortFilter); /** - * @brief Unbind from LDAP directory + * Unbind from LDAP directory * @param resource $link LDAP link resource * @return bool true on success, false otherwise */ @@ -185,19 +185,19 @@ interface ILDAPWrapper { //additional required methods in ownCloud /** - * @brief Checks whether the server supports LDAP + * Checks whether the server supports LDAP * @return bool true if it the case, false otherwise * */ public function areLDAPFunctionsAvailable(); /** - * @brief Checks whether PHP supports LDAP Paged Results + * Checks whether PHP supports LDAP Paged Results * @return bool true if it the case, false otherwise * */ public function hasPagedResultSupport(); /** - * @brief Checks whether the submitted parameter is a resource + * Checks whether the submitted parameter is a resource * @param resource $resource the resource variable to check * @return bool true if it is a resource, false otherwise */ diff --git a/apps/user_ldap/lib/ldap.php b/apps/user_ldap/lib/ldap.php index 212eea0d8e9..2b20b2ab738 100644 --- a/apps/user_ldap/lib/ldap.php +++ b/apps/user_ldap/lib/ldap.php @@ -204,7 +204,7 @@ class LDAP implements ILDAPWrapper { } /** - * @brief Checks whether the server supports LDAP + * Checks whether the server supports LDAP * @return boolean if it the case, false otherwise * */ public function areLDAPFunctionsAvailable() { @@ -212,7 +212,7 @@ class LDAP implements ILDAPWrapper { } /** - * @brief Checks whether PHP supports LDAP Paged Results + * Checks whether PHP supports LDAP Paged Results * @return boolean if it the case, false otherwise * */ public function hasPagedResultSupport() { @@ -222,7 +222,7 @@ class LDAP implements ILDAPWrapper { } /** - * @brief Checks whether the submitted parameter is a resource + * Checks whether the submitted parameter is a resource * @param Resource $resource the resource variable to check * @return bool true if it is a resource, false otherwise */ diff --git a/apps/user_ldap/lib/ldaputility.php b/apps/user_ldap/lib/ldaputility.php index 0d942f3b6ae..aa1e75e928b 100644 --- a/apps/user_ldap/lib/ldaputility.php +++ b/apps/user_ldap/lib/ldaputility.php @@ -27,7 +27,7 @@ abstract class LDAPUtility { protected $ldap; /** - * @brief constructor, make sure the subclasses call this one! + * constructor, make sure the subclasses call this one! * @param ILDAPWrapper $ldapWrapper an instance of an ILDAPWrapper */ public function __construct(ILDAPWrapper $ldapWrapper) { diff --git a/apps/user_ldap/lib/proxy.php b/apps/user_ldap/lib/proxy.php index f7ba9082e09..d15d1ae8616 100644 --- a/apps/user_ldap/lib/proxy.php +++ b/apps/user_ldap/lib/proxy.php @@ -90,7 +90,7 @@ abstract class Proxy { abstract protected function walkBackends($id, $method, $parameters); /** - * @brief Takes care of the request to the User backend + * Takes care of the request to the User backend * @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 diff --git a/apps/user_ldap/lib/wizard.php b/apps/user_ldap/lib/wizard.php index d1f3f7bf3f1..b8a0e5ad799 100644 --- a/apps/user_ldap/lib/wizard.php +++ b/apps/user_ldap/lib/wizard.php @@ -44,7 +44,7 @@ class Wizard extends LDAPUtility { const LDAP_NW_TIMEOUT = 4; /** - * @brief Constructor + * Constructor * @param Configuration $configuration an instance of Configuration * @param ILDAPWrapper $ldap an instance of ILDAPWrapper */ @@ -162,7 +162,7 @@ class Wizard extends LDAPUtility { } /** - * @brief return the state of the Group Filter Mode + * return the state of the Group Filter Mode * @return WizardResult */ public function getGroupFilterMode() { @@ -171,7 +171,7 @@ class Wizard extends LDAPUtility { } /** - * @brief return the state of the Login Filter Mode + * return the state of the Login Filter Mode * @return WizardResult */ public function getLoginFilterMode() { @@ -180,7 +180,7 @@ class Wizard extends LDAPUtility { } /** - * @brief return the state of the User Filter Mode + * return the state of the User Filter Mode * @return WizardResult */ public function getUserFilterMode() { @@ -189,7 +189,7 @@ class Wizard extends LDAPUtility { } /** - * @brief return the state of the mode of the specified filter + * return the state of the mode of the specified filter * @param string $confKey contains the access key of the Configuration */ private function getFilterMode($confKey) { @@ -201,7 +201,7 @@ class Wizard extends LDAPUtility { } /** - * @brief detects the available LDAP attributes + * detects the available LDAP attributes * @return array The instance's WizardResult instance * @throws \Exception */ @@ -235,7 +235,7 @@ class Wizard extends LDAPUtility { } /** - * @brief detects the available LDAP groups + * detects the available LDAP groups * @return WizardResult the instance's WizardResult instance */ public function determineGroupsForGroups() { @@ -245,7 +245,7 @@ class Wizard extends LDAPUtility { } /** - * @brief detects the available LDAP groups + * detects the available LDAP groups * @return WizardResult the instance's WizardResult instance */ public function determineGroupsForUsers() { @@ -254,7 +254,7 @@ class Wizard extends LDAPUtility { } /** - * @brief detects the available LDAP groups + * detects the available LDAP groups * @param string $dbKey * @param string $confKey * @param bool $testMemberOf @@ -310,7 +310,7 @@ class Wizard extends LDAPUtility { } /** - * @brief Detects the available object classes + * Detects the available object classes * @return WizardResult the instance's WizardResult instance * @throws \Exception */ @@ -337,7 +337,7 @@ class Wizard extends LDAPUtility { } /** - * @brief detects the available object classes + * detects the available object classes * @return WizardResult * @throws \Exception */ @@ -479,7 +479,7 @@ class Wizard extends LDAPUtility { } /** - * @brief tries to determine a base dn from User DN or LDAP Host + * tries to determine a base dn from User DN or LDAP Host * @return WizardResult|false WizardResult on success, false otherwise */ public function guessBaseDN() { @@ -519,7 +519,7 @@ class Wizard extends LDAPUtility { } /** - * @brief sets the found value for the configuration key in the WizardResult + * sets the found value for the configuration key in the WizardResult * as well as in the Configuration instance * @param string $key the configuration key * @param string $value the (detected) value @@ -531,7 +531,7 @@ class Wizard extends LDAPUtility { } /** - * @brief Checks, whether a port was entered in the Host configuration + * Checks, whether a port was entered in the Host configuration * field. In this case the port will be stripped off, but also stored as * setting. */ @@ -549,7 +549,7 @@ class Wizard extends LDAPUtility { } /** - * @brief tries to detect the group member association attribute which is + * tries to detect the group member association attribute which is * one of 'uniqueMember', 'memberUid', 'member' * @return string|false, string with the attribute name, false on error * @throws \Exception @@ -591,7 +591,7 @@ class Wizard extends LDAPUtility { } /** - * @brief Checks whether for a given BaseDN results will be returned + * Checks whether for a given BaseDN results will be returned * @param string $base the BaseDN to test * @return bool true on success, false otherwise * @throws \Exception @@ -617,7 +617,7 @@ class Wizard extends LDAPUtility { } /** - * @brief Checks whether the server supports memberOf in LDAP Filter. + * Checks whether the server supports memberOf in LDAP Filter. * Requires that groups are determined, thus internally called from within * determineGroups() * @return bool true if it does, false otherwise @@ -658,7 +658,7 @@ class Wizard extends LDAPUtility { } /** - * @brief creates an LDAP Filter from given configuration + * creates an LDAP Filter from given configuration * @param integer $filterType int, for which use case the filter shall be created * can be any of self::LFILTER_USER_LIST, self::LFILTER_LOGIN or * self::LFILTER_GROUP_LIST @@ -877,7 +877,7 @@ class Wizard extends LDAPUtility { } /** - * @brief checks whether a valid combination of agent and password has been + * checks whether a valid combination of agent and password has been * provided (either two values or nothing for anonymous connect) * @return bool, true if everything is fine, false otherwise */ @@ -905,7 +905,7 @@ class Wizard extends LDAPUtility { } /** - * @brief does a cumulativeSearch on LDAP to get different values of a + * does a cumulativeSearch on LDAP to get different values of a * 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 @@ -981,7 +981,7 @@ class Wizard extends LDAPUtility { } /** - * @brief determines if and which $attr are available on the LDAP server + * determines if and which $attr are available on the LDAP server * @param string[] $objectclasses the objectclasses to use as search filter * @param string $attr the attribute to look for * @param string $dbkey the dbkey of the setting the feature is connected to @@ -1040,7 +1040,7 @@ class Wizard extends LDAPUtility { } /** - * @brief appends a list of values fr + * appends a list of values fr * @param resource $result the return value from ldap_get_attributes * @param string $attribute the attribute values to look for * @param array &$known new values will be appended here |