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

  • Command
  • CommandCollection
  • CutCommand
  • DefaultListingConfig
  • DefaultModelFormatterConfig
  • DefaultPanelLayout
  • DefaultPanelRow
  • DefaultPanelRowCollection

Interfaces

  • CommandCollectionInterface
  • CommandInterface
  • CutCommandInterface
  • ListingConfigInterface
  • ModelFormatterConfigInterface
  • PanelLayoutInterface
  • PanelRowCollectionInterface
  • PanelRowInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class DefaultPanelRow

Default implementation of a panel row.

DcGeneral\DataDefinition\Definition\View\DefaultPanelRow implements DcGeneral\DataDefinition\Definition\View\PanelRowInterface
Namespace: DcGeneral\DataDefinition\Definition\View
Package: DcGeneral\DataDefinition\Definition\View
Located at DataDefinition/Definition/View/DefaultPanelRow.php
Methods summary
public array
# getElements( )

Return the names of the contained panel elements.

Return the names of the contained panel elements.

Returns

array

Implementation of

DcGeneral\DataDefinition\Definition\View\PanelRowInterface::getElements()
public DcGeneral\DataDefinition\Definition\View\PanelRowInterface
# addElement( DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface $element, integer $index = -1 )

Add an element at the end of the row or - optionally - at the given position.

Add an element at the end of the row or - optionally - at the given position.

Parameters

$element
DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface
$element The element to add.
$index
integer
$index Target position for the element.

Returns

DcGeneral\DataDefinition\Definition\View\PanelRowInterface

Implementation of

DcGeneral\DataDefinition\Definition\View\PanelRowInterface::addElement()
public DcGeneral\DataDefinition\Definition\View\PanelRowInterface
# deleteElement( integer|string|DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface $indexOrNameOrInstance )

Remove the element with the given index (if numeric) or name (if string).

Remove the element with the given index (if numeric) or name (if string).

Parameters

$indexOrNameOrInstance
integer|string|DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface
$indexOrNameOrInstance Element name or numeric index in the row.

Returns

DcGeneral\DataDefinition\Definition\View\PanelRowInterface

Implementation of

DcGeneral\DataDefinition\Definition\View\PanelRowInterface::deleteElement()
public boolean
# hasElement( DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface|string $instanceOrName )

Check if the given element instance or an element with the given name is in the row.

Check if the given element instance or an element with the given name is in the row.

Parameters

$instanceOrName
DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface|string
$instanceOrName The element instance or the name of an element to check.

Returns

boolean

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
When an invalid value for the element name has been passed.

Implementation of

DcGeneral\DataDefinition\Definition\View\PanelRowInterface::hasElement()
public integer
# getCount( )

Retrieve the amount of elements.

Retrieve the amount of elements.

Returns

integer

Implementation of

DcGeneral\DataDefinition\Definition\View\PanelRowInterface::getCount()
public DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface
# getElement( integer|string $indexOrName )

Retrieve the element with the given index (if numeric) or name (if string).

Retrieve the element with the given index (if numeric) or name (if string).

Parameters

$indexOrName
integer|string
$indexOrName Element name or numeric index in the row.

Returns

DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
When an invalid value for the element name has been passed or the index is out of bounds.

Implementation of

DcGeneral\DataDefinition\Definition\View\PanelRowInterface::getElement()
public DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface[]
# getIterator( )

Retrieve an external iterator.

Retrieve an external iterator.

Returns

DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface[]

Implementation of

DcGeneral\DataDefinition\Definition\View\PanelRowInterface::getIterator()
Properties summary
protected DcGeneral\DataDefinition\Definition\View\Panel\ElementInformationInterface[] $elements array()
#

The contained elements.

The contained elements.

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