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

  • DefaultBasicDefinition
  • DefaultDataProviderDefinition
  • DefaultModelRelationshipDefinition
  • DefaultPalettesDefinition
  • DefaultPropertiesDefinition

Interfaces

  • BasicDefinitionInterface
  • DataProviderDefinitionInterface
  • DefinitionInterface
  • ModelRelationshipDefinitionInterface
  • PalettesDefinitionInterface
  • PropertiesDefinitionInterface
  • ViewDefinitionInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Interface DataProviderDefinitionInterface

This interface describes a collection of data provider information.

DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface implements DcGeneral\DataDefinition\Definition\DefinitionInterface, IteratorAggregate, Countable, ArrayAccess

Direct known implementers

DcGeneral\DataDefinition\Definition\DefaultDataProviderDefinition
Namespace: DcGeneral\DataDefinition\Definition
Package: DcGeneral\DataDefinition\Definition
Located at DataDefinition/Definition/DataProviderDefinitionInterface.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
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
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
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
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
public string[]
# getProviderNames( )

Retrieve the names of all registered providers.

Retrieve the names of all registered providers.

Returns

string[]
Methods inherited from IteratorAggregate
getIterator()
Methods inherited from Countable
count()
Methods inherited from ArrayAccess
offsetExists(), offsetGet(), offsetSet(), offsetUnset()
Constants summary
string NAME 'dataProvider'
#
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0