SearchResults Class Reference

Inheritance diagram for SearchResults:

Public Member Functions
	getItems ()
	setItems (array $items)
	getSearchCriteria ()
	setSearchCriteria (\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)
	getTotalCount ()
	setTotalCount ($count)
Public Member Functions inherited from AbstractSimpleObject
	__construct (array $data=[])
	setData ($key, $value)
	__toArray ()

Data Fields
const	KEY_ITEMS = 'items'
const	KEY_SEARCH_CRITERIA = 'search_criteria'
const	KEY_TOTAL_COUNT = 'total_count'

Additional Inherited Members
Protected Member Functions inherited from AbstractSimpleObject
	_get ($key)
Protected Attributes inherited from AbstractSimpleObject
	$_data

Detailed Description

SearchResults Service Data Object used for the search service requests

Definition at line 12 of file SearchResults.php.

Member Function Documentation

getItems()

getItems

(

)

Get items

Returns

\Magento\Framework\Api\AbstractExtensibleObject[]

Implements SearchResultsInterface.

Definition at line 23 of file SearchResults.php.

    {
        return $this->_get(self::KEY_ITEMS) === null ? [] : $this->_get(self::KEY_ITEMS);
    }

getSearchCriteria()

getSearchCriteria

(

)

Get search criteria

Returns

\Magento\Framework\Api\SearchCriteria

Implements SearchResultsInterface.

Definition at line 44 of file SearchResults.php.

    {
        return $this->_get(self::KEY_SEARCH_CRITERIA);
    }

getTotalCount()

getTotalCount

(

)

Get total count

Returns

int

Implements SearchResultsInterface.

Definition at line 65 of file SearchResults.php.

    {
        return $this->_get(self::KEY_TOTAL_COUNT);
    }

setItems()

setItems

(

array

$items

)

Set items

Parameters

Implements SearchResultsInterface.

Definition at line 34 of file SearchResults.php.

    {
        return $this->setData(self::KEY_ITEMS, $items);
    }

setSearchCriteria()

setSearchCriteria

(

\Magento\Framework\Api\SearchCriteriaInterface

$searchCriteria

)

Set search criteria

Parameters

SearchCriteriaInterface

$searchCriteria

Returns

$this

Implements SearchResultsInterface.

Definition at line 55 of file SearchResults.php.

    {
        return $this->setData(self::KEY_SEARCH_CRITERIA, $searchCriteria);
    }

setTotalCount()

setTotalCount

(

$count

)

Set total count

Parameters

int

$count

Returns

$this

Implements SearchResultsInterface.

Definition at line 76 of file SearchResults.php.

    {
        return $this->setData(self::KEY_TOTAL_COUNT, $count);
    }

Field Documentation

KEY_ITEMS

const KEY_ITEMS = 'items'

Definition at line 14 of file SearchResults.php.

KEY_SEARCH_CRITERIA

const KEY_SEARCH_CRITERIA = 'search_criteria'

Definition at line 15 of file SearchResults.php.

KEY_TOTAL_COUNT

const KEY_TOTAL_COUNT = 'total_count'

Definition at line 16 of file SearchResults.php.

---

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

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