Filters Class Reference

Inheritance diagram for Filters:

Public Member Functions
	__construct (ContextInterface $context, UiComponentFactory $uiComponentFactory, array $components=[], array $data=[])
	getComponentName ()
	update (UiComponentInterface $component)
	addComponent ($name, UiComponentInterface $component)
	getChildComponents ()
Public Member Functions inherited from AbstractComponent
	__construct (ContextInterface $context, array $components=[], array $data=[])
	getContext ()
	getName ()
	prepare ()
	toHtml ()
	render ()
	addComponent ($name, UiComponentInterface $component)
	getComponent ($name)
	getChildComponents ()
	renderChildComponent ($name)
	getTemplate ()
	getConfiguration ()
	getJsConfig (UiComponentInterface $component)
	setData ($key, $value=null)
	getData ($key='', $index=null)
	prepareDataSource (array $dataSource)
	getDataSourceData ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Data Fields
const	NAME = 'filters'

Protected Attributes
	$columnFilters = []
	$filterMap
	$uiComponentFactory
Protected Attributes inherited from AbstractComponent
	$context
	$components
	$componentData = []
	$dataSources = []
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Protected Member Functions inherited from AbstractComponent
	prepareChildComponent (UiComponentInterface $component)
	initObservers (array & $data=[])
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

@api

Since

100.0.2

Definition at line 18 of file Filters.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ContextInterface	$context,
		UiComponentFactory	$uiComponentFactory,
		array	$components = [],
		array	$data = []
	)

@inheritDoc

Definition at line 49 of file Filters.php.

      {
        parent::__construct($context, $components, $data);
        $this->uiComponentFactory = $uiComponentFactory;
    }

Member Function Documentation

addComponent()

addComponent	(		$name,
		UiComponentInterface	$component
	)

@inheritDoc

Implements UiComponentInterface.

Definition at line 101 of file Filters.php.

    {
        $this->columnFilters[$name] = $component;
        parent::addComponent($name, $component);
    }

getChildComponents()

getChildComponents

(

)

@inheritDoc

Implements UiComponentInterface.

Definition at line 110 of file Filters.php.

    {
        $result = parent::getChildComponents();
        foreach (array_keys($this->columnFilters) as $componentName) {
            if ($this->getComponent($componentName)) {
                unset($result[$componentName]);
            }
        }

        return $result;
    }

getComponentName()

getComponentName

(

)

Get component name

Returns

string

Implements UiComponentInterface.

Definition at line 64 of file Filters.php.

    {
        return static::NAME;
    }

update()

update

(

UiComponentInterface

$component

)

@inheritDoc

Implements ObserverInterface.

Definition at line 72 of file Filters.php.

    {
        if ($component instanceof ColumnInterface) {
            $filterType = $component->getData('config/filter');

            if (is_array($filterType)) {
                $filterType = $filterType['filterType'];
            }

            if (!$filterType) {
                return;
            }

            if (isset($this->filterMap[$filterType]) && !isset($this->columnFilters[$component->getName()])) {
                $filterComponent = $this->uiComponentFactory->create(
                    $component->getName(),
                    $this->filterMap[$filterType],
                    ['context' => $this->getContext()]
                );
                $filterComponent->setData('config', $component->getConfiguration());
                $filterComponent->prepare();
                $this->addComponent($component->getName(), $filterComponent);
            }
        }
    }

Field Documentation

$columnFilters

$columnFilters = []

protected

Definition at line 27 of file Filters.php.

$filterMap

$filterMap

protected

Initial value:

= [
        'text' => 'filterInput',
        'textRange' => 'filterRange',
        'select' => 'filterSelect',
        'dateRange' => 'filterDate',
    ]

Definition at line 34 of file Filters.php.

$uiComponentFactory

$uiComponentFactory

protected

Definition at line 44 of file Filters.php.

NAME

const NAME = 'filters'

Definition at line 20 of file Filters.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-ui/Component/Filters.php