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