PHP Class LdapTools\Operation\Handler\QueryOperationHandler

Author: Chad Sikorra ([email protected])
Inheritance: implements LdapTools\Operation\Handler\OperationHandlerInterface, use trait OperationHandlerTrait
Exibir arquivo Open project: ldaptools/ldaptools Class Usage Examples

Protected Properties

Property Type Description
$paging LdapTools\Connection\PageControl

Public Methods

Method Description
__construct ( PageControl $paging = null )
execute ( LdapTools\Operation\LdapOperationInterface $operation )
parentSetDefaults ( )
setOperationDefaults ( LdapTools\Operation\LdapOperationInterface $operation )
supports ( LdapTools\Operation\LdapOperationInterface $operation )

Protected Methods

Method Description
getBaseDn ( ) : string Gets the base DN for a search based off of the config and then the RootDSE.
paging ( ) : PageControl
processSearchResult ( resource $result, array $allEntries ) : array Process a LDAP search result and merge it with the existing entries if possible.
shouldUsePaging ( QueryOperation $operation ) : boolean Based on the query operation, determine whether paging should be used.

Method Details

__construct() public method

public __construct ( PageControl $paging = null )
$paging LdapTools\Connection\PageControl

execute() public method

public execute ( LdapTools\Operation\LdapOperationInterface $operation )
$operation LdapTools\Operation\LdapOperationInterface

getBaseDn() protected method

Gets the base DN for a search based off of the config and then the RootDSE.
protected getBaseDn ( ) : string
return string

paging() protected method

protected paging ( ) : PageControl
return LdapTools\Connection\PageControl

parentSetDefaults() public method

public parentSetDefaults ( )

processSearchResult() protected method

Process a LDAP search result and merge it with the existing entries if possible.
protected processSearchResult ( resource $result, array $allEntries ) : array
$result resource
$allEntries array
return array

setOperationDefaults() public method

public setOperationDefaults ( LdapTools\Operation\LdapOperationInterface $operation )
$operation LdapTools\Operation\LdapOperationInterface

shouldUsePaging() protected method

Based on the query operation, determine whether paging should be used.
protected shouldUsePaging ( QueryOperation $operation ) : boolean
$operation LdapTools\Operation\QueryOperation
return boolean

supports() public method

public supports ( LdapTools\Operation\LdapOperationInterface $operation )
$operation LdapTools\Operation\LdapOperationInterface

Property Details

$paging protected_oe property

protected PageControl,LdapTools\Connection $paging
return LdapTools\Connection\PageControl