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 DefaultLimitElement

Default implementation of a limit panel element.

DcGeneral\Panel\AbstractElement implements DcGeneral\Panel\PanelElementInterface
Extended by DcGeneral\Panel\DefaultLimitElement implements DcGeneral\Panel\LimitElementInterface
Namespace: DcGeneral\Panel
Package: DcGeneral\Panel
Located at Panel/DefaultLimitElement.php
Methods summary
protected array
# getPersistent( )

Retrieve the persistent value from the input provider.

Retrieve the persistent value from the input provider.

Returns

array
protected
# setPersistent( integer $intOffset, integer $intAmount )

Store the persistent value in the input provider.

Store the persistent value in the input provider.

Parameters

$intOffset
integer
$intOffset The offset.
$intAmount
integer
$intAmount The amount of items to show.
protected DcGeneral\Data\ConfigInterface
# addParentFilter( mixed $idParent, DcGeneral\Data\ConfigInterface $objConfig )

Parameters

$idParent
mixed
$idParent
$objConfig
DcGeneral\Data\ConfigInterface
$objConfig

Returns

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

Initialize the passed configuration with the values of the element.

Initialize the passed configuration with the values of the element.

Parameters

$objConfig
DcGeneral\Data\ConfigInterface
$objConfig The config to which the initialization shall be applied to.
$objElement
DcGeneral\Panel\PanelElementInterface
$objElement The element to be initialized (if any).

Implementation of

DcGeneral\Panel\PanelElementInterface::initialize()
public DcGeneral\Panel\PanelElementInterface
# render( DcGeneral\View\ViewTemplateInterface $objTemplate )

Render the element using the given Template.

Render the element using the given Template.

Parameters

$objTemplate
DcGeneral\View\ViewTemplateInterface
$objTemplate The Template to use.

Returns

DcGeneral\Panel\PanelElementInterface

Implementation of

DcGeneral\Panel\PanelElementInterface::render()
public DcGeneral\Panel\LimitElementInterface
# setOffset( integer $intOffset )

Set the offset to use in this element.

Set the offset to use in this element.

Parameters

$intOffset
integer
$intOffset The offset.

Returns

DcGeneral\Panel\LimitElementInterface

Implementation of

DcGeneral\Panel\LimitElementInterface::setOffset()
public integer
# getOffset( )

Get the offset to use in this element.

Get the offset to use in this element.

Returns

integer

Implementation of

DcGeneral\Panel\LimitElementInterface::getOffset()
public DcGeneral\Panel\LimitElementInterface
# setAmount( integer $intAmount )

Set the Amount to use in this element.

Set the Amount to use in this element.

Parameters

$intAmount
integer
$intAmount The amount.

Returns

DcGeneral\Panel\LimitElementInterface

Implementation of

DcGeneral\Panel\LimitElementInterface::setAmount()
public integer
# getAmount( )

Get the amount to use in this element.

Get the amount to use in this element.

Returns

integer

Implementation of

DcGeneral\Panel\LimitElementInterface::getAmount()
Methods inherited from DcGeneral\Panel\AbstractElement
getEnvironment(), getInputProvider(), getOtherConfig(), getPanel(), setPanel()
Properties summary
protected integer $intOffset
#

The current offset.

The current offset.

protected integer $intAmount
#

The current amount.

The current amount.

protected integer $intTotal
#

The total amount of all valid entries.

The total amount of all valid entries.

Properties inherited from DcGeneral\Panel\AbstractElement
$objPanel
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0