tyler.durden/icingaweb2
1
0
Fork 0
mirror of https://github.com/Icinga/icingaweb2.git synced 2025-07-27 15:54:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Ldap\Connection: Fix existing documentation

Browse Source 
Part #2

refs #8954
This commit is contained in:
Johannes Meyer 2015-06-23 17:38:19 +02:00
parent f234b3b768
commit 7921e62a0c
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
library/Icinga/Protocol/Ldap/Connection.php
View File

@ -581,14 +581,14 @@ class Connection implements Selectable
} }
/** /**
* Run the given LDAP query and return the resulting entries
* *
* Execute the given LDAP query and return the resulting entries * @param Query $query The query to fetch results with
* @param array $fields Request these attributes instead of the ones registered in the given query
* *
* @param Query $query The query to execute * @return array
* @param array $fields The fields that will be fetched from the matches
* *
* @return array The matched entries * @throws LdapException In case an error occured while fetching the results
* @throws LdapException
*/ */
protected function runQuery(Query $query, array $fields = null) protected function runQuery(Query $query, array $fields = null)
{ {
@ -872,11 +872,11 @@ class Connection implements Selectable
} }
/** /**
* * Prepare and establish a connection with the LDAP server
* Connect to the given ldap server and apply settings depending on the discovered capabilities
* *
* @return resource A positive LDAP link identifier * @return resource A positive LDAP link identifier
* @throws LdapException When the connection is not possible *
* @throws LdapException In case the connection is not possible
*/ */
protected function prepareNewConnection() protected function prepareNewConnection()
{ {
@ -959,13 +959,13 @@ class Connection implements Selectable
} }
/** /**
* Discover the capabilities of the given LDAP server
* *
* Discover the capabilities of the given ldap-server * @param resource $ds The link identifier of the current LDAP connection
* *
* @param resource $ds The link identifier of the current ldap connection * @return Capability
* *
* @return Capability The capabilities * @throws LdapException In case the capability query has failed
* @throws LdapException When the capability query fails
*/ */
protected function discoverCapabilities($ds) protected function discoverCapabilities($ds)
{ {