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

  • DcGeneralFactory

Interfaces

  • DcGeneralFactoryInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Interface DcGeneralFactoryInterface

This interface describes a DcGeneral factory.

The factory is responsible for creating a DcGeneral instance including the data definition container and environment.

Direct known implementers

DcGeneral\Factory\DcGeneralFactory
Namespace: DcGeneral\Factory
Package: DcGeneral\Factory
Located at Factory/DcGeneralFactoryInterface.php
Methods summary
public DcGeneral\Factory\DcGeneralFactoryInterface
# setEnvironmentClassName( string $environmentClassName )

Set the class name to use as environment.

Set the class name to use as environment.

Parameters

$environmentClassName
string
$environmentClassName The class name.

Returns

DcGeneral\Factory\DcGeneralFactoryInterface
public string
# getEnvironmentClassName( )

Retrieve the class name to use as environment.

Retrieve the class name to use as environment.

Returns

string
public DcGeneral\Factory\DcGeneralFactoryInterface
# setContainerName( string $containerName )

Set the name for the data definition container.

Set the name for the data definition container.

Parameters

$containerName
string
$containerName The class name.

Returns

DcGeneral\Factory\DcGeneralFactoryInterface
public string
# getContainerName( )

Retrieve the name for the data definition container.

Retrieve the name for the data definition container.

Returns

string
public DcGeneral\Factory\DcGeneralFactoryInterface
# setContainerClassName( string $containerClassName )

Set the class name to use as data definition container.

Set the class name to use as data definition container.

Parameters

$containerClassName
string
$containerClassName The class name.

Returns

DcGeneral\Factory\DcGeneralFactoryInterface
public string
# getContainerClassName( )

Retrieve the class name to use as data definition container.

Retrieve the class name to use as data definition container.

Returns

string
public DcGeneral\Factory\DcGeneralFactoryInterface
# setDcGeneralClassName( string $dcGeneralClassName )

Set the class name to use as DcGeneral.

Set the class name to use as DcGeneral.

Parameters

$dcGeneralClassName
string
$dcGeneralClassName The class name.

Returns

DcGeneral\Factory\DcGeneralFactoryInterface
public string
# getDcGeneralClassName( )

Retrieve the class name to use as DcGeneral.

Retrieve the class name to use as DcGeneral.

Returns

string
public DcGeneral\Factory\DcGeneralFactoryInterface
# setEventPropagator( DcGeneral\DcGeneral\Event\EventPropagatorInterface $eventPropagator )

Set the event propagator to use.

Set the event propagator to use.

Parameters

$eventPropagator
DcGeneral\Event\EventPropagatorInterface
$eventPropagator The event propagator.

Returns

DcGeneral\Factory\DcGeneralFactoryInterface
public DcGeneral\Event\EventPropagatorInterface
# getEventPropagator( )

Retrieve the event propagator.

Retrieve the event propagator.

Returns

DcGeneral\Event\EventPropagatorInterface
public DcGeneral\Factory\DcGeneralFactoryInterface
# setTranslator( ContaoCommunityAlliance\Translator\TranslatorInterface $translator )

Set the translator to use.

Set the translator to use.

Parameters

$translator
ContaoCommunityAlliance\Translator\TranslatorInterface
$translator The translator instance.

Returns

DcGeneral\Factory\DcGeneralFactoryInterface
public ContaoCommunityAlliance\Translator\TranslatorInterface
# getTranslator( )

Get the translator to use.

Get the translator to use.

Returns

ContaoCommunityAlliance\Translator\TranslatorInterface
public DcGeneral\Factory\DcGeneralFactoryInterface
# setEnvironment( DcGeneral\DcGeneral\EnvironmentInterface $environment = null )

Set the environment to use.

Set the environment to use.

Parameters

$environment
DcGeneral\EnvironmentInterface
$environment The environment instance.

Returns

DcGeneral\Factory\DcGeneralFactoryInterface
public DcGeneral\EnvironmentInterface
# getEnvironment( )

Retrieve the environment to use.

Retrieve the environment to use.

Returns

DcGeneral\EnvironmentInterface
public DcGeneral\Factory\DcGeneralFactoryInterface
# setDataContainer( DcGeneral\DcGeneral\DataDefinition\ContainerInterface $dataContainer = null )

Set the data definition container to use.

Set the data definition container to use.

Parameters

$dataContainer
DcGeneral\DataDefinition\ContainerInterface
$dataContainer The data definition container instance.

Returns

DcGeneral\Factory\DcGeneralFactoryInterface
public DcGeneral\DataDefinition\ContainerInterface
# getDataContainer( )

Retrieve the data definition container.

Retrieve the data definition container.

Returns

DcGeneral\DataDefinition\ContainerInterface
public DcGeneral\DcGeneral
# createDcGeneral( )

Create a new instance of DcGeneral.

Create a new instance of DcGeneral.

If no environment is given, a new one is created.

Returns

DcGeneral\DcGeneral
public DcGeneral\EnvironmentInterface
# createEnvironment( )

Create a new instance of Environment.

Create a new instance of Environment.

If no container is given, a new one is created.

Returns

DcGeneral\EnvironmentInterface
public DcGeneral\DataDefinition\ContainerInterface
# createContainer( )

Create a new instance of Container.

Create a new instance of Container.

Returns

DcGeneral\DataDefinition\ContainerInterface
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0