Zend\Ldap\Filter
Zend\Ldap\Filter.
Synopsis
class Filter
extends StringFilter
{
- // constants
- const TYPE_EQUALS = '=';
- const TYPE_GREATER = '>';
- const TYPE_GREATEROREQUAL = '>=';
- const TYPE_LESS = '<';
- const TYPE_LESSOREQUAL = '<=';
- const TYPE_APPROX = '~=';
- // Inherited members from StringFilter
- protected string $filter;
- // methods
- public static Filter equals()
- public static Filter begins()
- public static Filter ends()
- public static Filter contains()
- public static Filter greater()
- public static Filter greaterOrEqual()
- public static Filter less()
- public static Filter lessOrEqual()
- public static Filter approx()
- public static Filter any()
- public static StringFilter string()
- public static MaskFilter mask()
- public static AndFilter andFilter()
- public static OrFilter orFilter()
- private static string createFilterString()
- public void __construct()
- // Inherited methods from StringFilter
- public void __construct()
- public string toString()
- // Inherited methods from AbstractFilter
- public abstract string toString()
- public string __toString()
- public AbstractFilter negate()
- public AndFilter addAnd()
- public OrFilter addOr()
- public static array escapeValue()
- public static array unescapeValue()
Hierarchy
Extends
Constants
Name | Value |
---|---|
TYPE_EQUALS | '=' |
TYPE_GREATER | '>' |
TYPE_GREATEROREQUAL | '>=' |
TYPE_LESS | '<' |
TYPE_LESSOREQUAL | '<=' |
TYPE_APPROX | '~=' |
Members
protected
- $filter
—
string
The filter.
Methods
private
- createFilterString() — Create a filter string.
public
- __construct() — Creates a new Zend\Ldap\Filter.
- andFilter() — Creates an 'and' filter.
- any() — Creates an 'any' filter.
- approx() — Creates an 'approx' filter.
- begins() — Creates a 'begins with' filter.
- contains() — Creates a 'contains' filter.
- ends() — Creates an 'ends with' filter.
- equals() — Creates an 'equals' filter.
- greater() — Creates a 'greater' filter.
- greaterOrEqual() — Creates a 'greater or equal' filter.
- less() — Creates a 'less' filter.
- lessOrEqual() — Creates an 'less or equal' filter.
- mask() — Creates a simple string filter to be used with a mask.
- orFilter() — Creates an 'or' filter.
- string() — Creates a simple custom string filter.
Inherited from Zend\Ldap\Filter\StringFilter
public
- toString() — Returns a string representation of the filter.
Inherited from Zend\Ldap\Filter\AbstractFilter
public
- __toString() — Returns a string representation of the filter.
- addAnd() — Creates an 'and' filter.
- addOr() — Creates an 'or' filter.
- escapeValue() — Escapes the given VALUES according to RFC 2254 so that they can be safely used in LDAP filters.
- negate() — Negates the filter.
- toString() — Returns a string representation of the filter.
- unescapeValue() — Undoes the conversion done by {@link escapeValue()}.