Inheritance diagram for Collection:

Public Member Functions
	__construct (EntityFactoryInterface $entityFactory)

	addFilter ($field, $value, $type='and')

	addFieldToFilter ($field, $condition)

	getFilter ($field)

	isLoaded ()

	getCurPage ($displacement=0)

	getLastPageNumber ()

	getPageSize ()

	getSize ()

	getFirstItem ()

	getLastItem ()

	getItems ()

	getColumnValues ($colName)

	getItemsByColumnValue ($column, $value)

	getItemByColumnValue ($column, $value)

	addItem (\Magento\Framework\DataObject $item)

	getAllIds ()

	removeItemByKey ($key)

	removeAllItems ()

	clear ()

	walk ($callback, array $args=[])

	each ($objMethod, $args=[])

	setDataToAll ($key, $value=null)

	setCurPage ($page)

	setPageSize ($size)

	setOrder ($field, $direction=self::SORT_ORDER_DESC)

	setItemObjectClass ($className)

	getNewEmptyItem ()

	distinct ($flag)

	loadData ($printQuery=false, $logQuery=false)

	load ($printQuery=false, $logQuery=false)

	loadWithFilter ($printQuery=false, $logQuery=false)

	toXml ()

	toArray ($arrRequiredFields=[])

	toOptionArray ()

	toOptionHash ()

	getItemById ($idValue)

	getIterator ()

	count ()

	getFlag ($flag)

	setFlag ($flag, $value=null)

	hasFlag ($flag)

	__sleep ()

	__wakeup ()

Data Fields
const	SORT_ORDER_ASC = 'ASC'

const	SORT_ORDER_DESC = 'DESC'

Protected Member Functions
	_setIsLoaded ($flag=true)

	_addItem ($item)

	_getItemId (\Magento\Framework\DataObject $item)

	_renderFilters ()

	_renderOrders ()

	_renderLimit ()

	_toOptionArray ($valueField='id', $labelField='name', $additional=[])

	_toOptionHash ($valueField='id', $labelField='name')

Protected Attributes
	$_items = []

	$_itemObjectClass = \Magento\Framework\DataObject::class

	$_orders = []

	$_filters = []

	$_isFiltersRendered = false

	$_curPage = 1

	$_pageSize = false

	$_totalRecords

	$_isCollectionLoaded

	$_flags = []

	$_entityFactory

Detailed Description

Data collection

TODO: Refactor use of \Magento\Framework\Option\ArrayInterface in library.

@api

Since: 100.0.2

Definition at line 19 of file Collection.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( EntityFactoryInterface $entityFactory )

Parameters

EntityFactoryInterface $entityFactory

Definition at line 105 of file Collection.php.

     {
         $this->_entityFactory = $entityFactory;
     }

Member Function Documentation

◆ __sleep()

__sleep ( )

Returns: string[]

Since: 100.0.11

Definition at line 886 of file Collection.php.

     {
         $properties = array_keys(get_object_vars($this));
         $properties = array_diff(
             $properties,
             [
                 '_entityFactory',
             ]
         );
         return $properties;
     }

◆ __wakeup()

__wakeup ( )

Init not serializable fields

Returns: void

Since: 100.0.11

Definition at line 904 of file Collection.php.

     {
         $objectManager = \Magento\Framework\App\ObjectManager::getInstance();
         $this->_entityFactory = $objectManager->get(EntityFactoryInterface::class);
     }

◆ _addItem()

_addItem ( $item )

protected

Add item that has no id to collection

Parameters

\Magento\Framework\DataObject $item

Returns: $this

Definition at line 422 of file Collection.php.

     {
         $this->_items[] = $item;
         return $this;
     }

◆ _getItemId()

_getItemId ( \Magento\Framework\DataObject $item )

protected

Retrieve item id

Parameters

\Magento\Framework\DataObject $item

Returns: mixed

Definition at line 434 of file Collection.php.

     {
         return $item->getId();
     }

◆ _renderFilters()

_renderFilters ( )

protected

