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)
stringThe name of a new attribute to add to this attribute's list of aliases.
addRequiredByObjectClass(string $object_class_name)
stringThe name of the objectClass to add.
addUsedInObjectClass(string $object_class_name)
stringThe name of the objectClass to add.
getAliases() : array
arrayAn array of names of attributes which alias this attribute or an empty array if no attribute aliases this object.getEquality() : string
stringgetIsCollective() : bool
boolReturns true if this attribute is collective and false otherwise.getIsNoUserModification() : bool
boolReturns true if this attribute is not modifiable by users.getIsObsolete() : bool
boolgetIsSingleValue() : bool
If this attribute only supports single values, true is returned. If this attribute supports multiple values, false is returned.
boolReturns true if this attribute is single-valued or false otherwise.getMaxLength() : int
If no maximum is defined by the LDAP server, null is returned.
intThe maximum length (in characters) of this attribute or null if no maximum is specified.getName() : string
stringgetOrdering() : string
stringgetRequiredByObjectClasses() : array
arrayAn array of names of objectclasses (strings) which provide this attributegetSubstr() : string
stringgetSupAttribute() : string
If this attribute does not inherit from another attribute, null is returned.
stringgetSyntaxOID() : 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".
stringThe syntax OID string.getSyntaxString() : string
stringThe raw syntax stringgetType() : string
stringThe attribute's type.getUsage() : string
stringgetUsedInObjectClasses() : array
arrayAn array of names of objectclasses (strings) which provide this attributeinitVars()
isAliasFor(string $attr_name) : bool
stringThe name of the attribute to check.
boolTrue if the specified attribute is an alias for this one, or false otherwise.removeAlias(string $remove_alias_name) : bool
stringThe name of the attribute to remove.
booltrue 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)
arrayThe array of alias names (strings)
setIsSingleValue(bool $is_single_value)
bool
setName(string $new_name)
stringThe new name to give this attribute.
setSupAttribute(string $new_sup_attr)
stringThe name of the new parent (SUP) attribute
setType(string $new_type)
stringThe 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)
stringThe name of a new attribute to add to this attribute's list of aliases.
addRequiredByObjectClass(string $name)
stringThe name of the objectClass to add.
addUsedInObjectClass(string $name)
stringThe name of the objectClass to add.
getAliases() : array
arrayAn 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
stringgetIsCollective() : boolean
booleanReturns true if this attribute is collective and false otherwise.getIsNoUserModification() : boolean
booleanReturns 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.
booleanReturns true if this attribute is single-valued or false otherwise.getMaxLength() : int
If no maximum is defined by the LDAP server, null is returned.
intThe 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() |
|---|
stringThe namegetOID()
| inherited_from | \SchemaItem::getOID() |
|---|
getOrdering() : string
stringgetRequiredByObjectClasses() : array
arrayAn array of names of objectclasses (strings) which provide this attributegetSubstr() : string
stringgetSupAttribute() : string
If this attribute does not inherit from another attribute, null is returned.
stringgetSyntaxOID() : 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".
stringThe syntax OID string.getSyntaxString() : string
stringThe raw syntax stringgetType() : string
stringThe attribute's type.getUsage() : string
stringgetUsedInObjectClasses() : array
arrayAn array of names of objectclasses (strings) which provide this attributeisAliasFor(string $attr_name) : boolean
stringThe name of the attribute to check.
booleanTrue if the specified attribute is an alias for this one, or false otherwise.isForceMay()
removeAlias(string $remove_alias_name) : boolean
stringThe name of the attribute to remove.
booleantrue 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)
arrayThe array of alias names (strings)
setDescription($desc)
| inherited_from | \SchemaItem::setDescription() |
|---|
setForceMay()
setIsSingleValue(boolean $is)
boolean
setName(string $name)
stringThe new name to give this attribute.
setOID($oid)
| inherited_from | \SchemaItem::setOID() |
|---|
setSupAttribute(string $attr)
stringThe name of the new parent (SUP) attribute
setType(string $type)
stringThe 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