Grido@master
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Namespaces

  • Grido
    • Components
      • Actions
      • Columns
      • Filters
    • DataSources
    • PropertyAccessors
    • Translations

Classes

  • Check
  • Condition
  • Custom
  • Date
  • DateRange
  • Filter
  • Number
  • Select
  • Text

Class Filter

Data filtering.

Nette\Application\UI\PresenterComponent
Extended by Grido\Components\Component
Extended by Grido\Components\Filters\Filter

Direct known subclasses

Grido\Components\Filters\Check, Grido\Components\Filters\Custom, Grido\Components\Filters\Select, Grido\Components\Filters\Text

Indirect known subclasses

Grido\Components\Filters\Date, Grido\Components\Filters\DateRange, Grido\Components\Filters\Number

Abstract
Namespace: Grido\Components\Filters
Package: Grido\Components\Filters
Author: Petr Bugyík
Located at Components/Filters/Filter.php

Methods summary

public
# __construct( Grido\Grid $grid, string $name, string $label )

Parameters

$grid
$name
$label
public Grido\Components\Filters\Filter
# setColumn( string $column, string $operator = Grido\Components\Filters\Condition::OPERATOR_OR )

Map to database column.

Map to database column.

Parameters

$column
$operator

Returns

Grido\Components\Filters\Filter

Throws

InvalidArgumentException
public Grido\Components\Filters\Filter
# setCondition( $condition )

Sets custom condition.

Sets custom condition.

Parameters

$condition

Returns

Grido\Components\Filters\Filter
public Grido\Components\Filters\Filter
# setWhere( callable $callback )

Sets custom "sql" where.

Sets custom "sql" where.

Parameters

$callback
function($value, $source) {}

Returns

Grido\Components\Filters\Filter
public Grido\Components\Filters\Filter
# setFormatValue( string $format )

Sets custom format value.

Sets custom format value.

Parameters

$format
for example: "%%value%"

Returns

Grido\Components\Filters\Filter
public Grido\Components\Filters\Filter
# setDefaultValue( string $value )

Sets default value.

Sets default value.

Parameters

$value

Returns

Grido\Components\Filters\Filter
public Nette\Utils\Html
# getWrapperPrototype( )

Returns wrapper prototype (

html tag).

Returns wrapper prototype (

html tag).

Returns

Nette\Utils\Html
public string
# getCondition( )

Returns

string
protected string
# formatValue( string $value )

Format value for database.

Format value for database.

Parameters

$value

Returns

string

Methods inherited from Grido\Components\Component

addComponentToGrid(), getForm(), getGrid(), getPropertyAccessor(), translate()

Magic methods summary

Constants summary

string ID
# 'filters'
string VALUE_IDENTIFIER
# '%value'
string RENDER_INNER
# 'inner'
string RENDER_OUTER
# 'outer'

Properties summary

protected mixed $optional
#
protected array $column
# array()
protected string $condition
# '= ?'
protected callable $where
#
protected string $formatValue
#
protected Nette\Utils\Html $wrapperPrototype
#
protected Nette\Forms\Controls\BaseControl $control
#

Properties inherited from Grido\Components\Component

$form, $grid, $label, $propertyAccessor, $type

Magic properties

public read-only array $column
public read-only string $wrapperPrototype
public read-only Nette\Forms\Controls\BaseControl $control
public write-only string $condition
public write-only callable $where
public write-only string $formatValue
public write-only string $defaultValue

Magic properties inherited from Grido\Components\Component

$form, $grid, $label, $type

Grido@master API documentation generated by ApiGen