AttributeType()
addAlias()
addRequiredByObjectClass()
addUsedInObjectClass()
getAliases()
getEquality()
getIsCollective()
getIsNoUserModification()
getIsObsolete()
getIsSingleValue()
getMaxLength()
getName()
getOrdering()
getRequiredByObjectClasses()
getSubstr()
getSupAttribute()
getSyntaxOID()
getSyntaxString()
getType()
getUsage()
getUsedInObjectClasses()
initVars()
isAliasFor()
removeAlias()
setAliases()
setIsSingleValue()
setName()
setSupAttribute()
setType()
$aliases
$equality
$is_collective
$is_no_user_modification
$is_obsolete
$is_single_value
$max_length
$name
$ordering
$required_by_object_classes
$sub_str
$sup_attribute
$syntax
$type
$usage
$used_in_object_classes
__construct()
addAlias()
addRequiredByObjectClass()
addUsedInObjectClass()
getAliases()
getDescription()
getEquality()
getIsCollective()
getIsNoUserModification()
getIsObsolete()
getIsSingleValue()
getMaxLength()
getName()
getOID()
getOrdering()
getRequiredByObjectClasses()
getSubstr()
getSupAttribute()
getSyntaxOID()
getSyntaxString()
getType()
getUsage()
getUsedInObjectClasses()
isAliasFor()
isForceMay()
removeAlias()
setAliases()
setDescription()
setForceMay()
setIsSingleValue()
setName()
setOID()
setSupAttribute()
setType()
$description
$name
$aliases
$equality
$forced_as_may
$is_collective
$is_no_user_modification
$is_obsolete
$is_single_value
$max_length
$oid
$ordering
$required_by_object_classes
$sub_str
$sup_attribute
$syntax
$syntax_oid
$type
$usage
$used_in_object_classes
Represents an LDAP AttributeType
package | lib |
---|
AttributeType($raw_ldap_attr_string)
addAlias(string $new_alias_name)
string
The name of a new attribute to add to this attribute's list of aliases.
addRequiredByObjectClass(string $object_class_name)
string
The name of the objectClass to add.
addUsedInObjectClass(string $object_class_name)
string
The name of the objectClass to add.
getAliases() : array
array
An array of names of attributes which alias this attribute or an empty array if no attribute aliases this object.getEquality() : string
string
getIsCollective() : bool
bool
Returns true if this attribute is collective and false otherwise.getIsNoUserModification() : bool
bool
Returns true if this attribute is not modifiable by users.getIsObsolete() : bool
bool
getIsSingleValue() : bool
If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
bool
Returns true if this attribute is single-valued or false otherwise.getMaxLength() : int
If no maximum is defined by the LDAP server, null is returned.
int
The maximum length (in characters) of this attribute or null if no maximum is specified.getName() : string
string
getOrdering() : string
string
getRequiredByObjectClasses() : array
array
An array of names of objectclasses (strings) which provide this attributegetSubstr() : string
string
getSupAttribute() : string
If this attribute does not inherit from another attribute, null is returned.
string
getSyntaxOID() : string
Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed. Ie, if the syntax string is "1.2.3.4{16}", this function only retruns "1.2.3.4".
string
The syntax OID string.getSyntaxString() : string
string
The raw syntax stringgetType() : string
string
The attribute's type.getUsage() : string
string
getUsedInObjectClasses() : array
array
An array of names of objectclasses (strings) which provide this attributeinitVars()
isAliasFor(string $attr_name) : bool
string
The name of the attribute to check.
bool
True if the specified attribute is an alias for this one, or false otherwise.removeAlias(string $remove_alias_name) : bool
string
The name of the attribute to remove.
bool
true on success or false on failure (ie, if the specified attribute name is not found in this attribute's list of aliases)setAliases(array $new_aliases)
array
The array of alias names (strings)
setIsSingleValue(bool $is_single_value)
bool
setName(string $new_name)
string
The new name to give this attribute.
setSupAttribute(string $new_sup_attr)
string
The name of the new parent (SUP) attribute
setType(string $new_type)
string
The new type.
$aliases
$equality
$is_collective
$is_no_user_modification
$is_obsolete
$is_single_value
$max_length
$name
$ordering
$required_by_object_classes
$sub_str
$sup_attribute
$syntax
$type
$usage
$used_in_object_classes
Represents an LDAP AttributeType
A schema item is an ObjectClass, an AttributeBype, a MatchingRule, or a Syntax. All schema items have at least two things in common: An OID and a description. This class provides an implementation for these two data.
package | phpLDAPadmin |
---|---|
subpackage | Schema |
__construct($attr)
addAlias(string $alias)
string
The name of a new attribute to add to this attribute's list of aliases.
addRequiredByObjectClass(string $name)
string
The name of the objectClass to add.
addUsedInObjectClass(string $name)
string
The name of the objectClass to add.
getAliases() : array
array
An array of names of attributes which alias this attribute or an empty array if no attribute aliases this object.getDescription()
inherited_from | \SchemaItem::getDescription() |
---|
getEquality() : string
string
getIsCollective() : boolean
boolean
Returns true if this attribute is collective and false otherwise.getIsNoUserModification() : boolean
boolean
Returns true if this attribute is not modifiable by users.getIsObsolete()
inherited_from | \SchemaItem::getIsObsolete() |
---|
getIsSingleValue() : boolean
If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
boolean
Returns true if this attribute is single-valued or false otherwise.getMaxLength() : int
If no maximum is defined by the LDAP server, null is returned.
int
The maximum length (in characters) of this attribute or null if no maximum is specified.getName($lower) : string
param boolean $lower Return the name in lower case (default)
inherited_from | \SchemaItem::getName() |
---|
string
The namegetOID()
inherited_from | \SchemaItem::getOID() |
---|
getOrdering() : string
string
getRequiredByObjectClasses() : array
array
An array of names of objectclasses (strings) which provide this attributegetSubstr() : string
string
getSupAttribute() : string
If this attribute does not inherit from another attribute, null is returned.
string
getSyntaxOID() : string
Differs from getSyntaxString() in that this function only returns the actual OID with any length specification removed. Ie, if the syntax string is "1.2.3.4{16}", this function only retruns "1.2.3.4".
string
The syntax OID string.getSyntaxString() : string
string
The raw syntax stringgetType() : string
string
The attribute's type.getUsage() : string
string
getUsedInObjectClasses() : array
array
An array of names of objectclasses (strings) which provide this attributeisAliasFor(string $attr_name) : boolean
string
The name of the attribute to check.
boolean
True if the specified attribute is an alias for this one, or false otherwise.isForceMay()
removeAlias(string $remove_alias_name) : boolean
string
The name of the attribute to remove.
boolean
true on success or false on failure (ie, if the specified attribute name is not found in this attribute's list of aliases)setAliases(array $aliases)
array
The array of alias names (strings)
setDescription($desc)
inherited_from | \SchemaItem::setDescription() |
---|
setForceMay()
setIsSingleValue(boolean $is)
boolean
setName(string $name)
string
The new name to give this attribute.
setOID($oid)
inherited_from | \SchemaItem::setOID() |
---|
setSupAttribute(string $attr)
string
The name of the new parent (SUP) attribute
setType(string $type)
string
The new type.
$description
inherited_from | \SchemaItem::$$description |
---|
$name
inherited_from | \SchemaItem::$$name |
---|
$aliases
$equality
$forced_as_may
$is_collective
$is_no_user_modification
$is_obsolete
inherited_from | \SchemaItem::$$is_obsolete |
---|
$is_single_value
$max_length
$oid
inherited_from | \SchemaItem::$$oid |
---|
$ordering
$required_by_object_classes
$sub_str
$sup_attribute
$syntax
$syntax_oid
$type
$usage
$used_in_object_classes