PHP Интерфейс Adldap\Connections\ConnectionInterface

Interface ConnectionInterface
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
add ( string $dn, array $entry ) : boolean Adds an entry to the current connection.
bind ( string $username, string $password, boolean $sasl = false ) : boolean Binds to the current connection using the specified username and password. If sasl is true, the current connection is bound using SASL.
canChangePasswords ( ) : boolean Returns true / false if the current connection is able to modify passwords.
close ( ) : boolean Closes the current connection.
compare ( string $dn, string $attribute, string $value ) : mixed Compare value of attribute found in entry specified with DN.
connect ( string | array $hostname = [], integer $port = 389 ) : mixed Connects to the specified hostname using the specified port.
controlPagedResult ( integer $pageSize = 1000, boolean $isCritical = false, string $cookie = '' ) : mixed Send LDAP pagination control.
controlPagedResultResponse ( $result, string &$cookie ) : mixed Retrieve a paginated result response.
countEntries ( $searchResult ) : integer Returns the number of entries from a search result.
delete ( string $dn ) : boolean Deletes an entry on the current connection.
err2Str ( integer $number ) : string Returns the error string of the specified error number.
errNo ( ) : integer Returns the error number of the last command executed on the current connection.
extractDiagnosticCode ( string $message ) : string | boolean Extract the diagnostic code from the message.
getAttributes ( $entry ) : mixed Retrieves the ldap entry's attributes.
getConnection ( ) : mixed Get the current connection.
getDiagnosticMessage ( ) : string Return the diagnostic Message.
getEntries ( $searchResult ) : mixed Retrieve the entries from a search result.
getExtendedError ( ) : string Returns the extended error string of the last command.
getExtendedErrorCode ( ) : string Returns the extended error code of the last command.
getExtendedErrorHex ( ) : string | null Returns the extended error hex code of the last command.
getFirstEntry ( $searchResult ) : mixed Retrieves the first entry from a search result.
getLastError ( ) : string Retrieve the last error on the current connection.
getNextEntry ( $entry ) : mixed Retrieves the next entry from a search result.
getValuesLen ( $entry, $attribute ) : array Get all binary values from the specified result entry.
isBatchSupported ( ) : boolean Returns true / false if the current connection supports batch modification.
isBound ( ) : boolean Returns true / false if the current connection is bound.
isPagingSupported ( ) : boolean Returns true / false if the current connection pagination.
isSaslSupported ( ) : boolean Returns true / false if the current connection supports SASL for single sign on capability.
isSupported ( ) : boolean Returns true / false if the current connection is supported on the current PHP install.
isUsingSSL ( ) : boolean Returns true / false if the current connection instance is using SSL.
isUsingTLS ( ) : boolean Returns true / false if the current connection instance is using TLS.
listing ( string $dn, string $filter, array $attributes ) : mixed Performs a single level search on the current connection.
modAdd ( string $dn, array $entry ) : mixed Add attribute values to current attributes.
modDelete ( string $dn, array $entry ) : mixed Delete attribute values from current attributes.
modReplace ( string $dn, array $entry ) : mixed Replaces attribute values with new ones.
modify ( string $dn, array $entry ) : boolean Modifies an existing entry on the current connection.
modifyBatch ( string $dn, array $values ) : mixed Batch modifies an existing entry on the current connection.
read ( string $dn, $filter, array $fields ) : mixed Reads an entry on the current connection.
rename ( string $dn, string $newRdn, string $newParent, boolean $deleteOldRdn = false ) : boolean Modify the name of an entry on the current connection.
search ( string $dn, string $filter, array $fields ) : mixed
setOption ( integer $option, mixed $value ) : mixed Sets an option on the current connection.
setOptions ( array $options = [] ) : mixed Sets options on the current connection.
setRebindCallback ( callable $callback ) : boolean Set a callback function to do re-binds on referral chasing.
ssl ( boolean $enabled = true ) : Adldap\Connections\ConnectionInterface Sets the current connection to use SSL.
startTLS ( ) : mixed Starts a connection using TLS.
tls ( boolean $enabled = true ) : Adldap\Connections\ConnectionInterface Sets the current connection to use TLS.

Описание методов

add() публичный метод

Adds an entry to the current connection.
public add ( string $dn, array $entry ) : boolean
$dn string
$entry array
Результат boolean

bind() публичный метод

Binds to the current connection using the specified username and password. If sasl is true, the current connection is bound using SASL.
public bind ( string $username, string $password, boolean $sasl = false ) : boolean
$username string
$password string
$sasl boolean
Результат boolean

canChangePasswords() публичный метод

Returns true / false if the current connection is able to modify passwords.
public canChangePasswords ( ) : boolean
Результат boolean

close() публичный метод

Returns false if no connection is present.
public close ( ) : boolean
Результат boolean

compare() публичный метод

Compare value of attribute found in entry specified with DN.
public compare ( string $dn, string $attribute, string $value ) : mixed
$dn string
$attribute string
$value string
Результат mixed

connect() публичный метод

Connects to the specified hostname using the specified port.
public connect ( string | array $hostname = [], integer $port = 389 ) : mixed
$hostname string | array
$port integer
Результат mixed

controlPagedResult() публичный метод

Send LDAP pagination control.
public controlPagedResult ( integer $pageSize = 1000, boolean $isCritical = false, string $cookie = '' ) : mixed
$pageSize integer
$isCritical boolean
$cookie string
Результат mixed

controlPagedResultResponse() публичный метод

Retrieve a paginated result response.
public controlPagedResultResponse ( $result, string &$cookie ) : mixed
$result
$cookie string
Результат mixed

