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

  • DataDefinitionContainer
  • DC_General
  • DcGeneral
  • DefaultEnvironment

Interfaces

  • ContainerAwareInterface
  • DataContainerInterface
  • DataDefinitionContainerInterface
  • EnvironmentAwareInterface
  • EnvironmentInterface
  • InputProviderInterface
  • ModelAwareInterface
  • ViewAwareInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class DC_General

This interface describes an object providing access to an environment.

DataContainer
Extended by DcGeneral\DC_General implements DcGeneral\DataContainerInterface

Direct known subclasses

DcGeneral\Contao\Compatibility\DcCompat
Namespace: DcGeneral
Package: DcGeneral
Located at DC_General.php
Methods summary
public
# __construct( string $strTable, array & $arrDCA = null, boolean $blnOnloadCallback = true )

Create a new instance.

Create a new instance.

Parameters

$strTable
string
$strTable The table name.
$arrDCA
array
$arrDCA The Dca array.
$blnOnloadCallback
boolean
$blnOnloadCallback Fire the onload callback.
public
# handlePopulateEnvironment( DcGeneral\Factory\Event\PopulateEnvironmentEvent $event )

Callback coming from the environment populator.

Callback coming from the environment populator.

This is used to get to know the environment here in the DC. See the implementation in constructor and ExtendedLegacyDcaPopulator::populateCallback().

Parameters

$event
DcGeneral\Factory\Event\PopulateEnvironmentEvent
$event The event.
protected string
# getTablenameCallback( string $strTable )

Call the table name callback.

Call the table name callback.

Parameters

$strTable
string
$strTable The current table name.

Returns

string
New name of current table.
public mixed
# __get( string $name )

Magic getter.

Magic getter.

Deprecated

magic access is deprecated.

Parameters

$name
string
$name Name of the property to retrieve.

Returns

mixed

Throws

DcGeneral\Exception\DcGeneralRuntimeException
If an invalid key is requested.
public array
# getDCA( )

Retrieve the DCA.

Retrieve the DCA.

Returns

array
public string
# getName( )

Retrieve the name of the data container.

Retrieve the name of the data container.

Returns

string
public DcGeneral\EnvironmentInterface
# getEnvironment( )

Retrieve the environment.

Retrieve the environment.

Returns

DcGeneral\EnvironmentInterface

Throws

DcGeneral\Exception\DcGeneralRuntimeException
When no environment has been set.

Implementation of

DcGeneral\DataContainerInterface::getEnvironment()
public DcGeneral\View\ViewInterface
# getViewHandler( )

Retrieve the view.

Retrieve the view.

Returns

DcGeneral\View\ViewInterface
public DcGeneral\Controller\ControllerInterface
# getControllerHandler( )

Retrieve the controller.

Retrieve the controller.

Returns

DcGeneral\Controller\ControllerInterface
public mixed
# __call( string $name, array $arguments )

Delegate all calls directly to current view.

Delegate all calls directly to current view.

Parameters

$name
string
$name Name of the method.
$arguments
array
$arguments Array of arguments.

Returns

mixed
public string
# copy( )

Do not use.

Do not use.

Deprecated

Only here as requirement of \editable

Returns

string
public string
# create( )

Do not use.

Do not use.

Deprecated

Only here as requirement of \editable

Returns

string
public string
# cut( )

Do not use.

Do not use.

Deprecated

Only here as requirement of \editable

Returns

string
public string
# delete( )

Do not use.

Do not use.

Deprecated

Only here as requirement of \listable

Returns

string
public string
# edit( )

Do not use.

Do not use.

Deprecated

Only here as requirement of \editable

Returns

string
public string
# move( )

Do not use.

Do not use.

Deprecated

Only here as requirement of \editable

Returns

string
public string
# show( )

Do not use.

Do not use.

Deprecated

Only here as requirement of \listable

Returns

string
public string
# showAll( )

Do not use.

Do not use.

Deprecated

Only here as requirement of \listable

Returns

string
public string
# undo( )

Do not use.

Do not use.

Deprecated

Only here as requirement of \listable

Returns

string
Properties summary
protected DcGeneral\EnvironmentInterface $objEnvironment
#

The environment attached to this DC.

The environment attached to this DC.

protected array $arrDCA null
#

DCA configuration.

DCA configuration.

protected array $arrFields array()
#

A list with all field for this dca.

A list with all field for this dca.

contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0