contao-community-alliance/dc-general
Back to top  

This interface describes a panel container.

A Panel container contains panels which contain panel elements.

 Methods

Add a panel to the container.

addPanel(string $strKey, \ContaoCommunityAlliance\DcGeneral\Panel\PanelInterface $objPanel) : \ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

Parameters

$strKey

string

Name of the panel.

$objPanel

\ContaoCommunityAlliance\DcGeneral\Panel\PanelInterface

The panel to add.

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

Get the environment in use.

getEnvironment() : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Returns

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Retrieve a panel from the container.

getPanel(string $strKey) : \ContaoCommunityAlliance\DcGeneral\Panel\PanelInterface

Parameters

$strKey

string

The name of the panel.

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\PanelInterface

Initialize all panels and apply all restrictions to the given Config.

initialize(\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface $objConfig, \ContaoCommunityAlliance\DcGeneral\Panel\PanelElementInterface $objElement) : \ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

Parameters

$objConfig

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

The data config to be populated with the element values.

$objElement

\ContaoCommunityAlliance\DcGeneral\Panel\PanelElementInterface

The element currently being initialized.

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

Set the environment in use.

setEnvironment(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $objEnvironment) : \ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

Parameters

$objEnvironment

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

The environment to use.

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

Determinator if the panels should be updated from the InputProvider or not.

updateValues() : bool

Returns

bool