countEntries() публичный метод

Returns the number of entries from a search result.
public countEntries ( $searchResult ) : integer
$searchResult
Результат integer

delete() публичный метод

Deletes an entry on the current connection.
public delete ( string $dn ) : boolean
$dn string
Результат boolean

err2Str() публичный метод

Returns the error string of the specified error number.
public err2Str ( integer $number ) : string
$number integer
Результат string

errNo() публичный метод

Returns the error number of the last command executed on the current connection.
public errNo ( ) : integer
Результат integer

extractDiagnosticCode() публичный метод

Extract the diagnostic code from the message.
public extractDiagnosticCode ( string $message ) : string | boolean
$message string
Результат string | boolean

getAttributes() публичный метод

Retrieves the ldap entry's attributes.
public getAttributes ( $entry ) : mixed
$entry
Результат mixed

getConnection() публичный метод

Get the current connection.
public getConnection ( ) : mixed
Результат mixed

getDiagnosticMessage() публичный метод

Return the diagnostic Message.
public getDiagnosticMessage ( ) : string
Результат string

getEntries() публичный метод

Retrieve the entries from a search result.
public getEntries ( $searchResult ) : mixed
$searchResult
Результат mixed

getExtendedError() публичный метод

Returns the extended error string of the last command.
public getExtendedError ( ) : string
Результат string

getExtendedErrorCode() публичный метод

Returns the extended error code of the last command.
public getExtendedErrorCode ( ) : string
Результат string

getExtendedErrorHex() публичный метод

Returns the extended error hex code of the last command.
public getExtendedErrorHex ( ) : string | null
Результат string | null

getFirstEntry() публичный метод

Retrieves the first entry from a search result.
public getFirstEntry ( $searchResult ) : mixed
$searchResult
Результат mixed

getLastError() публичный метод

Retrieve the last error on the current connection.
public getLastError ( ) : string
Результат string

getNextEntry() публичный метод

Retrieves the next entry from a search result.
public getNextEntry ( $entry ) : mixed
$entry
Результат mixed

getValuesLen() публичный метод

Get all binary values from the specified result entry.
public getValuesLen ( $entry, $attribute ) : array
$entry
$attribute
Результат array

isBatchSupported() публичный метод

Returns true / false if the current connection supports batch modification.
public isBatchSupported ( ) : boolean
Результат boolean

isBound() публичный метод

Returns true / false if the current connection is bound.
public isBound ( ) : boolean
Результат boolean

isPagingSupported() публичный метод

Returns true / false if the current connection pagination.
public isPagingSupported ( ) : boolean
Результат boolean

isSaslSupported() публичный метод

Returns true / false if the current connection supports SASL for single sign on capability.
public isSaslSupported ( ) : boolean
Результат boolean

isSupported() публичный метод

Returns true / false if the current connection is supported on the current PHP install.
public isSupported ( ) : boolean
Результат boolean

isUsingSSL() публичный метод

Returns true / false if the current connection instance is using SSL.
public isUsingSSL ( ) : boolean
Результат boolean

isUsingTLS() публичный метод

Returns true / false if the current connection instance is using TLS.
public isUsingTLS ( ) : boolean
Результат boolean

listing() публичный метод

Performs a single level search on the current connection.
public listing ( string $dn, string $filter, array $attributes ) : mixed
$dn string
$filter string
$attributes array
Результат mixed

modAdd() публичный метод

Add attribute values to current attributes.
public modAdd ( string $dn, array $entry ) : mixed
$dn string
$entry array
Результат mixed

modDelete() публичный метод

Delete attribute values from current attributes.
public modDelete ( string $dn, array $entry ) : mixed
$dn string
$entry array
Результат mixed

modReplace() публичный метод

Replaces attribute values with new ones.
public modReplace ( string $dn, array $entry ) : mixed
$dn string
$entry array
Результат mixed

modify() публичный метод

Modifies an existing entry on the current connection.
public modify ( string $dn, array $entry ) : boolean
$dn string
$entry array
Результат boolean

modifyBatch() публичный метод

Batch modifies an existing entry on the current connection.
public modifyBatch ( string $dn, array $values ) : mixed
$dn string
$values array
Результат mixed

read() публичный метод

Reads an entry on the current connection.
public read ( string $dn, $filter, array $fields ) : mixed
$dn string
$filter
$fields array
Результат mixed

rename() публичный метод

Modify the name of an entry on the current connection.
public rename ( string $dn, string $newRdn, string $newParent, boolean $deleteOldRdn = false ) : boolean
$dn string
$newRdn string
$newParent string
$deleteOldRdn boolean
Результат boolean

setOption() публичный метод

Sets an option on the current connection.
public setOption ( integer $option, mixed $value ) : mixed
$option integer
$value mixed
Результат mixed

setOptions() публичный метод

Sets options on the current connection.
public setOptions ( array $options = [] ) : mixed
$options array
Результат mixed

setRebindCallback() публичный метод

Set a callback function to do re-binds on referral chasing.
public setRebindCallback ( callable $callback ) : boolean
$callback callable
Результат boolean

ssl() публичный метод

Sets the current connection to use SSL.
public ssl ( boolean $enabled = true ) : Adldap\Connections\ConnectionInterface
$enabled boolean
Результат Adldap\Connections\ConnectionInterface

startTLS() публичный метод

Starts a connection using TLS.
public startTLS ( ) : mixed
Результат mixed

tls() публичный метод

Sets the current connection to use TLS.
public tls ( boolean $enabled = true ) : Adldap\Connections\ConnectionInterface
$enabled boolean
Результат Adldap\Connections\ConnectionInterface