Available Search Methods (API)
Method Listing
addControl
Add a server control to be executed with the LDAP search query:
$query = $connection->query();
$query->addControl(
$oid = '1.2.840.113556.1.4.417', $isCritical = true, $value = null
);
// array:1 [▼
// "1.2.840.113556.1.4.417" => array:3 [▼
// "oid" => "1.2.840.113556.1.4.417"
// "isCritical" => true
// "value" => null
// ]
// ]
var_dump($query->controls);
addFilter
Add a filter with its bindings to the query:
Available types are
and
,or
andraw
.
$query = $connection->query();
$bindings = [
'field' => 'cn',
'operator' => '=',
'value' => 'Steve Bauman',
];
$query->addFilter($type = 'and', $bindings);
addSelect
Add an attribute to be selected for the query:
$query = $connection->query();
// Using arguments:
$query->addSelect('cn');
$query->addSelect('foo', 'bar', 'baz');
// Using an array:
$query->addSelect(['sn', 'givenname']);
// array:7 [▼
// 0 => "cn"
// 1 => "foo"
// 2 => "bar"
// 3 => "baz"
// 4 => "sn"
// 5 => "givenname"
// 6 => "objectclass"
// ]
var_dump($query->getSelects());
andFilter
Add a nested "and" filter to the query:
$query = $connection->query();
$query->andFilter(function (\LdapRecord\Query\Builder $q) {
$q->where('foo', '=', 'bar');
$q->where('baz', '=', 'zal');
});
// "(&(foo=bar)(baz=zal))"
echo $query->getUnescapedQuery();
cache
Cache the executed query until the given date has passed:
Pass
true
as the second argument to force flush the cache if the query has been executed before.
$query = $connection->query();
$until = new \DateTime('+1 day');
$query->cache($until, $flush = false);
chunk
Chunk a query
Important: This method is excellent for keeping memory usage low, since only the number of requested objects per chunk is kept in memory, not the entire result.
$connection->query()->chunk(1000, function ($objects) {
foreach ($objects as $object) {
// ...
}
});
You may also stop further chunks from being processed by returning false from the closure:
$connection->query()->chunk(1000, function ($objects) {
// ...
return false;
});
If you need to execute sub-queries inside of your chunk callback and
you're working with an LDAP server that does not support it, you may
pass in a fourth argument (or via the parameters name isolate
) to
run the chunk operation on it's own connection instance:
Important: This feature was added in v2.20.0.
$connection->query()->chunk(1000, function ($objects) {
// Model::where('...')->get();
}, isolate: true);
Once the chunk finishes (or an exception occurs), the dynamically created connection will be auto-closed.
clearFilters
Reset / clear all filters that have been added to the query:
$query = $connection->query();
$query->where('foo', '=', 'bar');
$query->clearFilters();
// array:3 [▼
// "and" => []
// "or" => []
// "raw" => []
// ]
var_dump($query->getFilters());
delete
Delete an entry from the directory:
$query = $connection->query();
$query->delete('cn=John Doe,ou=Users,dc=local,dc=com');
deleteAttributes
Delete an attributes values from the directory:
$query = $connection->query();
$entry = 'cn=Accounting Users,ou=Groups,dc=local,dc=com';
// Delete all values from an attribute, for example,
// removing all members from a particular group:
$query->deleteAttributes($entry, ['member' => []]);
// Delete a specific value from an attribute, for example,
// removing a specific member from a particular group:
$member = 'cn=John Doe,ou=Users,dc=local,dc=com';
$query->deleteAttributes($entry, ['member' => [$member]]);
each
Execute a callback over each object from a chunked query (default 1000
per chunk):
$connection->query()->each(function ($object) {
// ...
});
You may also specify a chunk size in the method's second parameter:
$connection->query()->each(function ($object) {
// ...
}, $chunk = 500);
Similarly with chunk
, you may pass in a fourth argument
(or via its named parameter isolate
), to run the chunk
operation on it's own connection instance:
Important: This feature was added in v2.20.0.
$connection->query()->each(function ($object) {
// Model::where('...')->get();
}, isolate: true);
Once the underlying chunk finishes (or an exception occurs), the dynamically created connection will be auto-closed.
escape
Prepare a value to be escaped:
This method accepts the same parameters as the built in PHP
ldap_escape
method.
$query = $connection->query();
// Returns instance of:
// LdapRecord\Models\Attributes\EscapedValue
$value = $query->escape('value', $ignore = '', $flags = 0);
// Prepare the value to be escaped for use in a distinguished name:
$value->dn();
// Prepare the value to be escaped for use in a filter:
$value->filter();
// Prepare the value to be escaped for use in a distinguished name and filter:
$value->both();
// Set the characters to ignore:
$value->ignore('/*');
// Get the escaped value:
$value->get();
// Can also be casted to string:
(string) $value;
find
Find an entry in the directory by its distinguished name:
$query = $connection->query();
if ($entry = $query->find('cn=John Doe,dc=local,dc=com')) {
// Found entry!
} else {
// Not found.
}
findBy
Find the first matching entry in the directory by the given attribute and value:
$query = $connection->query();
if ($entry = $query->findBy('samaccountname', 'johndoe')) {
// Found entry!
} else {
// Not found.
}
findByOrFail
Find the first matching entry in the directory by the given attribute and value or fail:
$query = $connection->query();
try {
$entry = $query->findByOrFail('samaccountname', 'johndoe');
} catch (\LdapRecord\Models\ModelNotFoundException $ex) {
// Not found.
}
findMany
Find many entries in the directory by an array of Distinguished Names:
$query = $connection->query();
$entries = $query->findMany([
'cn=John Doe,dc=local,dc=com',
'ou=Accounting,dc=local,dc=com',
]);
findManyBy
Find many entries in the directory by the given attribute and values:
$query = $connection->query();
$entries = $query->findManyBy('samaccountname', ['johndoe', 'janedoe', 'sbauman']);
findOrFail
Find an entry in the directory by its distinguished name or fail:
$query = $connection->query();
try {
$entry = $query->findOrFail('cn=John Doe,dc=local,dc=com');
} catch (\LdapRecord\Models\ModelNotFoundException $ex) {
// Not found.
}
first
Get the first resulting entry of a query from the directory:
$query = $connection->query();
$entry = $query->whereStartsWith('cn', 'Steve')->first();
firstOrFail
Get the first resulting entry of a query from the directory or fail:
$query = $connection->query();
try {
$entry = $query->whereStartsWith('cn', 'Steve')->first();
} catch (\LdapRecord\Models\ModelNotFoundException $ex) {
// Not entries returned.
}
forPage
Important: Your LDAP server must support Virtual List View.
The forPage
supports the same arguments and executes the same underlying
query as the slice method, but it will return query results
directly, instead of being wrapped in a Slice
object:
$query = $connection->query();
$results = $query->forPage($page = 1, $perPage = 1000);
get
Get the resulting entries of a query from the directory:
Important: If you expect to have more than 1000 entries returned from your query, use the paginate method instead, which will return all entries.
$query = $connection->query();
$entries = $query->where('company', '=', 'Acme')->get();
getCache
Get the query cache (if set):
$query = $connection->query();
// Returns null or instance of LdapRecord\Query\Cache:
$cache = $query->getCache();
getConnection
Get the underlying connection the query is executing on:
$query = $connection->query();
// Returns instance of LdapRecord\Connection:
$conn = $query->getConnection();
getDn
Get the base Distinguished Name that the query is executing on:
$query = $connection->query();
$query->setDn('ou=Users,dc=local,dc=com');
// Returns 'ou=Users,dc=local,dc=com':
$base = $query->getDn();
getFilters
Get the filters that have been added to the query:
$query = $connection->query();
$query->where('company', '=', 'Acme');
// array:3 [▼
// "and" => array:1 [▼
// 0 => array:3 [▼
// "field" => "company"
// "operator" => "="
// "value" => LdapRecord\Models\Attributes\EscapedValue
// ]
// ]
// "or" => []
// "raw" => []
// ]
var_dump($query->getFilters());
getGrammar
Get the underlying query grammar instance:
$query = $connection->query();
// Returns instance of LdapRecord\Query\Grammar:
$grammar = $query->getGrammar();
getQuery
Get the raw, escaped LDAP query filter:
$query = $connection->query();
$query->where('company', '=', 'Acme');
// Returns '(company=\41\63\6d\65)'
$filter = $query->getQuery();
getSelects
Get the selected attributes of the query:
Important:
objectclass
will always be included in the returned array.
$query = $connection->query();
// array:1 [▼
// 0 => "objectclass"
// ]
var_dump($query->getSelects());
$query->select(['cn', 'mail', 'givenname']);
// array:4 [▼
// 0 => "cn"
// 1 => "mail"
// 2 => "givenname"
// 3 => "objectclass"
// ]
var_dump($query->getSelects());
getType
Get the type of LDAP query to be executed, either search
, listing
or read
:
$query = $connection->query();
// Returns 'search':
$query->getType();
// Returns 'listing':
$query->listing()->getType();
// Returns 'read':
$query->read()->getType();
getUnescapedQuery
Get the raw, unescaped LDAP query filter:
$query = $connection->query();
$query->where('company', '=', 'Acme');
// Returns '(company=Acme)'
$filter = $query->getUnescapedQuery();
hasControl
Determine if the query has a specific LDAP control OID added:
$query = $connection->query();
if ($query->hasControl($oid = '1.2.840.113556.1.4.417')) {
// The query has a control added for the OID.
}
hasSelects
Determine if the query has any selects added:
$query = $connection->query();
// Returns false:
$query->hasSelects();
$query->select(['cn', 'sn']);
// Returns true:
$query->hasSelects();
in
Sets the base Distinguished Name to perform a search upon.
Alias for the setDn method.
$query = $connection->query();
// Get all entries below the 'Users' OU:
$query->in('ou=Users,dc=local,dc=com')->get();
insert
Insert a new entry in the directory:
$query = $connection->query();
$dn = 'cn=John Doe,dc=local,dc=com';
$attributes = [
'cn' => 'John Doe',
'objectclass' => [
'top',
'person',
'organizationalperson',
'user',
],
];
$query->insert($dn, $attributes);
insertAttributes
Create attributes on an existing entry in the directory:
$query = $connection->query();
$dn = 'cn=John Doe,dc=local,dc=com';
$attributes = [
'company' => 'Acme',
];
$query->insertAttributes($dn, $attributes);
isNested
Determine if a query builder is nested:
$query = $connection->query();
// Returns false:
$query->isNested();
$query->andFilter(function ($q) {
// Returns true:
$q->isNested();
});
isPaginated
Determine if a query builder has been paginated:
$query = $connection->query();
// Returns false:
$query->isPaginated();
$results = $query->paginate();
// Returns true:
$query->isPaginated();
limit
Set the maxmimum number of entries to be returned from the directory:
$query = $connection->query();
$results = $query->whereHas('cn')->limit(200)->get();
listing
Perform an LDAP listing
operation, requesting only immediate children / leaf nodes of the query base:
$query = $connection->query();
// Only retrieve the immediate children / leaf nodes of the 'Groups' OU:
$groups = $query->in('ou=Groups,dc=local,dc=com')->listing()->get();
model
Create a new query builder instance for the given model:
use LdapRecord\Models\ActiveDirectory\User;
$query = $connection->query();
$modelQuery = $query->model(new User);
nested
Whether to mark the current query as nested:
Important: This affects how the query filter is generated.
$query = $connection->query();
// Returns "(cn=John)(sn=Doe)":
$query->nested()
->where('cn', '=', 'John')
->where('sn', '=', 'Doe')
->getUnescapedQuery();
// Returns "(&(cn=John)(sn=Doe))"
$query->nested(false)
->where('cn', '=', 'John')
->where('sn', '=', 'Doe')
->getUnescapedQuery();
newInstance
Create a new query instance:
$query = $connection->query();
// Create and inherit the base DN from the previous instance:
$newQuery = $query->newInstace();
// Use a new base DN:
$newQuery = $query->newInstace('ou=Users,dc=local,dc=com');
newNestedInstance
Create a new nested query instance:
$query = $connection->query();
// New nested query builder:
$nested = $query->newNestedInstance();
// New nested query builder With a closure:
$nested = $query->newNestedInstance(function (Builder $query) {
//
});
notFilter
Add a nested 'not' filter to the current query:
$query = $connection->query();
// Returns "(!(cn=John Doe))":
$query->notFilter(function ($query) {
$query->where('cn', '=', 'John Doe');
})->getUnescapedQuery();
orFilter
Add a nested 'or' filter to the current query:
$query = $connection->query();
// Returns "(|(cn=John Doe))":
$query->orFilter(function ($query) {
$query->where('cn', '=', 'John Doe');
})->getUnescapedQuery();
orWhere
Add an 'or where' clause to the query:
Important: If only a single "or" is added to the query with no other filters, it will be converted to a single filter instead.
// Returns "(cn=John)":
$connection->query()
->orWhere('cn', '=', 'John')
->getUnescapedQuery();
// Returns "(|(cn=John)(sn=Doe))":
$connection->query()
->where('cn', '=', 'John')
->orWhere('sn', '=', 'Doe')
->getUnescapedQuery();
orWhereApproximatelyEquals
Add an 'or where approximately equals' clause to the query:
// Returns "(cn~=John)"
$connection->query()
->orWhereApproximatelyEquals('cn', 'John')
->getUnescapedQuery();
// Returns "(|(cn~=Sue)(cn~=John))"
$connection->query()
->whereApproximatelyEquals('cn', 'Sue')
->orWhereApproximatelyEquals('cn', 'John')
->getUnescapedQuery();
orWhereContains
Add an 'or where contains' clause to the query:
// Returns "(cn=*John*)"
$connection->query()
->orWhereContains('cn', 'John')
->getUnescapedQuery();
// Returns "(|(cn=*Sue*)(cn=*John*))"
$connection->query()
->whereContains('cn', 'Sue')
->orWhereContains('cn', 'John')
->getUnescapedQuery();
orWhereEndsWith
Add an 'or where ends with' clause to the query:
// Returns "(cn=*Doe)"
$connection->query()
->orWhereEndsWith('cn', 'Doe')
->getUnescapedQuery();
// Returns "(|(cn=*Betty)(cn=*Doe))"
$connection->query()
->whereEndsWith('cn', 'Betty')
->orWhereEndsWith('cn', 'Doe')
->getUnescapedQuery();
orWhereEquals
Add an 'or where equals' clause to the query:
// Returns "(cn=John Doe)"
$connection->query()
->orWhereEquals('cn', 'John Doe')
->getUnescapedQuery();
// Returns "(|(cn=Suzy Doe)(cn=John Doe))"
$connection->query()
->whereEquals('cn', 'Suzy Doe')
->orWhereEquals('cn', 'John Doe')
->getUnescapedQuery();
orWhereHas
Add an 'or where has' clause to the query:
// Returns "(title=*)"
$connection->query()
->orWhereHas('title')
->getUnescapedQuery();
// Returns "(|(title=*)(department=*))"
$connection->query()
->whereHas('title')
->orWhereHas('department')
->getUnescapedQuery();
orWhereNotContains
Add an 'or where not contains' clause to the query:
// Returns "(!(title=*Accountant*))"
$connection->query()
->orWhereNotContains('title', 'Accountant')
->getUnescapedQuery();
// Returns "(|(!(title=*Accountant*))(!(department=*Accounting*)))"
$connection->query()
->whereNotContains('title', 'Accountant')
->orWhereNotContains('department', 'Accounting')
->getUnescapedQuery();
orWhereNotEndsWith
Add an 'or where not ends with' clause to the query:
// Returns "(!(cn=*Doe))"
$connection->query()
->orWhereNotEndsWith('cn', 'Doe')
->getUnescapedQuery();
// Returns "(|(!(cn=*Betty))(!(cn=*Doe)))"
$connection->query()
->whereNotEndsWith('cn', 'Betty')
->orWhereNotEndsWith('cn', 'Doe')
->getUnescapedQuery();
orWhereNotEquals
Add an 'or where not equals' clause to the query:
// Returns "(!(cn=John Doe))"
$connection->query()
->orWhereNotEquals('cn', 'John Doe')
->getUnescapedQuery();
// Returns "(|(!(cn=Suzy Betty))(!(cn=John Doe)))"
$connection->query()
->whereNotEquals('cn', 'Suzy Betty')
->orWhereNotEquals('cn', 'John Doe')
->getUnescapedQuery();
orWhereNotHas
Add an 'or where not has' clause to the query:
// Returns "(!(title=*))"
$connection->query()
->orWhereNotHas('title')
->getUnescapedQuery();
// Returns "(|(!(title=*))(!(department=*)))"
$connection->query()
->whereNotHas('title')
->orWhereNotHas('department')
->getUnescapedQuery();
orWhereNotStartsWith
Add an 'or where not starts with' clause to the query:
// Returns "(!(cn=John*))"
$connection->query()
->orWhereNotStartsWith('cn', 'John')
->getUnescapedQuery();
// Returns "(|(!(cn=Suzy*))(!(cn=John*)))"
$connection->query()
->whereNotStartsWith('cn', 'Suzy')
->orWhereNotStartsWith('cn', 'John')
->getUnescapedQuery();
orWhereRaw
Add a "or where" clause to the query without escaping the value, useful when values can contain distinguished names or GUIDs:
$query = $connection->query();
$query
->whereRaw('objectguid', '=', '270db4d0-249d-46a7-9cc5-eb695d9af9ac')
->orWhereRaw('objectguid', '=', '878ce8b7-2713-41a9-a765-5e3905ab5ef2');
Add an 'or where starts with' clause to the query:
// Returns "(cn=John*)"
$connection->query()
->orWhereStartsWith('cn', 'John')
->getUnescapedQuery();
// Returns "(|(cn=Suzy*)(cn=John*))"
$connection->query()
->whereStartsWith('cn', 'Suzy')
->orWhereStartsWith('cn', 'John')
->getUnescapedQuery();
orWhereStartsWith
Add an 'or where starts with' clause to the query:
// Returns "(cn=John*)"
$connection->query()
->orWhereStartsWith('cn', 'John')
->getUnescapedQuery();
// Returns "(|(cn=Suzy*)(cn=John*))"
$connection->query()
->whereStartsWith('cn', 'Suzy')
->orWhereStartsWith('cn', 'John')
->getUnescapedQuery();
paginate
Paginate the query by the given limit, returning all results from the LDAP directory:
This will allow you to exceed the LDAP max result limit of (usually) 1000.
$query = $connection->query();
// Paginate by default 1000:
$results = $query->paginate();
// Paginate by a specific amount:
$results = $query->paginate(500);
query
Execute a raw filter query on the connection:
$query = $connection->query();
$results = $query->query('(cn=John Doe)');
rawFilter
Add a raw LDAP search filter to the query:
$query = $connection->query();
// Returns "(&(cn=Contoso)(sn=Doe*))"
$query
->rawFilter('(company=Contoso)')
->rawFilter('(sn=Doe*)')
->getUnescapedQuery();
read
Set the query to read a single search result using the query's base DN (using ldap_read
):
Queries executed with
read()
will only return a maximum of one result.
$query = $connection->query();
$entry = $query->setDn('cn=John Doe,dc=local,dc=com')->read()->first();
recursive
Set the query to include recursive search results (using ldap_search
):
This is the default search query operation.
$query = $connection->query();
$results = $query->recursive()->get();
rename
Rename or move an object. Performs an ldap_rename
under the hood:
// Rename an object:
$connection->query()->rename(
$dn = 'cn=John Doe,dc=local,dc=com',
$newRdn = 'cn=Johnathon Doe',
$newParentDn = 'dc=local,dc=com'
);
// Move an object:
$connection->query()->rename(
$dn = 'cn=John Doe,dc=local,dc=com',
$newRdn = 'cn=John Doe',
$newParentDn = 'ou=Users,dc=local,dc=com'
);
select
Set the attributes to return from the directory:
Important: By selecting only the attributes you need, you can effectively reduce memory usage on large query result sets.
$query = $connection->query();
// Only return the 'cn' and 'sn' attributes in result
$query->select(['cn', 'sn'])->get();
setCache
Set the cache instance to use for the query:
The cache instance must extend
LdapRecord\Query\Cache
.
$query = $connection->query();
$query->setCache($cache);
setConnection
Set the connection instance to use for the query:
$query = $connection->query();
$newConnection = new Connection($config = ['...']);
$query->setConnection($newConnection);
setDn
Sets the base Distinguished Name to perform a search upon.
$query = $connection->query();
// Get all entries below the 'Users' OU:
$query->setDn('ou=Users,dc=local,dc=com')->get();
setGrammar
Set the underlying query Grammar
instance:
The given instance must extend the built-in
LdapRecord\Query\Grammar
.
$query = $connection->query();
$myGrammarInstance = new Grammar();
$query->setGrammar($myGrammarInstance);
slice
Important: Your LDAP server must support Virtual List View.
To get a "page" of an LDAP query to conserve memory and retrieve results quickly, you may use the slice()
method.
A Slice
object will always be returned with the query results that can be retrieved via the items()
method.
Note: Your query must search less than 10,000 records (this is a configurable limit in Active Directory).
$query = $connection->query();
$slice = $query->slice($page = 1, $perPage = 100): \LdapRecord\Query\Slice;
$slice->items(): array|\LdapRecord\Query\Collection;
$slice->total(): int;
$slice->perPage(): int;
$slice->currentPage(): int;
$slice->hasMorePages(): bool;
$slice->hasPages(): bool;
$slice->onFirstPage(): bool;
$slice->onLastPage(): bool;
$slice->isEmpty(): bool;
$slice->isNotEmpty(): bool;
sole
If you want to ensure a query returns only a single matching result, you may use the sole()
method.
If nothing is returned, an ObjectsNotFoundException
will be thrown.
If more than one record is returned, a MultipleObjectsFoundException
will be thrown.
$query = $connection->query();
try {
$object = $query->where('cn', '=', 'John Doe')->sole();
} catch (\LdapRecord\Query\ObjectsNotFoundException $e) {
// Nothing was returned from the query.
} catch (\LdapRecord\Query\MultipleObjectsFoundException $e) {
// Multiple objects were returned from the query.
}
update
Update an entry with the given modifications. Performs an ldap_modify_batch
under the hood:
$query = $connection->query();
$dn = 'cn=John Doe,dc=local,dc=com';
$modifs = [
[
'attrib' => 'telephoneNumber',
'modtype' => LDAP_MODIFY_BATCH_ADD,
'values' => ['+1 555 555 1717'],
],
];
$query->update($dn, $modifs);
updateAttributes
Update / replace an entry's attribute with the given values. Performs an ldap_mod_replace
under the hood:
$query = $connection->query();
$dn = 'cn=John Doe,dc=local,dc=com';
// Remove the users telephone number:
$query->updateAttributes($dn, ['telephoneNumber' => []]);
// Update / replace the users telephone number:
$query->updateAttributes($dn, ['telephoneNumber' => ['+1 555 555 1717']]);
where
Add a "where" clause to the query, searching for objects using the given attribute, operator, and value:
$query = $connection->query();
// Returns "(cn=John Doe)"
$query->where('cn', '=', 'John Doe')->getUnescapedQuery();
whereApproximatelyEquals
Add a "where approximately equals" clause to the query, searching for objects where the attribute is around the given value:
$query = $connection->query();
$query->whereApproximatelyEquals('givenName', 'John');
// Returns "(givenName~=John)"
$query->getUnescapedQuery();
The approximately equals operator is great for performing "sounds like" search operations.
For example, the above query would match entries with givenName
values of either John
or Jon
.
whereBetween
Add a "where between" clause to the query, searching for objects where the attribute is between the given values:
$query = $connection->query();
$from = (new DateTime('October 1st 2016'))->format('YmdHis.0\Z');
$to = (new DateTime('January 1st 2017'))->format('YmdHis.0\Z');
$query->whereBetween('whencreated', [$from, $to]);
// Returns "(&(whencreated>=20161001000000.0Z)(whencreated<=20170101000000.0Z))"
$query->getUnescapedQuery();
whereContains
Add a "where contains" clause to the query, searching for objects where the attribute contains the given value:
$query = $connection->query();
// Returns "(title=*Accountant*)"
$query->whereContains('title', 'Accountant')->getUnescapedQuery();
whereDeleted
Set an OID server control that will be sent with the query to instruct the LDAP server
to include deleted objects in the result set, and add a (isDeleted=TRUE)
clause
to the query, effectively returning only deleted objects.
$query = $connection->query();
$onlyDeleted = $query->whereDeleted()->get();
whereEndsWith
Add a "where ends with" clause to the query, searching for objects where the attribute ends with the given value:
$query = $connection->query();
// Returns "(title=*Accountant)"
$query->whereEndsWith('title', 'Accountant')->getUnescapedQuery();
whereEquals
Add a "where equals" clause to the query, searching for objects where the attribute equals the given value:
$query = $connection->query();
// Returns "(department=Accounting)"
$query->whereEquals('department', 'Accounting')->getUnescapedQuery();
whereHas
Add a "where has" clause to the query, searching for objects where the attribute exists, or is not empty:
$query = $connection->query();
// Returns "(department=*)"
$query->whereHas('department')->getUnescapedQuery();
whereIn
Add a "where in" clause to the query, searching for objects where the attribute contains any of the given values:
$query = $connection->query();
// Returns "(|(name=john)(name=mary)(name=sue))"
$query->whereIn('name', ['john', 'mary', 'sue'])->getUnescapedQuery();
whereNotContains
Add a "where doesn't contain" clause to the query, searching for objects where the attribute does not contain the given value:
$query = $connection->query();
// Returns "(!(telephoneNumber=*555*))"
$query->whereNotContains('telephoneNumber', '555')->getUnescapedQuery();
whereNotEndsWith
Add a "where doesn't end with" clause to the query, searching for objects where the attribute does not end with the given value:
$query = $connection->query();
// Returns "(!([email protected]))"
$query->whereNotEndsWith('mail', '@local.com')->getUnescapedQuery();
whereNotEquals
Add a "where doesn't equal" clause to the query, searching for objects where the attribute does not contain the given value:
$query = $connection->query();
// Returns "(!(department=Accounting))"
$query->whereNotEquals('department', 'Accounting')->getUnescapedQuery();
whereNotHas
Add a "where doesn't have" clause to the query, searching for objects where the attribute does not exist, or is empty:
$query = $connection->query();
// Returns "(!(mail=*))"
$query->whereNotHas('mail')->getUnescapedQuery();
whereNotStartsWith
Add a "where doesn't start with" clause to the query, searching for objects where the attribute does not start with the given value:
$query = $connection->query();
// Returns "(!(cn=John*))"
$query->whereNotStartsWith('cn', 'John')->getUnescapedQuery();
whereRaw
Add a "where" clause to the query without escaping the value, useful when values can contain distinguished names or GUIDs:
$query = $connection->query();
$query->whereRaw('objectguid', '=', '270db4d0-249d-46a7-9cc5-eb695d9af9ac');
whereStartsWith
Add a "starts with" clause to the query, searching for objects where the attribute starts with the given value:
$query = $connection->query();
// Returns "(cn=John*)"
$query->whereStartsWith('cn', 'John')->getUnescapedQuery();
withDeleted
Set an OID server control that will be sent with the query to instruct the LDAP server to include deleted objects in the result set:
$query = $connection->query();
$resultsWithDeleted = $query->withDeleted()->get();