Overview

Namespaces

  • DcGeneral
    • Clipboard
    • Contao
      • Callback
      • Compatibility
      • DataDefinition
        • Definition
      • Dca
        • Builder
          • Legacy
        • Definition
        • Palette
        • Populator
      • Event
      • View
        • Contao2BackendView
          • Event
    • Controller
    • Data
    • DataDefinition
      • Builder
      • Definition
        • Properties
        • View
          • Panel
      • ModelRelationship
      • Palette
        • Builder
          • Event
        • Condition
          • Palette
          • Property
    • EnvironmentPopulator
    • Event
    • Exception
    • Factory
      • Event
    • Panel
    • View
      • Event

Classes

  • ContaoDataProviderInformation
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class ContaoDataProviderInformation

Class ContaoDataProviderInformation.

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

DcGeneral\DataDefinition\DataProviderInformation implements DcGeneral\DataDefinition\DataProviderInformationInterface
Extended by DcGeneral\Contao\Dca\ContaoDataProviderInformation
Namespace: DcGeneral\Contao\Dca
Package: DcGeneral\Contao\Dca
Located at Contao/Dca/ContaoDataProviderInformation.php
Methods summary
public DcGeneral\Contao\Dca\ContaoDataProviderInformation
# setTableName( string $tableName )

Set the table name of the data provider.

Set the table name of the data provider.

Parameters

$tableName
string
$tableName The name of the table in the database.

Returns

DcGeneral\Contao\Dca\ContaoDataProviderInformation
public string
# getTableName( )

Retrieve the table name of the data provider.

Retrieve the table name of the data provider.

Returns

string
public DcGeneral\Contao\Dca\ContaoDataProviderInformation
# setClassName( string $className )

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

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

Parameters

$className
string
$className The name of the data provider class to use.

Returns

DcGeneral\Contao\Dca\ContaoDataProviderInformation
public string
# getClassName( )

Retrieve the data provider class to use.

Retrieve the data provider class to use.

Returns

string
public DcGeneral\Contao\Dca\ContaoDataProviderInformation
# setInitializationData( mixed $initializationData )

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

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

The nature of this data is subject to the concrete implementation of the data provider defined as the class to use.

Parameters

$initializationData
mixed
$initializationData The initialization data the data provider class expects.

Returns

DcGeneral\Contao\Dca\ContaoDataProviderInformation
public mixed
# getInitializationData( )

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

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

Returns

mixed
Methods inherited from DcGeneral\DataDefinition\DataProviderInformation
getName(), isVersioningEnabled(), setName(), setVersioningEnabled()
Properties summary
protected string $tableName
#

The table name to use.

The table name to use.

protected string $className 'DcGeneral\Data\DefaultDataProvider'
#

Name of the provider class to use.

Name of the provider class to use.

protected mixed $initializationData
#

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

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

Properties inherited from DcGeneral\DataDefinition\DataProviderInformation
$name, $versioningEnabled
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0