Render sql select conditions

Returns: $this

Definition at line 630 of file Collection.php.

     {
         return $this;
     }

◆ _renderLimit()

_renderLimit ( )

protected

Render sql select limit

Returns: $this

Definition at line 650 of file Collection.php.

     {
         return $this;
     }

◆ _renderOrders()

_renderOrders ( )

protected

Render sql select orders

Returns: $this

Definition at line 640 of file Collection.php.

     {
         return $this;
     }

◆ _setIsLoaded()

_setIsLoaded ( $flag = true )

protected

Set collection loading status flag

Parameters

bool $flag

Returns: $this

Definition at line 228 of file Collection.php.

     {
         $this->_isCollectionLoaded = $flag;
         return $this;
     }

◆ _toOptionArray()

_toOptionArray	(	$valueField = `'id'`,
		$labelField = `'name'`,
		$additional = `[]`
	)

protected

Convert items array to array for select options

return items array array( $index => array( 'value' => mixed 'label' => mixed ) )

Parameters

string	$valueField
string	$labelField
array	$additional

Returns: array

Definition at line 760 of file Collection.php.

     {
         $res = [];
         $additional['value'] = $valueField;
         $additional['label'] = $labelField;
 
         foreach ($this as $item) {
             foreach ($additional as $code => $field) {
                 $data[$code] = $item->getData($field);
             }
             $res[] = $data;
         }
         return $res;
     }

◆ _toOptionHash()

_toOptionHash	(	$valueField = `'id'`,
		$labelField = `'name'`
	)

protected

Convert items array to hash for select options

return items hash array($value => $label)

Parameters

string	$valueField
string	$labelField

Returns: array

Definition at line 801 of file Collection.php.

     {
         $res = [];
         foreach ($this as $item) {
             $res[$item->getData($valueField)] = $item->getData($labelField);
         }
         return $res;
     }

◆ addFieldToFilter()

addFieldToFilter	(	$field,
		$condition
	)

Add field filter to collection

If $condition integer or string - exact value will be filtered ('eq' condition)

If $condition is array - one of the following structures is expected:


["from" => $fromValue, "to" => $toValue]
["eq" => $equalValue]
["neq" => $notEqualValue]
["like" => $likeValue]
["in" => [$inValues]]
["nin" => [$notInValues]]
["notnull" => $valueIsNotNull]
["null" => $valueIsNull]
["moreq" => $moreOrEqualValue]
["gt" => $greaterValue]
["lt" => $lessValue]
["gteq" => $greaterOrEqualValue]
["lteq" => $lessOrEqualValue]
["finset" => $valueInSet]

If non matched - sequential parallel arrays are expected and OR conditions
will be built using above mentioned structure.

Example:
$field = ['age', 'name'];
$condition = [42, ['like' => 'Mage']];
 The above would find where age equal to 42 OR name like Mage%.

Parameters

  
    string | array $field 
    string | int | array $condition 
  
  

Exceptions

Definition at line 170 of file Collection.php.

     {
         throw new \Magento\Framework\Exception\LocalizedException(new \Magento\Framework\Phrase('Not implemented'));
     }

◆ addFilter()

addFilter	(	$field,
		$value,
		$type = `'and'`
	)

Add collection filter

Parameters

string	$field
string	$value
string	$type	and\|or\|string

Returns: $this

Definition at line 118 of file Collection.php.

     {
         $filter = new \Magento\Framework\DataObject();
         // implements ArrayAccess
         $filter['field'] = $field;
         $filter['value'] = $value;
         $filter['type'] = strtolower($type);
 
         $this->_filters[] = $filter;
         $this->_isFiltersRendered = false;
         return $this;
     }

◆ addItem()

addItem ( \Magento\Framework\DataObject $item )

Adding item to item array

Parameters

\Magento\Framework\DataObject $item

Returns: $this

Exceptions

