Docs For Class MatchingRule

$is_obsolete =

[line 1174]

Boolean value indicating whether this MatchingRule is obsolete

Type:

mixed

[ Top ]

$name =

[line 1170]

This rule's name

Type:

mixed

[ Top ]

$syntax =

[line 1172]

This rule's syntax OID

Type:

mixed

[ Top ]

$used_by_attrs =

[line 1176]

An array of attribute names who use this MatchingRule

Type:

mixed

[ Top ]

constructor MatchingRule [line 1193]

MatchingRule MatchingRule(

$raw_ldap_matching_rule_string)

Creates a new MatchingRule object from a raw LDAP MatchingRule string.

Parameters:

$raw_ldap_matching_rule_string

[ Top ]

method addUsedByAttr [line 1273]

true addUsedByAttr(

$new_attr_name)

Adds an attribute name to the list of attributes who use this MatchingRule

Tags:

return:

if the attribute was added and false otherwise (already in the list)

Parameters:

$new_attr_name

[ Top ]

method getIsObsolete [line 1298]

bool getIsObsolete(
)

Gets whether this MatchingRule is flagged as obsolete by the LDAP server.

Tags:

return:

True if this MatchingRule is obsolete and false otherwise.

[ Top ]

method getName [line 1290]

string getName(
)

Gets this MatchingRule's name.

Tags:

return:

The name.

[ Top ]

method getSyntax [line 1305]

void getSyntax(
)

Gets this MatchingRule's syntax string (an OID).

[ Top ]

method getUsedByAttrs [line 1313]

array getUsedByAttrs(
)

Gets an array of attribute names (strings) which use this MatchingRule

Tags:

return:

The array of attribute names (strings).

[ Top ]

method initVars [line 1179]

void initVars(
)

Initialize the class' member variables

Overrides SchemaItem::initVars() (parent method not documented)

[ Top ]

method setUsedByAttrs [line 1265]

void setUsedByAttrs(
array
$attrs)

Sets the list of used_by_attrs to the array specified by $attrs;

Parameters:

array

$attrs

The array of attribute names (strings) which use this MatchingRule

[ Top ]

Class: MatchingRule

Class Overview

Variables

Methods

Inherited Variables

Class: SchemaItem

Inherited Methods

Class: SchemaItem

Class Details

Class Variables

$is_obsolete =

$name =

$syntax =

$used_by_attrs =

Class Methods

constructor MatchingRule [line 1193]

Parameters:

method addUsedByAttr [line 1273]

Tags:

Parameters:

method getIsObsolete [line 1298]

Tags:

method getName [line 1290]

Tags:

method getSyntax [line 1305]

method getUsedByAttrs [line 1313]

Tags:

method initVars [line 1179]

method setUsedByAttrs [line 1265]

Parameters: