• Inicio
• LdapTools
• Schema
• LdapObjectSchema

PHP Class LdapTools\Schema\LdapObjectSchema

Mostrar archivo Open project: ldaptools/ldaptools Class Usage Examples

Protected Properties

Property	Type	Description
$attributeMap		The map between LdapTools specific attribute names to what LDAP actually calls them.
$attributesToSelect		An array of attribute names to select by default when using LdapQueryBuilder or a Repository.
$baseDn		The BaseDN used for queries against this schema type.
$controls	LdapTools\Connection\LdapControl[]
$converterMap		An array of attribute keys and the converter names tied to them.
$converterOptions		Any attribute converter options defined.
$defaultContainer		The default ou/container where the object should reside in LDAP when created.
$defaultValues		Default values for attributes upon creation.
$filter		The operator representation of a filter to be used to select objects of this schema type.
$multivaluedAttributes		Attributes that are defined as being multivalued.
$objectCategory		The actual object category name in LDAP.
$objectClass		The actual object class name in LDAP.
$objectType		The LdapTools specific object type.
$repository		The repository to use for this object.
$requiredAttributes		These attributes are required when creating this object.
$schemaName		The name of the schema this object is from.
$scope	string | null
$usePaging	boolean | null

Public Methods

Method	Description
__construct ( string $schemaName, string $objectType )
getAttributeMap ( ) : array	Get the map of names to actual LDAP attribute names.
getAttributeToLdap ( string $attribute ) : string	Given an attribute name, this will get the attribute that LDAP is expecting for that name.
getAttributesToSelect ( ) : array	Get the attributes that should be retrieved by default when using LdapQueryBuilder or a Repository.
getBaseDn ( ) : string	Get the BaseDN used for queries against this schema type.
getCacheName ( )
getCacheType ( )
getControls ( ) : LdapControl[]	Get the LDAP controls needed when querying for this operation.
getConverter ( string $attributeName ) : string	Get the name of the converter for an attribute.
getConverterMap ( ) : array	Get the attribute name to attribute converter map.
getConverterOptions ( ) : array	Get the array of converter names and the options that will be passed to them.
getDefaultContainer ( ) : string	Get the default ou/container used when creating this object.
getDefaultValues ( ) : array	Get the default values when creating this object.
getFilter ( ) : BaseOperator	Get the operator that will be used as a filter for querying LDAP for this object type.
getMultivaluedAttributes ( ) : array	Get the attributes that are expected to be multivalued.
getNamesMappedToAttribute ( string $attribute ) : array	Get all the possible schema names/alias' mapped to a LDAP attribute name. It's possible to have multiple different names mapped to one attribute in the case of different converters applied to the same value.
getObjectCategory ( ) : string	Get the objectCategory that this schema object refers to.
getObjectClass ( ) : array	Get the LDAP object class(es) for this object type.
getObjectType ( ) : string	Get the LdapTools object type that this object refers to.
getRepository ( ) : string	Get the fully qualified name of the repository class to use for this object.
getRequiredAttributes ( ) : array	Get the required attributes when creating this object.
getSchemaName ( ) : string	The name of the schema this object definition came from.
getScope ( ) : null | string	Get the scope of the search for queries using this type.
getUsePaging ( ) : boolean | null	Get whether paging should be used when querying LDAP for this type.
hasAttribute ( string $attribute ) : boolean	Check for an attribute defined in the schema that maps to an LDAP attribute.
hasConverter ( string $attributeName ) : boolean	Check if an attribute has a converter defined.
hasNamesMappedToAttribute ( string $attribute ) : boolean	Check if a LDAP attribute has a schema name mapped to it.
isMultivaluedAttribute ( string $attribute ) : boolean	Whether a specific attribute is defined as multivalued or not.
setAttributeMap ( array $attributeMap )	Set the map of names to actual LDAP attribute names.
setAttributesToSelect ( array $attributes )	Set the attributes that will be retrieved by default when using LdapQueryBuilder or a Repository.
setBaseDn ( string $baseDn )	Set the BaseDN used for queries against this schema type.
setControls ( variadic $controls )	Set the LDAP controls needed when querying for this operation.
setConverterMap ( array $converterMap )	Set the attribute name to attribute converter map.
setConverterOptions ( array $converterOptions )	Set any options to be passed to specific converters.
setDefaultContainer ( string $container )	Set the default ou/container when creating this object.
setDefaultValues ( array $defaultValues )	Set the default values when creating this object.
setFilter ( BaseOperator $filter )	Set the operator that will be used as a filter for querying LDAP for this object type.
setMultivaluedAttributes ( array $multivaluedAttributes )	Set the attributes that are expected to be multivalued.
setObjectCategory ( $objectCategory )	Set the objectCategory that this schema object refers to.
setObjectClass ( string | array $objectClass )	Set the LDAP object class(es) for this object type.
setObjectType ( string $objectType )	Set the LdapTools object type that this object refers to.
setRepository ( string $repository )	Set the fully qualified name of the repository class to use for this object.
setRequiredAttributes ( array $attributes )	Set the required attributes when creating this object.
setSchemaName ( string $schemaName )	The name of the schema this object definition came from.
setScope ( string | null $scope )	Set the scope of the search for queries using this type.
setUsePaging ( boolean $usePaging )	Set whether paging should be used when querying LDAP for this type.

Method Details

Property Details