PHP Class LdapTools\Schema\LdapObjectSchema

Author: Chad Sikorra ([email protected])
Inheritance: implements LdapTools\Cache\CacheableItemInterface
Mostra file 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

__construct() public method

public __construct ( string $schemaName, string $objectType )
$schemaName string
$objectType string

getAttributeMap() public method

Get the map of names to actual LDAP attribute names.
public getAttributeMap ( ) : array
return array

getAttributeToLdap() public method

Given an attribute name, this will get the attribute that LDAP is expecting for that name.
public getAttributeToLdap ( string $attribute ) : string
$attribute string
return string

getAttributesToSelect() public method

Get the attributes that should be retrieved by default when using LdapQueryBuilder or a Repository.
public getAttributesToSelect ( ) : array
return array

getBaseDn() public method

Get the BaseDN used for queries against this schema type.
public getBaseDn ( ) : string
return string

getCacheName() public method

public getCacheName ( )

getCacheType() public static method

public static getCacheType ( )

getControls() public method

Get the LDAP controls needed when querying for this operation.
public getControls ( ) : LdapControl[]
return LdapTools\Connection\LdapControl[]

getConverter() public method

Get the name of the converter for an attribute.
public getConverter ( string $attributeName ) : string
$attributeName string
return string

getConverterMap() public method

Get the attribute name to attribute converter map.
public getConverterMap ( ) : array
return array

getConverterOptions() public method

Get the array of converter names and the options that will be passed to them.
public getConverterOptions ( ) : array
return array

getDefaultContainer() public method

Get the default ou/container used when creating this object.
public getDefaultContainer ( ) : string
return string

getDefaultValues() public method

Get the default values when creating this object.
public getDefaultValues ( ) : array
return array

getFilter() public method

Get the operator that will be used as a filter for querying LDAP for this object type.
public getFilter ( ) : BaseOperator
return LdapTools\Query\Operator\BaseOperator

getMultivaluedAttributes() public method

Get the attributes that are expected to be multivalued.
public getMultivaluedAttributes ( ) : array
return array

getNamesMappedToAttribute() public method

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.
public getNamesMappedToAttribute ( string $attribute ) : array
$attribute string
return array

getObjectCategory() public method

Get the objectCategory that this schema object refers to.
public getObjectCategory ( ) : string
return string

getObjectClass() public method

Get the LDAP object class(es) for this object type.
public getObjectClass ( ) : array
return array

getObjectType() public method

Get the LdapTools object type that this object refers to.
public getObjectType ( ) : string
return string

getRepository() public method

Get the fully qualified name of the repository class to use for this object.
public getRepository ( ) : string
return string

getRequiredAttributes() public method

Get the required attributes when creating this object.
public getRequiredAttributes ( ) : array
return array

getSchemaName() public method

The name of the schema this object definition came from.
public getSchemaName ( ) : string
return string

getScope() public method

Get the scope of the search for queries using this type.
public getScope ( ) : null | string
return null | string

getUsePaging() public method

Get whether paging should be used when querying LDAP for this type.
public getUsePaging ( ) : boolean | null
return boolean | null

hasAttribute() public method

Check for an attribute defined in the schema that maps to an LDAP attribute.
public hasAttribute ( string $attribute ) : boolean
$attribute string
return boolean

hasConverter() public method

Check if an attribute has a converter defined.
public hasConverter ( string $attributeName ) : boolean
$attributeName string
return boolean

hasNamesMappedToAttribute() public method

Check if a LDAP attribute has a schema name mapped to it.
public hasNamesMappedToAttribute ( string $attribute ) : boolean
$attribute string
return boolean

isMultivaluedAttribute() public method

Whether a specific attribute is defined as multivalued or not.
public isMultivaluedAttribute ( string $attribute ) : boolean
$attribute string
return boolean

setAttributeMap() public method

Set the map of names to actual LDAP attribute names.
public setAttributeMap ( array $attributeMap )
$attributeMap array

setAttributesToSelect() public method

