ConfiguredType
in package
Represents a configured account type variant.
Tags
Table of Contents
- $additionalLdapFilter : string|null
- $alias : string|null
- $attributes : array<string|int, mixed>|null
- $baseType : baseType|null
- $hidden : bool|null
- $id : string
- $scope : string
- $suffix : string|null
- $typeManager : TypeManager|null
- __construct() : mixed
- Constructor
- getAdditionalLdapFilter() : string
- Returns the additional LDAP filter.
- getAlias() : string
- Returns the alias name.
- getAttributes() : array<string|int, ListAttribute>
- Returns a list of configured attributes.
- getBaseType() : baseType
- Returns the base type of this configured type.
- getIcon() : string
- Returns the file name of the type icon.
- getId() : string
- Returns a unique id for this configuration.
- getModules() : array<string|int, class-string<\baseModule>>
- Returns the names of the active modules for this type.
- getScope() : string
- Returns the account type (e.g. 'user').
- getSuffix() : string
- Returns the LDAP suffix.
- getSuffixList() : array<string|int, string>
- Returns a list of LDAP suffixes for this type.
- getTypeManager() : TypeManager
- Returns the owning type manager.
- isHidden() : bool
- Returns if this configuration is hidden.
Properties
$additionalLdapFilter
private
string|null
$additionalLdapFilter
= null
$alias
private
string|null
$alias
= null
$attributes
private
array<string|int, mixed>|null
$attributes
= null
list attributes
$baseType
private
baseType|null
$baseType
= null
$hidden
private
bool|null
$hidden
= null
$id
private
string
$id
$scope
private
string
$scope
$suffix
private
string|null
$suffix
= null
$typeManager
private
TypeManager|null
$typeManager
Methods
__construct()
Constructor
public
__construct(TypeManager|null $typeManager, string $scope, string $id) : mixed
Parameters
- $typeManager : TypeManager|null
-
type manager
- $scope : string
-
account type
- $id : string
-
unique ID for this configuration
Return values
mixed —getAdditionalLdapFilter()
Returns the additional LDAP filter.
public
getAdditionalLdapFilter() : string
Return values
string —LDAP filter
getAlias()
Returns the alias name.
public
getAlias() : string
Return values
string —alias name
getAttributes()
Returns a list of configured attributes.
public
getAttributes() : array<string|int, ListAttribute>
Return values
array<string|int, ListAttribute> —list of ListAttribute
getBaseType()
Returns the base type of this configured type.
public
getBaseType() : baseType
Return values
baseType —base type
getIcon()
Returns the file name of the type icon.
public
getIcon() : string
It is 16x16px and located in graphics folder.
Return values
string —file name
getId()
Returns a unique id for this configuration.
public
getId() : string
Return values
string —unique id
getModules()
Returns the names of the active modules for this type.
public
getModules() : array<string|int, class-string<\baseModule>>
Return values
array<string|int, class-string<\baseModule>> —module names
getScope()
Returns the account type (e.g. 'user').
public
getScope() : string
Return values
string —account type
getSuffix()
Returns the LDAP suffix.
public
getSuffix() : string
Return values
string —LDAP suffix
getSuffixList()
Returns a list of LDAP suffixes for this type.
public
getSuffixList() : array<string|int, string>
Return values
array<string|int, string> —sorted list of possible suffixes for this type.
getTypeManager()
Returns the owning type manager.
public
getTypeManager() : TypeManager
Return values
TypeManager —type manager
isHidden()
Returns if this configuration is hidden.
public
isHidden() : bool
Return values
bool —hidden