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 DefaultFilterElement

Default implementation of a filter panel element.

DcGeneral\Panel\AbstractElement implements DcGeneral\Panel\PanelElementInterface
Extended by DcGeneral\Panel\DefaultFilterElement implements DcGeneral\Panel\FilterElementInterface
Namespace: DcGeneral\Panel
Package: DcGeneral\Panel
Located at Panel/DefaultFilterElement.php
Methods summary
protected null|mixed
# getPersistent( )

Retrieve the persistent value from the input provider.

Retrieve the persistent value from the input provider.

Returns

null|mixed
protected
# setPersistent( mixed $strValue )

Store the persistent value in the input provider.

Store the persistent value in the input provider.

Parameters

$strValue
mixed
$strValue The value to store.
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\FilterElementInterface
# setPropertyName( string $strProperty )

Set the property name to filter on.

Set the property name to filter on.

Parameters

$strProperty
string
$strProperty The property to filter on.

Returns

DcGeneral\Panel\FilterElementInterface

Implementation of

DcGeneral\Panel\FilterElementInterface::setPropertyName()
public string
# getPropertyName( )

Retrieve the property name to filter on.

Retrieve the property name to filter on.

Returns

string

Implementation of

DcGeneral\Panel\FilterElementInterface::getPropertyName()
public DcGeneral\Panel\FilterElementInterface
# setValue( mixed $mixValue )

Set the value to filter for.

Set the value to filter for.

Parameters

$mixValue
mixed
$mixValue The value to filter for.

Returns

DcGeneral\Panel\FilterElementInterface

Implementation of

DcGeneral\Panel\FilterElementInterface::setValue()
public mixed
# getValue( )

Retrieve the value to filter for.

Retrieve the value to filter for.

Returns

mixed

Implementation of

DcGeneral\Panel\FilterElementInterface::getValue()
Methods inherited from DcGeneral\Panel\AbstractElement
getEnvironment(), getInputProvider(), getOtherConfig(), getPanel(), setPanel()
Properties summary
protected string $strProperty
#

Name of the property this filter reacts on.

Name of the property this filter reacts on.

protected mixed $mixValue
#

The current value of this filter.

The current value of this filter.

protected array $arrfilterOptions
#

All valid filter options of the property.

All valid filter options of the property.

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