Definition at line 399 of file Collection.php.

     {
         $itemId = $this->_getItemId($item);
 
         if ($itemId !== null) {
             if (isset($this->_items[$itemId])) {
                 throw new \Exception(
                     'Item (' . get_class($item) . ') with the same ID "' . $item->getId() . '" already exists.'
                 );
             }
             $this->_items[$itemId] = $item;
         } else {
             $this->_addItem($item);
         }
         return $this;
     }

◆ clear()

clear ( )

Clear collection

Returns: $this

Definition at line 483 of file Collection.php.

     {
         $this->_setIsLoaded(false);
         $this->_items = [];
         return $this;
     }

◆ count()

count ( )

Retrieve count of collection loaded items

Returns: int

Definition at line 841 of file Collection.php.

     {
         $this->load();
         return count($this->_items);
     }

◆ distinct()

distinct ( $flag )

Set select distinct

Parameters

bool $flag

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 662 of file Collection.php.

     {
         return $this;
     }

◆ each()

each	(	$objMethod,
		$args = `[]`
	)

Call method or callback on each item in the collection.

Parameters

string \| array \| \Closure	$objMethod
array	$args

Returns: void

Definition at line 524 of file Collection.php.

     {
         if ($objMethod instanceof \Closure) {
             foreach ($this->getItems() as $item) {
                 $objMethod($item, ...$args);
             }
         } elseif (is_array($objMethod)) {
             foreach ($this->getItems() as $item) {
                 call_user_func($objMethod, $item, ...$args);
             }
         } else {
             foreach ($this->getItems() as $item) {
                 $item->$objMethod(...$args);
             }
         }
     }

◆ getAllIds()

getAllIds ( )

Retrieve ids of all items

Returns: array

Definition at line 444 of file Collection.php.

     {
         $ids = [];
         foreach ($this->getItems() as $item) {
             $ids[] = $this->_getItemId($item);
         }
         return $ids;
     }

◆ getColumnValues()

getColumnValues ( $colName )

Retrieve field values from all items

Parameters

string $colName

Returns: array

Definition at line 342 of file Collection.php.

     {
         $this->load();
 
         $col = [];
         foreach ($this->getItems() as $item) {
             $col[] = $item->getData($colName);
         }
         return $col;
     }

◆ getCurPage()

getCurPage ( $displacement = 0 )

Get current collection page

Parameters

int $displacement

Returns: int

Definition at line 240 of file Collection.php.

     {
         if ($this->_curPage + $displacement < 1) {
             return 1;
         } elseif ($this->_curPage + $displacement > $this->getLastPageNumber()) {
             return $this->getLastPageNumber();
         } else {
             return $this->_curPage + $displacement;
         }
     }

◆ getFilter()

getFilter ( $field )

Search for a filter by specified field

Multiple filters can be matched if an array is specified:

'foo' – get the first filter with field name 'foo'
array('foo') – get all filters with field name 'foo'
array('foo', 'bar') – get all filters with field name 'foo' or 'bar'
array() – get all filters

Parameters

string|string[] $field

Returns: \Magento\Framework\DataObject|\Magento\Framework\DataObject[]|void

Definition at line 187 of file Collection.php.

     {
         if (is_array($field)) {
             // empty array: get all filters
             if (empty($field)) {
                 return $this->_filters;
             }
             // non-empty array: collect all filters that match specified field names
             $result = [];
             foreach ($this->_filters as $filter) {
                 if (in_array($filter['field'], $field)) {
                     $result[] = $filter;
                 }
             }
             return $result;
         }
 
         // get a first filter by specified name
         foreach ($this->_filters as $filter) {
             if ($filter['field'] === $field) {
                 return $filter;
             }
         }
     }

◆ getFirstItem()

getFirstItem ( )

Retrieve collection first item

Returns: \Magento\Framework\DataObject

Definition at line 297 of file Collection.php.

     {
         $this->load();
 
         if (count($this->_items)) {
             reset($this->_items);
             return current($this->_items);
         }
 
         return $this->_entityFactory->create($this->_itemObjectClass);
     }

◆ getFlag()

getFlag ( $flag )

Retrieve Flag

Parameters

