SearchCriteriaBuilder Class Reference

Inheritance diagram for SearchCriteriaBuilder:

Public Member Functions
	__construct (ObjectFactory $objectFactory, FilterGroupBuilder $filterGroupBuilder, FilterBuilder $filterBuilder)
	create ()
	addFilters (array $filter)
	addFilter ($field, $value, $conditionType='eq')
	setFilterGroups (array $filterGroups)
	addSortOrder ($sortOrder)
	setSortOrders (array $sortOrders)
	setPageSize ($pageSize)
	setCurrentPage ($currentPage)
Public Member Functions inherited from AbstractSimpleObjectBuilder
	__construct (ObjectFactory $objectFactory)
	create ()
	getData ()

Protected Attributes
	$_filterGroupBuilder
	$filterBuilder
Protected Attributes inherited from AbstractSimpleObjectBuilder
	$data
	$objectFactory

Additional Inherited Members
Protected Member Functions inherited from AbstractSimpleObjectBuilder
	_set ($key, $value)
	_getDataObjectType ()

Detailed Description

Builder for SearchCriteria Service Data Object

Definition at line 14 of file SearchCriteriaBuilder.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ObjectFactory	$objectFactory,
		FilterGroupBuilder	$filterGroupBuilder,
		FilterBuilder	$filterBuilder
	)

Parameters

ObjectFactory	$objectFactory
FilterGroupBuilder	$filterGroupBuilder
FilterBuilder	$filterBuilder

Definition at line 31 of file SearchCriteriaBuilder.php.

      {
        parent::__construct(
            $objectFactory
        );
        $this->_filterGroupBuilder = $filterGroupBuilder;
        $this->filterBuilder = $filterBuilder;
    }

Member Function Documentation

addFilter()

addFilter	(		$field,
			$value,
			$conditionType = 'eq'
	)

Parameters

string	$field
mixed	$value
string	$conditionType

Returns

$this

Definition at line 75 of file SearchCriteriaBuilder.php.

    {
        $this->addFilters([
            $this->filterBuilder->setField($field)
                ->setValue($value)
                ->setConditionType($conditionType)
                ->create()
        ]);
        return $this;
    }

addFilters()

addFilters

(

array

$filter

)

Create a filter group based on the filter array provided and add to the filter groups

Parameters

Definition at line 63 of file SearchCriteriaBuilder.php.

    {
        $this->data[SearchCriteria::FILTER_GROUPS][] = $this->_filterGroupBuilder->setFilters($filter)->create();
        return $this;
    }

addSortOrder()

addSortOrder

(

$sortOrder

)

Add sort order

Parameters

SortOrder

$sortOrder

Returns

$this

Definition at line 103 of file SearchCriteriaBuilder.php.

    {
        if (!isset($this->data[SearchCriteria::SORT_ORDERS])) {
            $this->data[SearchCriteria::SORT_ORDERS] = [];
        }
        $this->data[SearchCriteria::SORT_ORDERS][] = $sortOrder;
        return $this;
    }

create()

create

(

)

Builds the SearchCriteria Data Object

Returns

SearchCriteria

Implements SimpleBuilderInterface.

Definition at line 48 of file SearchCriteriaBuilder.php.

    {
        //Initialize with empty array if not set
        if (empty($this->data[SearchCriteria::FILTER_GROUPS])) {
            $this->_set(SearchCriteria::FILTER_GROUPS, []);
        }
        return parent::create();
    }

setCurrentPage()

setCurrentPage

(

$currentPage

)

Set current page

Parameters

int

$currentPage

Returns

$this

Definition at line 140 of file SearchCriteriaBuilder.php.

    {
        return $this->_set(SearchCriteria::CURRENT_PAGE, $currentPage);
    }

setFilterGroups()

setFilterGroups

(

array

$filterGroups

)

Set filter groups

Parameters

Definition at line 92 of file SearchCriteriaBuilder.php.

    {
        return $this->_set(SearchCriteria::FILTER_GROUPS, $filterGroups);
    }

setPageSize()

setPageSize

(

$pageSize

)

Set page size

Parameters

int

$pageSize

Returns

$this

Definition at line 129 of file SearchCriteriaBuilder.php.

    {
        return $this->_set(SearchCriteria::PAGE_SIZE, $pageSize);
    }

setSortOrders()

setSortOrders

(

array

$sortOrders

)

Set sort orders

Parameters

SortOrder[]

$sortOrders

Returns

$this

Definition at line 118 of file SearchCriteriaBuilder.php.

    {
        return $this->_set(SearchCriteria::SORT_ORDERS, $sortOrders);
    }

Field Documentation

$_filterGroupBuilder

$_filterGroupBuilder

protected

Definition at line 19 of file SearchCriteriaBuilder.php.

$filterBuilder

$filterBuilder

protected

Definition at line 24 of file SearchCriteriaBuilder.php.

---

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

• vendor/magento/framework/Api/SearchCriteriaBuilder.php