Class DefaultDataProviderDefinition

This is the default implementation of a collection of data provider information.

DcGeneral\DataDefinition\Definition\DefaultDataProviderDefinition implements DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface

Namespace: DcGeneral\DataDefinition\Definition
Package: DcGeneral\DataDefinition\Definition
Located at DataDefinition/Definition/DefaultDataProviderDefinition.php

Methods summary
`public DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface`	# `addInformation( DcGeneral\DataDefinition\DataProviderInformationInterface $information )` Add a data provider information to the definition. Add a data provider information to the definition. Parameters `$information` `DcGeneral\DataDefinition\DataProviderInformationInterface` $information The data provider instance to add. Returns `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface` Throws `DcGeneral\Exception\DcGeneralInvalidArgumentException` When an invalid instance has been passed or a provider definition with the given name has already been registered. Implementation of `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface::addInformation()`
`protected string`	# `makeName( DcGeneral\DataDefinition\DataProviderInformationInterface\|string $information )` Convert a value into a data definition name. Convert a value into a data definition name. Convenience method to ensure we have a data provider name. Parameters `$information` `DcGeneral\DataDefinition\DataProviderInformationInterface\|string` $information The information or name of a data provider. Returns `string` Throws `DcGeneral\Exception\DcGeneralInvalidArgumentException` If neither a string nor an instance of DataProviderInformationInterface has been passed. Internal
`public DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface`	# `removeInformation( DcGeneral\DataDefinition\DataProviderInformationInterface\|string $information )` Remove the data provider information with the given name. Remove the data provider information with the given name. Parameters `$information` `DcGeneral\DataDefinition\DataProviderInformationInterface\|string` $information The information or name of a data provider. Returns `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface::removeInformation()`
`public DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface`	# `setInformation( string $name, DcGeneral\DataDefinition\DataProviderInformationInterface $information )` Forcefully overwrite a stored data provider with another one. Forcefully overwrite a stored data provider with another one. Parameters `$name` `string` $name The name of a data provider to overwrite. `$information` `DcGeneral\DataDefinition\DataProviderInformationInterface` $information The information of the new data provider. Returns `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface` Implementation of `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface::setInformation()`
`public boolean`	# `hasInformation( DcGeneral\DataDefinition\DataProviderInformationInterface\|string $information )` Check if there exists a definition of a data provider with the given name. Check if there exists a definition of a data provider with the given name. Parameters `$information` `DcGeneral\DataDefinition\DataProviderInformationInterface\|string` $information The information or name of a data provider. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface::hasInformation()`
`public DcGeneral\DataDefinition\DataProviderInformationInterface`	# `getInformation( string $information )` Retrieve the data provider information with the given name. Retrieve the data provider information with the given name. Parameters `$information` `string` $information The name of a data provider. Returns `DcGeneral\DataDefinition\DataProviderInformationInterface` Implementation of `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface::getInformation()`
`public string[]`	# `getProviderNames( )` Retrieve the names of all registered providers. Retrieve the names of all registered providers. Returns `string[]` Implementation of `DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface::getProviderNames()`
`public`	# `getIterator( )`
`public`	# `count( )`
`public`	# `offsetExists( mixed $offset )`
`public`	# `offsetGet( mixed $offset )`
`public`	# `offsetSet( mixed $offset, mixed $value )`
`public`	# `offsetUnset( mixed $offset )`
`public`	# `__isset( mixed $name )`
`public`	# `__get( mixed $name )`
`public`	# `__set( mixed $name, mixed $value )`
`public`	# `__unset( mixed $name )`

Constants inherited from DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface
`NAME`

Properties summary
`protected DcGeneral\DataDefinition\DataProviderInformationInterface[]`	`$information`	`array()`	# The data provider information stored in the definition. The data provider information stored in the definition.

Namespaces

Classes

Interfaces

Class DefaultDataProviderDefinition

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Internal

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of