string $flag

Returns: bool|null

Definition at line 853 of file Collection.php.

     {
         return $this->_flags[$flag] ?? null;
     }

◆ getItemByColumnValue()

getItemByColumnValue	(	$column,
		$value
	)

Search first item by field value

Parameters

string	$column
mixed	$value

Returns: \Magento\Framework\DataObject || null

Definition at line 380 of file Collection.php.

     {
         $this->load();
 
         foreach ($this as $item) {
             if ($item->getData($column) == $value) {
                 return $item;
             }
         }
         return null;
     }

◆ getItemById()

getItemById ( $idValue )

Retrieve item by id

Parameters

mixed $idValue

Returns: \Magento\Framework\DataObject

Definition at line 816 of file Collection.php.

     {
         $this->load();
         if (isset($this->_items[$idValue])) {
             return $this->_items[$idValue];
         }
         return null;
     }

◆ getItems()

getItems ( )

Retrieve collection items

Returns: \Magento\Framework\DataObject[]

Definition at line 330 of file Collection.php.

     {
         $this->load();
         return $this->_items;
     }

◆ getItemsByColumnValue()

getItemsByColumnValue	(	$column,
		$value
	)

Search all items by field value

Parameters

string	$column
mixed	$value

Returns: array

Definition at line 360 of file Collection.php.

     {
         $this->load();
 
         $res = [];
         foreach ($this as $item) {
             if ($item->getData($column) == $value) {
                 $res[] = $item;
             }
         }
         return $res;
     }

◆ getIterator()

getIterator ( )

Implementation of \IteratorAggregate::getIterator()

Returns: \ArrayIterator

Definition at line 830 of file Collection.php.

     {
         $this->load();
         return new \ArrayIterator($this->_items);
     }

◆ getLastItem()

getLastItem ( )

Retrieve collection last item

Returns: \Magento\Framework\DataObject

Definition at line 314 of file Collection.php.

     {
         $this->load();
 
         if (count($this->_items)) {
             return end($this->_items);
         }
 
         return $this->_entityFactory->create($this->_itemObjectClass);
     }

◆ getLastPageNumber()

getLastPageNumber ( )

Retrieve collection last page number

Returns: int

Definition at line 256 of file Collection.php.

     {
         $collectionSize = (int)$this->getSize();
         if (0 === $collectionSize) {
             return 1;
         } elseif ($this->_pageSize) {
             return ceil($collectionSize / $this->_pageSize);
         } else {
             return 1;
         }
     }

◆ getNewEmptyItem()

getNewEmptyItem ( )

Retrieve collection empty item

Returns: \Magento\Framework\DataObject

Definition at line 620 of file Collection.php.

     {
         return $this->_entityFactory->create($this->_itemObjectClass);
     }

◆ getPageSize()

getPageSize ( )

Retrieve collection page size

Returns: int

Definition at line 273 of file Collection.php.

     {
         return $this->_pageSize;
     }

◆ getSize()

getSize ( )

Retrieve collection all items count

Returns: int

Definition at line 283 of file Collection.php.

     {
         $this->load();
         if ($this->_totalRecords === null) {
             $this->_totalRecords = count($this->getItems());
         }
         return intval($this->_totalRecords);
     }

◆ hasFlag()

hasFlag ( $flag )

Has Flag

Parameters

string $flag

Returns: bool

Definition at line 877 of file Collection.php.

     {
         return array_key_exists($flag, $this->_flags);
     }

◆ isLoaded()

isLoaded ( )

Retrieve collection loading status

Returns: bool

Definition at line 217 of file Collection.php.

     {
         return $this->_isCollectionLoaded;
     }

◆ load()

load	(	$printQuery = `false`,
		$logQuery = `false`
	)

Load data

Parameters

bool	$printQuery
bool	$logQuery

Returns: $this

Definition at line 687 of file Collection.php.

     {
         return $this->loadData($printQuery, $logQuery);
     }

◆ loadData()

loadData	(	$printQuery = `false`,
		$logQuery = `false`
	)

