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

Interface SearchElementInterface

This interface describes a search panel element.

DcGeneral\Panel\SearchElementInterface implements DcGeneral\Panel\PanelElementInterface

Direct known implementers

DcGeneral\Panel\DefaultSearchElement
Namespace: DcGeneral\Panel
Package: DcGeneral\Panel
Located at Panel/SearchElementInterface.php
Methods summary
public DcGeneral\Panel\SearchElementInterface
# addProperty( string $strProperty )

Add a property that can be searched.

Add a property that can be searched.

Parameters

$strProperty
string
$strProperty The property to allow to search on.

Returns

DcGeneral\Panel\SearchElementInterface
public string[]
# getPropertyNames( )

Retrieve the list of properties to allow search on.

Retrieve the list of properties to allow search on.

Returns

string[]
public DcGeneral\Panel\SearchElementInterface
# setSelectedProperty( string $strProperty = '' )

This activates a property for search.

This activates a property for search.

Parameters

$strProperty
string
$strProperty The property to activate search on.

Returns

DcGeneral\Panel\SearchElementInterface
public string
# getSelectedProperty( )

Retrieves the property currently defined to be searched on.

Retrieves the property currently defined to be searched on.

Returns

string
public DcGeneral\Panel\SearchElementInterface
# setValue( string $mixValue = null )

Set the value to search for.

Set the value to search for.

Parameters

$mixValue
string
$mixValue The value to search for.

Returns

DcGeneral\Panel\SearchElementInterface
public string
# getValue( )

Retrieve the value to be searched for.

Retrieve the value to be searched for.

Returns

string
Methods inherited from DcGeneral\Panel\PanelElementInterface
getPanel(), initialize(), render(), setPanel()
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0