Set the attributes that will be retrieved by default when using LdapQueryBuilder or a Repository.
public setAttributesToSelect ( array $attributes )
$attributes array

setBaseDn() public method

Set the BaseDN used for queries against this schema type.
public setBaseDn ( string $baseDn )
$baseDn string

setControls() public method

Set the LDAP controls needed when querying for this operation.
public setControls ( variadic $controls )
$controls variadic

setConverterMap() public method

Set the attribute name to attribute converter map.
public setConverterMap ( array $converterMap )
$converterMap array

setConverterOptions() public method

Set any options to be passed to specific converters.
public setConverterOptions ( array $converterOptions )
$converterOptions array

setDefaultContainer() public method

Set the default ou/container when creating this object.
public setDefaultContainer ( string $container )
$container string

setDefaultValues() public method

Set the default values when creating this object.
public setDefaultValues ( array $defaultValues )
$defaultValues array

setFilter() public method

Set the operator that will be used as a filter for querying LDAP for this object type.
public setFilter ( BaseOperator $filter )
$filter LdapTools\Query\Operator\BaseOperator

setMultivaluedAttributes() public method

Set the attributes that are expected to be multivalued.
public setMultivaluedAttributes ( array $multivaluedAttributes )
$multivaluedAttributes array

setObjectCategory() public method

Set the objectCategory that this schema object refers to.
public setObjectCategory ( $objectCategory )
$objectCategory

setObjectClass() public method

Set the LDAP object class(es) for this object type.
public setObjectClass ( string | array $objectClass )
$objectClass string | array

setObjectType() public method

Set the LdapTools object type that this object refers to.
public setObjectType ( string $objectType )
$objectType string

setRepository() public method

Set the fully qualified name of the repository class to use for this object.
public setRepository ( string $repository )
$repository string

setRequiredAttributes() public method

Set the required attributes when creating this object.
public setRequiredAttributes ( array $attributes )
$attributes array

setSchemaName() public method

The name of the schema this object definition came from.
public setSchemaName ( string $schemaName )
$schemaName string

setScope() public method

Set the scope of the search for queries using this type.
public setScope ( string | null $scope )
$scope string | null

setUsePaging() public method

Set whether paging should be used when querying LDAP for this type.
public setUsePaging ( boolean $usePaging )
$usePaging boolean

Property Details

$attributeMap protected_oe property

The map between LdapTools specific attribute names to what LDAP actually calls them.
protected $attributeMap

$attributesToSelect protected_oe property

An array of attribute names to select by default when using LdapQueryBuilder or a Repository.
protected $attributesToSelect

$baseDn protected_oe property

The BaseDN used for queries against this schema type.
protected $baseDn

$controls protected_oe property

protected LdapControl[],LdapTools\Connection $controls
return LdapTools\Connection\LdapControl[]

$converterMap protected_oe property

An array of attribute keys and the converter names tied to them.
protected $converterMap

$converterOptions protected_oe property

Any attribute converter options defined.
protected $converterOptions

$defaultContainer protected_oe property

The default ou/container where the object should reside in LDAP when created.
protected $defaultContainer

$defaultValues protected_oe property

Default values for attributes upon creation.
protected $defaultValues

$filter protected_oe property

The operator representation of a filter to be used to select objects of this schema type.
protected $filter

$multivaluedAttributes protected_oe property

Attributes that are defined as being multivalued.
protected $multivaluedAttributes

$objectCategory protected_oe property

The actual object category name in LDAP.
protected $objectCategory

$objectClass protected_oe property

The actual object class name in LDAP.
protected $objectClass

$objectType protected_oe property

The LdapTools specific object type.
protected $objectType

$repository protected_oe property

The repository to use for this object.
protected $repository

$requiredAttributes protected_oe property

These attributes are required when creating this object.
protected $requiredAttributes

$schemaName protected_oe property

The name of the schema this object is from.
protected $schemaName

$scope protected_oe property

protected string|null $scope
return string | null

$usePaging protected_oe property

protected bool|null $usePaging
return boolean | null