• 홈
• LdapTools
• Query
• LdapQueryBuilder

PHP 클래스 LdapTools\Query\LdapQueryBuilder

파일 보기 프로젝트 열기: ldaptools/ldaptools 1 사용 예제들

보호된 프로퍼티들

프로퍼티	타입	설명
$baseAnd		The base 'And' operator when the method 'where' or 'andWhere' is used.
$baseOr		The base 'Or' operator when the method 'orWhere' is used.
$connection		The LDAP connection.
$filterBuilder	LdapTools\Query\Builder\FilterBuilder | LdapTools\Query\Builder\ADFilterBuilder
$hydrator	LdapTools\Hydrator\OperationHydrator
$operation		The operation that will eventually be sent to the LDAP connection.
$orderBy		The attributes to order by, if any. They will be in ['attribute' => 'ASC'] form.
$schemaFactory	LdapTools\Factory\LdapObjectSchemaFactory

공개 메소드들

메소드	설명
__call ( string $method, array $arguments ) : mixed	Determines which function, if any, should be called.
__construct ( LdapTools\Connection\LdapConnectionInterface $connection = null, LdapObjectSchemaFactory $schemaFactory = null )
add ( variadic $operators )	Add an operator object to the query.
addControl ( variadic $controls )	Add LDAP controls to be used for the query.
addOrderBy ( string $attribute, string $direction )	Add an attribute to be ordered for the returned results and set the direction for the ordering.
andWhere ( $whereStatements )	Adds additional operators or equality comparisons to the 'and' statement.
filter ( ) : FilterBuilder | ADFilterBuilder	Call this to help build additional query statements in an object-oriented fashion.
from ( mixed $type, null | string $alias = null )	Add object types used to narrow the query. This can either be a string name representing the object type from the schema, such as 'user' or 'group' or you can pass the LdapObjectSchema for the type. If you are using this class without a schema then construct the query manually by just using the "where" and "andWhere" methods.
fromGroups ( string | null $alias = null )	A convenience method to select from group object types.
fromOUs ( string | null $alias = null )	A convenience method to select from OU object types.
fromUsers ( string | null $alias = null )	A convenience method to select from user object types.
getAttributes ( ) : array	Get the attributes selected for this query.
getBaseDn ( ) : string	Get the base DN for the query.
getLdapFilter ( ) : string	Get the LDAP filter formed by this query.
getLdapQuery ( ) : LdapQuery	Get the LdapQuery object based on the constructed filter and parameters in this builder.
getPageSize ( ) : integer	Get the page size for the query.
getScope ( ) : string	Get the scope for the query (ie. subtree, onelevel, base).
getServer ( ) : null | string	Get the specific LDAP server that the query should be run on, if any is set.
getSizeLimit ( ) : integer	Get the size limit for the amount of results returned from LDAP for the query.
getUsePaging ( ) : boolean	Get whether or not paging should be used for the query.
orWhere ( $whereStatements )	Create a logical 'or' from the passed arguments. Either pass a key => value array with attribute names and expected values (which will be compared in terms of equality) or pass arbitrary Operator objects using the 'filter' method shortcuts or some other way.
orderBy ( string $attribute, string $direction )	Set the attribute to order by. This will override anything already explicitly set to be ordered. To order on multiple attributes use 'addOrderBy', which allows the attribute ordering to stack.
select ( string | array $attributes = [] )	Set the attributes to select from the object. Either specify a single attribute as a string or an array of attribute names.
setBaseDn ( string $baseDn )	Sets the base DN for the query.
setPageSize ( integer $pageSize )	Set the page size for the query.
setScope ( string $scope )	Set the scope using the QueryOperation::SCOPE constant.
setScopeBase ( )	Set the scope of the query to only the entry defined by the baseDn.
setScopeOneLevel ( )	Set the scope of the query to search only the entries within the baseDn but none of its children.
setScopeSubTree ( )	Set the scope of the query to search the complete the baseDn and all children.
setServer ( string $server )	Set a specific LDAP server to run the query on.
setSizeLimit ( integer $sizeLimit )	Set the size limit for the amount of results returned from LDAP for the query.
setUsePaging ( boolean $usePaging )	Set whether or not paging should be used for the query.
toLdapFilter ( ) : string	Get the LDAP filter formed by this query.
where ( $whereStatements )	Create a logical 'and' from the passed statements. Either pass a key => value array with attribute names and expected values (which will be compared in terms of equality) or pass arbitrary Operator objects using the 'filter' method shortcuts or some other way.

보호된 메소드들

메소드	설명
addBaseAndIfNotExists ( )	Adds a base 'bAnd' operator for the convenience 'where', 'andWhere' methods only if it does not already exist.
addBaseOrIfNotExists ( )	Adds a base 'bOr' operator for the convenience 'orWhere' method only if it does not already exist.
getSchemaFromType ( string | LdapObjectSchema $type ) : LdapObjectSchema

메소드 상세

프로퍼티 상세