PHP Class LdapTools\Operation\QueryOperation

Author: Chad Sikorra ([email protected])
Inheritance: implements LdapTools\Operation\LdapOperationInterface, use trait LdapOperationTrait
Mostra file Open project: ldaptools/ldaptools Class Usage Examples

Protected Properties

Property Type Description
$functionMap array
$properties array

Public Methods

Method Description
__clone ( ) Make sure to clone an OperatorCollection instance.
__construct ( string | OperatorCollection $filter, array $attributes = [] )
getArguments ( )
getAttributes ( ) : array | null Get the attributes to be selected by the query operation.
getBaseDn ( ) : string Get the base DN for the LDAP query operation.
getFilter ( ) : string | OperatorCollection Get the filter for the LDAP query operation.
getLdapFunction ( )
getLogArray ( )
getName ( )
getPageSize ( ) : integer | null Get the page size used for the LDAP query operation.
getScope ( ) : null | string Get the scope type for the query operation.
getSizeLimit ( ) : integer Get the size limit for the number of entries returned from LDAP. When set to 0 this means no limit.
getUsePaging ( ) : boolean | null Get whether or not paging should be used for the query operation.
setAttributes ( array $attributes ) Set the attributes to be selected for the query operation.
setBaseDn ( string $baseDn ) Set the base DN for the LDAP query operation.
setFilter ( string | OperatorCollection $filter ) Set the LDAP filter for the query operation.
setPageSize ( integer $pageSize ) Set the page size used by the LDAP query operation.
setScope ( $scope ) Set the scope for the LDAP query operation.
setSizeLimit ( integer $sizeLimit ) Set the size limit for the number of entries returned from LDAP. When set to 0 this means no limit.
setUsePaging ( boolean $paging ) Set whether or not paging should be used for the query operation.

Protected Methods

Method Description
getLdapFilter ( ) : string

Method Details

__clone() public method

Make sure to clone an OperatorCollection instance.
public __clone ( )

__construct() public method

public __construct ( string | OperatorCollection $filter, array $attributes = [] )
$filter string | LdapTools\Query\OperatorCollection
$attributes array

getArguments() public method

public getArguments ( )

getAttributes() public method

Get the attributes to be selected by the query operation.
public getAttributes ( ) : array | null
return array | null

getBaseDn() public method

Get the base DN for the LDAP query operation.
public getBaseDn ( ) : string
return string

getFilter() public method

Get the filter for the LDAP query operation.
public getFilter ( ) : string | OperatorCollection
return string | LdapTools\Query\OperatorCollection

getLdapFilter() protected method

protected getLdapFilter ( ) : string
return string

getLdapFunction() public method

public getLdapFunction ( )

getLogArray() public method

public getLogArray ( )

getName() public method

public getName ( )

getPageSize() public method

Get the page size used for the LDAP query operation.
public getPageSize ( ) : integer | null
return integer | null

getScope() public method

Get the scope type for the query operation.
public getScope ( ) : null | string
return null | string

getSizeLimit() public method

Get the size limit for the number of entries returned from LDAP. When set to 0 this means no limit.
public getSizeLimit ( ) : integer
return integer

getUsePaging() public method

Get whether or not paging should be used for the query operation.
public getUsePaging ( ) : boolean | null
return boolean | null

setAttributes() public method

Set the attributes to be selected for the query operation.
public setAttributes ( array $attributes )
$attributes array

setBaseDn() public method

Set the base DN for the LDAP query operation.
public setBaseDn ( string $baseDn )
$baseDn string

setFilter() public method

Set the LDAP filter for the query operation.
public setFilter ( string | OperatorCollection $filter )
$filter string | LdapTools\Query\OperatorCollection

setPageSize() public method

Set the page size used by the LDAP query operation.
public setPageSize ( integer $pageSize )
$pageSize integer

setScope() public method

Set the scope for the LDAP query operation.
public setScope ( $scope )
$scope

setSizeLimit() public method

Set the size limit for the number of entries returned from LDAP. When set to 0 this means no limit.
public setSizeLimit ( integer $sizeLimit )
$sizeLimit integer

setUsePaging() public method

Set whether or not paging should be used for the query operation.
public setUsePaging ( boolean $paging )
$paging boolean

Property Details

$functionMap protected_oe property

protected array $functionMap
return array

$properties protected_oe property

protected array $properties
return array