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

This interface describes a panel.

A panel is a row of a panel container.

 Methods

Add an element to the panel.

addElement(string $strKey, \ContaoCommunityAlliance\DcGeneral\Panel\PanelElementInterface $objElement) : mixed

Parameters

$strKey

string

Name of the panel.

$objElement

\ContaoCommunityAlliance\DcGeneral\Panel\PanelElementInterface

The element instance to add.

Returns

mixed

Get the parenting container.

getContainer() : \ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

Retrieve an element with the given name.

getElement(string $strKey) : \ContaoCommunityAlliance\DcGeneral\Panel\PanelElementInterface

Parameters

$strKey

string

The name of the element.

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\PanelElementInterface

Initialize the passed config via all contained elements.

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

Parameters

$objConfig

\ContaoCommunityAlliance\DcGeneral\Data\ConfigInterface

The config to which the initialization shall be applied to.

$objElement

\ContaoCommunityAlliance\DcGeneral\Panel\PanelElementInterface

The element to be initialized (if any).

Set the parenting container.

setContainer(\ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface $objContainer) : \ContaoCommunityAlliance\DcGeneral\Panel\PanelInterface

Parameters

$objContainer

\ContaoCommunityAlliance\DcGeneral\Panel\PanelContainerInterface

The Container to be used as parent.

Returns

\ContaoCommunityAlliance\DcGeneral\Panel\PanelInterface