Class ContaoDataProviderInformation.

This Information holds the details of a Contao data provider definition.

 Methods

Retrieve the data provider class to use.

getClassName() : string

Returns

string

Retrieve the data to use for initialization of the data provider.

getInitializationData() : mixed

Returns

mixed

Retrieve the table name of the data provider.

getTableName() : string

Returns

string

Set the data provider class to use, defaults to 'ContaoCommunityAlliance\DcGeneral\Data\DefaultDataProvider'.

setClassName(string $className) : \ContaoCommunityAlliance\DcGeneral\Contao\Dca\ContaoDataProviderInformation

Parameters

$className

string

The name of the data provider class to use.

Returns

Set the data to use for initialization of the data provider.

setInitializationData(mixed $initializationData) : \ContaoCommunityAlliance\DcGeneral\Contao\Dca\ContaoDataProviderInformation
The nature of this data is subject to the concrete implementation of the data provider defined as the class to use.

Parameters

$initializationData

mixed

The initialization data the data provider class expects.

Returns

Set the table name of the data provider.

setTableName(string $tableName) : \ContaoCommunityAlliance\DcGeneral\Contao\Dca\ContaoDataProviderInformation

Parameters

$tableName

string

The name of the table in the database.

Returns

 Properties

 

Name of the provider class to use.

$className : string
 

Custom initialization data to be passed to the constructor of the data provider class.

$initializationData : mixed
 

The table name to use.

$tableName : string