Load data

Parameters

bool	$printQuery
bool	$logQuery

Returns: $this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 675 of file Collection.php.

     {
         return $this;
     }

◆ loadWithFilter()

loadWithFilter	(	$printQuery = `false`,
		$logQuery = `false`
	)

Load data with filter in place

Parameters

bool	$printQuery
bool	$logQuery

Returns: $this

Definition at line 699 of file Collection.php.

     {
         return $this->loadData($printQuery, $logQuery);
     }

◆ removeAllItems()

removeAllItems ( )

Remove all items from collection

Returns: $this

Definition at line 472 of file Collection.php.

     {
         $this->_items = [];
         return $this;
     }

◆ removeItemByKey()

removeItemByKey ( $key )

Remove item from collection by item key

Parameters

mixed $key

Returns: $this

Definition at line 459 of file Collection.php.

     {
         if (isset($this->_items[$key])) {
             unset($this->_items[$key]);
         }
         return $this;
     }

◆ setCurPage()

setCurPage ( $page )

Set current page

Parameters

int $page

Returns: $this

Definition at line 568 of file Collection.php.

     {
         $this->_curPage = $page;
         return $this;
     }

◆ setDataToAll()

setDataToAll	(	$key,
		$value = `null`
	)

Setting data for all collection items

Parameters

mixed	$key
mixed	$value

Returns: $this

Definition at line 548 of file Collection.php.

     {
         if (is_array($key)) {
             foreach ($key as $k => $v) {
                 $this->setDataToAll($k, $v);
             }
             return $this;
         }
         foreach ($this->getItems() as $item) {
             $item->setData($key, $value);
         }
         return $this;
     }

◆ setFlag()

setFlag	(	$flag,
		$value = `null`
	)

Set Flag

Parameters

string	$flag
bool \| null	$value

Returns: $this

Definition at line 865 of file Collection.php.

     {
         $this->_flags[$flag] = $value;
         return $this;
     }

◆ setItemObjectClass()

setItemObjectClass ( $className )

Set collection item class name

Parameters

string $className

Returns: $this

Exceptions

Definition at line 606 of file Collection.php.

     {
         if (!is_a($className, \Magento\Framework\DataObject::class, true)) {
             throw new \InvalidArgumentException($className . ' does not extend \Magento\Framework\DataObject');
         }
         $this->_itemObjectClass = $className;
         return $this;
     }

◆ setOrder()

setOrder	(	$field,
		$direction = `self::SORT_ORDER_DESC`
	)

Set select order

Parameters

string	$field
string	$direction

Returns: $this

Definition at line 593 of file Collection.php.

     {
         $this->_orders[$field] = $direction;
         return $this;
     }

◆ setPageSize()

setPageSize ( $size )

Set collection page size

Parameters

int $size

Returns: $this

Definition at line 580 of file Collection.php.

     {
         $this->_pageSize = $size;
         return $this;
     }

◆ toArray()

toArray ( $arrRequiredFields = [] )

Convert collection to array

Parameters

array $arrRequiredFields

Returns: array

Definition at line 732 of file Collection.php.

     {
         $arrItems = [];
         $arrItems['totalRecords'] = $this->getSize();
 
         $arrItems['items'] = [];
         foreach ($this as $item) {
             $arrItems['items'][] = $item->toArray($arrRequiredFields);
         }
         return $arrItems;
     }

◆ toOptionArray()

toOptionArray ( )

Returns: array

Implements OptionSourceInterface.

Definition at line 778 of file Collection.php.

     {
         return $this->_toOptionArray();
     }

◆ toOptionHash()

toOptionHash ( )

Returns: array

Definition at line 786 of file Collection.php.

     {
         return $this->_toOptionHash();
     }

◆ toXml()

toXml ( )

Convert collection to XML

Returns: string

Definition at line 709 of file Collection.php.

     {
         $xml = '<?xml version="1.0" encoding="UTF-8"?>
         <collection>
            <totalRecords>' .
             $this->_totalRecords .
             '</totalRecords>
            <items>';
 
         foreach ($this as $item) {
             $xml .= $item->toXml();
         }
         $xml .= '</items>
         </collection>';
         return $xml;
     }

