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

  • AbstractElement
  • DefaultFilterElement
  • DefaultLimitElement
  • DefaultPanel
  • DefaultPanelContainer
  • DefaultSearchElement
  • DefaultSortElement
  • DefaultSubmitElement

Interfaces

  • FilterElementInterface
  • LimitElementInterface
  • PanelContainerInterface
  • PanelElementInterface
  • PanelInterface
  • SearchElementInterface
  • SortElementInterface
  • SubmitElementInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class DefaultPanelContainer

Default implementation of a panel container.

DcGeneral\Panel\DefaultPanelContainer implements DcGeneral\Panel\PanelContainerInterface
Namespace: DcGeneral\Panel
Package: DcGeneral\Panel
Located at Panel/DefaultPanelContainer.php
Methods summary
public DcGeneral\EnvironmentInterface
# getEnvironment( )

Get the environment in use.

Get the environment in use.

Returns

DcGeneral\EnvironmentInterface

Implementation of

DcGeneral\Panel\PanelContainerInterface::getEnvironment()
public DcGeneral\Panel\PanelContainerInterface
# setEnvironment( DcGeneral\EnvironmentInterface $objEnvironment )

Set the environment in use.

Set the environment in use.

Parameters

$objEnvironment
DcGeneral\EnvironmentInterface
$objEnvironment The environment to use.

Returns

DcGeneral\Panel\PanelContainerInterface

Implementation of

DcGeneral\Panel\PanelContainerInterface::setEnvironment()
public DcGeneral\Panel\PanelContainerInterface
# addPanel( string $strKey, DcGeneral\Panel\PanelInterface $objPanel )

Add a panel to the container.

Add a panel to the container.

Parameters

$strKey
string
$strKey Name of the panel.
$objPanel
DcGeneral\Panel\PanelInterface
$objPanel The panel to add.

Returns

DcGeneral\Panel\PanelContainerInterface

Implementation of

DcGeneral\Panel\PanelContainerInterface::addPanel()
public DcGeneral\Panel\PanelInterface
# getPanel( string $strKey )

Retrieve a panel from the container.

Retrieve a panel from the container.

Parameters

$strKey
string
$strKey The name of the panel.

Returns

DcGeneral\Panel\PanelInterface

Implementation of

DcGeneral\Panel\PanelContainerInterface::getPanel()
public DcGeneral\Panel\PanelContainerInterface
# initialize( DcGeneral\Data\ConfigInterface $objConfig, DcGeneral\Panel\PanelElementInterface $objElement = null )

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

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

Parameters

$objConfig
DcGeneral\Data\ConfigInterface
$objConfig The data config to be populated with the element values.
$objElement
DcGeneral\Panel\PanelElementInterface
$objElement The element currently being initialized.

Returns

DcGeneral\Panel\PanelContainerInterface

Implementation of

DcGeneral\Panel\PanelContainerInterface::initialize()
public boolean
# updateValues( )

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

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

Returns

boolean

Implementation of

DcGeneral\Panel\PanelContainerInterface::updateValues()
public
# getIterator( )
Properties summary
protected DcGeneral\EnvironmentInterface $objEnvironment
#

The environment in use.

The environment in use.

protected DcGeneral\Panel\PanelInterface[] $arrPanels array()
#

The panels contained within this container.

The panels contained within this container.

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