0 follower

Abstract Class Yiisoft\Yii\DataView\Filter\Widget\FilterWidget

All Classes | Methods
InheritanceYiisoft\Yii\DataView\Filter\Widget\FilterWidget » Yiisoft\Widget\Widget
SubclassesYiisoft\Yii\DataView\Filter\Widget\DropdownFilter, Yiisoft\Yii\DataView\Filter\Widget\TextInputFilter

Base class for filter widgets that render filter inputs in data views.

Public Methods

Hide inherited methods

Method Description Defined By
render() Renders the filter widget using the current context. Yiisoft\Yii\DataView\Filter\Widget\FilterWidget
renderFilter() Renders the specific filter input implementation. Yiisoft\Yii\DataView\Filter\Widget\FilterWidget
withContext() Creates a new instance with the specified filter context. Yiisoft\Yii\DataView\Filter\Widget\FilterWidget

Method Details

Hide inherited methods

render() public method

Renders the filter widget using the current context.

public string render ( )
return string

The rendered HTML for the filter input.

 

                final public function render(): string
{
    return $this->renderFilter($this->context);
}
renderFilter() public abstract method

Renders the specific filter input implementation.

Implement this method to define how your specific filter widget should render its input. Use the provided context to access:

  • Property name ({@see \Yiisoft\Yii\DataView\Filter\Widget\Context::$property})
  • Current value ({@see \Yiisoft\Yii\DataView\Filter\Widget\Context::$value})
  • Form ID ({@see \Yiisoft\Yii\DataView\Filter\Widget\Context::$formId})
public abstract string renderFilter ( Yiisoft\Yii\DataView\Filter\Widget\Context $context )
$context Yiisoft\Yii\DataView\Filter\Widget\Context

The filter context to use for rendering.
return string

The rendered HTML for the filter input.

 

                abstract public function renderFilter(Context $context): string;
withContext() public method

Creates a new instance with the specified filter context.

public self withContext ( Yiisoft\Yii\DataView\Filter\Widget\Context $context )
$context Yiisoft\Yii\DataView\Filter\Widget\Context

The filter context containing property, value, and form data.
return self

New instance with the specified context.

 

                final public function withContext(Context $context): self
{
    $new = clone $this;
    $new->context = $context;
    return $new;
}