◆ walk()

walk	(		$callback,
		array	$args = `[]`
	)

Walk through the collection and run model method or external callback with optional arguments

Returns array with results of callback for each item

Parameters

callable	$callback
array	$args

Returns: array

Definition at line 500 of file Collection.php.

     {
         $results = [];
         $useItemCallback = is_string($callback) && strpos($callback, '::') === false;
         foreach ($this->getItems() as $id => $item) {
             $params = $args;
             if ($useItemCallback) {
                 $cb = [$item, $callback];
             } else {
                 $cb = $callback;
                 array_unshift($params, $item);
             }
             $results[$id] = call_user_func_array($cb, $params);
         }
         return $results;
     }

Field Documentation

◆ $_curPage

$_curPage = 1

protected

Definition at line 65 of file Collection.php.

◆ $_entityFactory

$_entityFactory

protected

Definition at line 100 of file Collection.php.

◆ $_filters

$_filters = []

protected

Definition at line 51 of file Collection.php.

◆ $_flags

$_flags = []

protected

Definition at line 95 of file Collection.php.

◆ $_isCollectionLoaded

$_isCollectionLoaded

protected

Definition at line 88 of file Collection.php.

◆ $_isFiltersRendered

$_isFiltersRendered = false

protected

Definition at line 58 of file Collection.php.

◆ $_itemObjectClass

$_itemObjectClass = \Magento\Framework\DataObject::class

protected

Definition at line 37 of file Collection.php.

◆ $_items

$_items = []

protected

Definition at line 30 of file Collection.php.

◆ $_orders

$_orders = []

protected

Definition at line 44 of file Collection.php.

◆ $_pageSize

$_pageSize = false

protected

Definition at line 74 of file Collection.php.

◆ $_totalRecords

$_totalRecords

protected

Definition at line 81 of file Collection.php.

◆ SORT_ORDER_ASC

const SORT_ORDER_ASC = 'ASC'

Definition at line 21 of file Collection.php.

◆ SORT_ORDER_DESC

const SORT_ORDER_DESC = 'DESC'

Definition at line 23 of file Collection.php.

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

vendor/magento/framework/Data/Collection.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __sleep()

◆ __wakeup()

◆ _addItem()

◆ _getItemId()

◆ _renderFilters()

◆ _renderLimit()

◆ _renderOrders()

◆ _setIsLoaded()

◆ _toOptionArray()

◆ _toOptionHash()

◆ addFieldToFilter()

◆ addFilter()

◆ addItem()

◆ clear()

◆ count()

◆ distinct()

◆ each()

◆ getAllIds()

◆ getColumnValues()

◆ getCurPage()

◆ getFilter()

◆ getFirstItem()

◆ getFlag()

◆ getItemByColumnValue()

◆ getItemById()

◆ getItems()

◆ getItemsByColumnValue()

◆ getIterator()

◆ getLastItem()

◆ getLastPageNumber()

◆ getNewEmptyItem()

◆ getPageSize()

◆ getSize()

◆ hasFlag()

◆ isLoaded()

◆ load()

◆ loadData()

◆ loadWithFilter()

◆ removeAllItems()

◆ removeItemByKey()

◆ setCurPage()

◆ setDataToAll()

◆ setFlag()

◆ setItemObjectClass()

◆ setOrder()

◆ setPageSize()

◆ toArray()

◆ toOptionArray()

◆ toOptionHash()

◆ toXml()

◆ walk()

Field Documentation

◆ $_curPage

◆ $_entityFactory

◆ $_filters

◆ $_flags

◆ $_isCollectionLoaded

◆ $_isFiltersRendered

◆ $_itemObjectClass

◆ $_items

◆ $_orders

◆ $_pageSize

◆ $_totalRecords

◆ SORT_ORDER_ASC

◆ SORT_ORDER_DESC