MatchingRule
extends SchemaItem
in package
Represents an LDAP MatchingRule
Table of Contents
- $description : mixed
- The description of this schema item.
- $is_obsolete : mixed
- Boolean value indicating whether this MatchingRule is obsolete
- $name : mixed
- This rule's name
- $oid : mixed
- The OID of this schema item.
- $syntax : mixed
- This rule's syntax OID
- $used_by_attrs : mixed
- An array of attribute names who use this MatchingRule
- __construct() : mixed
- Creates a new MatchingRule object from a raw LDAP MatchingRule string.
- addUsedByAttr() : true
- Adds an attribute name to the list of attributes who use this MatchingRule
- getDescription() : mixed
- getIsObsolete() : bool
- Gets whether this MatchingRule is flagged as obsolete by the LDAP server.
- getName() : string
- Gets this MatchingRule's name.
- getOID() : mixed
- getUsedByAttrs() : array<string|int, mixed>
- Gets an array of attribute names (strings) which use this MatchingRule
- initVars() : mixed
- Initialize the class' member variables
- setDescription() : mixed
- setOID() : mixed
- setUsedByAttrs() : mixed
- Sets the list of used_by_attrs to the array specified by $attrs;
Properties
$description
The description of this schema item.
public
mixed
$description
$is_obsolete
Boolean value indicating whether this MatchingRule is obsolete
public
mixed
$is_obsolete
$name
This rule's name
public
mixed
$name
$oid
The OID of this schema item.
public
mixed
$oid
$syntax
This rule's syntax OID
public
mixed
$syntax
$used_by_attrs
An array of attribute names who use this MatchingRule
public
mixed
$used_by_attrs
Methods
__construct()
Creates a new MatchingRule object from a raw LDAP MatchingRule string.
public
__construct(mixed $raw_ldap_matching_rule_string) : mixed
Parameters
- $raw_ldap_matching_rule_string : mixed
Return values
mixed —addUsedByAttr()
Adds an attribute name to the list of attributes who use this MatchingRule
public
addUsedByAttr(mixed $new_attr_name) : true
Parameters
- $new_attr_name : mixed
Return values
true —if the attribute was added and false otherwise (already in the list)
getDescription()
public
getDescription() : mixed
Return values
mixed —getIsObsolete()
Gets whether this MatchingRule is flagged as obsolete by the LDAP server.
public
getIsObsolete() : bool
Return values
bool —True if this MatchingRule is obsolete and false otherwise.
getName()
Gets this MatchingRule's name.
public
getName() : string
Return values
string —The name.
getOID()
public
getOID() : mixed
Return values
mixed —getUsedByAttrs()
Gets an array of attribute names (strings) which use this MatchingRule
public
getUsedByAttrs() : array<string|int, mixed>
Return values
array<string|int, mixed> —The array of attribute names (strings).
initVars()
Initialize the class' member variables
public
initVars() : mixed
Return values
mixed —setDescription()
public
setDescription(mixed $new_desc) : mixed
Parameters
- $new_desc : mixed
Return values
mixed —setOID()
public
setOID(mixed $new_oid) : mixed
Parameters
- $new_oid : mixed
Return values
mixed —setUsedByAttrs()
Sets the list of used_by_attrs to the array specified by $attrs;
public
setUsedByAttrs(array<string|int, mixed> $attrs) : mixed
Parameters
- $attrs : array<string|int, mixed>
-
The array of attribute names (strings) which use this MatchingRule