PHP 인터페이스 Adldap\Connections\ConnectionInterface

Interface ConnectionInterface
파일 보기 프로젝트 열기: adldap2/adldap2 0 사용 예제들

공개 메소드들

메소드 설명
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