contao-community-alliance/dc-general » \ContaoCommunityAlliance\DcGeneral\DC

Methods

Delegate all calls directly to current view.

__call(string $name, array $arguments) : mixed

Parameters

$name

string

Name of the method.

$arguments

array

Array of arguments.

Returns

mixed

Create a new instance.

__construct(string $strTable)

SuppressWarnings	(PHPMD.CamelCaseVariableName)
SuppressWarnings	(PHPMD.Superglobals)

Parameters

$strTable

string

The table name.

Magic getter.

__get(string $name) : mixed

deprecated	magic access is deprecated.

Parameters

$name

string

Name of the property to retrieve.

Exceptions

`\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException`	If an invalid key is requested.

Returns

mixed

Do not use.

copy() : string

deprecated	Only here as requirement of \editable

Returns

string

Do not use.

create() : string

deprecated	Only here as requirement of \editable

Returns

string

Do not use.

cut() : string

deprecated	Only here as requirement of \editable

Returns

string

Do not use.

delete() : string

deprecated	Only here as requirement of \listable

Returns

string

Do not use.

edit() : string

deprecated	Only here as requirement of \editable

Returns

string

Retrieve the controller.

getControllerHandler() : \ContaoCommunityAlliance\DcGeneral\Controller\ControllerInterface

Returns

\ContaoCommunityAlliance\DcGeneral\Controller\ControllerInterface

Retrieve the environment.

getEnvironment() : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Exceptions

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

Returns

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Retrieve the name of the data container.

getName() : string

Returns

string

Do not use.

getPalette() : void

deprecated	Only here as requirement of \DataContainer

Exceptions

`\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException`	Throws exception because method is not supported.

Retrieve the view.

getViewHandler() : \ContaoCommunityAlliance\DcGeneral\View\ViewInterface

Returns

\ContaoCommunityAlliance\DcGeneral\View\ViewInterface

Callback coming from the environment populator.

handlePopulateEnvironment(\ContaoCommunityAlliance\DcGeneral\Factory\Event\PopulateEnvironmentEvent $event) : void

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

Parameters

$event

\ContaoCommunityAlliance\DcGeneral\Factory\Event\PopulateEnvironmentEvent

The event.

Do not use.

move() : string

deprecated	Only here as requirement of \editable

Returns

string

Do not use.

show() : string

deprecated	Only here as requirement of \listable

Returns

string

Do not use.

showAll() : string

deprecated	Only here as requirement of \listable

Returns

string

Do not use.

undo() : string

deprecated	Only here as requirement of \listable

Returns

string

Call the desired user action with an implicit fallback to the "showAll" action when none has been requested.

callAction() : string

Returns

string

Call the table name callback.

getTablenameCallback(string $strTable) : string

SuppressWarnings	(PHPMD.CamelCaseVariableName)
SuppressWarnings	(PHPMD.Superglobals)

Parameters

$strTable

string

The current table name.

Returns

stringNew name of current table.

Do not use.

save(mixed $varValue) : void

deprecated	Only here as requirement of \DataContainer
SuppressWarnings	(PHPMD.UnusedFormalParameter)

Parameters

$varValue

mixed

Ignored.

Exceptions

`\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException`	Throws exception because method is not supported.

Check if we have an ajax call currently and if so, execute the action accordingly.

checkAjaxCall() : void

SuppressWarnings	(PHPMD.Superglobals)
SuppressWarnings	(PHPMD.CamelCaseVariableName)

Retrieve the event dispatcher from the DIC.

getEventDispatcher() : \Symfony\Component\EventDispatcher\EventDispatcherInterface

SuppressWarnings	(PHPMD.Superglobals)
SuppressWarnings	(PHPMD.CamelCaseVariableName)

Exceptions

`\RuntimeException`	When the DIC or event dispatcher have not been correctly initialized.

Returns

\Symfony\Component\EventDispatcher\EventDispatcherInterface

Get the translator from the service container.

getTranslator() : \ContaoCommunityAlliance\Translator\TranslatorInterface

SuppressWarnings	(PHPMD.Superglobals)
SuppressWarnings	(PHPMD.CamelCaseVariableName)

Returns

\ContaoCommunityAlliance\Translator\TranslatorInterface

Properties

The environment attached to this DC.

$objEnvironment : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface