OrFilter
extends AbstractLogicalFilter
in package
Laminas\Ldap\Filter\OrFilter provides an 'or' filter.
Table of Contents
Constants
Properties
- $subfilters : array<string|int, mixed>
- All the sub-filters for this grouping filter.
- $symbol : string
- The grouping symbol.
Methods
- __construct() : mixed
- Creates an 'or' grouping filter.
- __toString() : string
- Returns a string representation of the filter.
- addAnd() : AndFilter
- Creates an 'and' filter.
- addFilter() : AbstractLogicalFilter
- Adds a filter to this grouping filter.
- addOr() : OrFilter
- Creates an 'or' filter.
- escapeValue() : mixed
- Escapes the given VALUES according to RFC 2254 so that they can be safely used in LDAP filters.
- negate() : AbstractFilter
- Negates the filter.
- toString() : string
- Returns a string representation of the filter.
- unescapeValue() : mixed
- Undoes the conversion done by {@link escapeValue()}.
Constants
TYPE_AND
public
mixed
TYPE_AND
= '&'
TYPE_OR
public
mixed
TYPE_OR
= '|'
Properties
$subfilters
All the sub-filters for this grouping filter.
private
array<string|int, mixed>
$subfilters
$symbol
The grouping symbol.
private
string
$symbol
Methods
__construct()
Creates an 'or' grouping filter.
public
__construct(array<string|int, mixed> $subfilters) : mixed
Parameters
- $subfilters : array<string|int, mixed>
__toString()
Returns a string representation of the filter.
public
__toString() : string
Tags
Return values
stringaddAnd()
Creates an 'and' filter.
public
addAnd(AbstractFilter $filter) : AndFilter
Parameters
- $filter : AbstractFilter
-
,...
Return values
AndFilteraddFilter()
Adds a filter to this grouping filter.
public
addFilter(AbstractFilter $filter) : AbstractLogicalFilter
Parameters
- $filter : AbstractFilter
Return values
AbstractLogicalFilteraddOr()
Creates an 'or' filter.
public
addOr(AbstractFilter $filter) : OrFilter
Parameters
- $filter : AbstractFilter
-
,...
Return values
OrFilterescapeValue()
Escapes the given VALUES according to RFC 2254 so that they can be safely used in LDAP filters.
public
static escapeValue([TInput $values = [] ]) : mixed
Any control characters with an ACII code < 32 as well as the characters with special meaning in LDAP filters "*", "(", ")", and "" (the backslash) are converted into the representation of a backslash followed by two hex digits representing the hexadecimal value of the character.
Parameters
- $values : TInput = []
-
Array of DN Values
Tags
negate()
Negates the filter.
public
negate() : AbstractFilter
Return values
AbstractFiltertoString()
Returns a string representation of the filter.
public
toString() : string
Return values
stringunescapeValue()
Undoes the conversion done by {@link escapeValue()}.
public
static unescapeValue([TInput $values = [] ]) : mixed
Converts any sequences of a backslash followed by two hex digits into the corresponding character.
Parameters
- $values : TInput = []
-
Array of DN Values