Iterator Class Reference

Inheritance diagram for Iterator:

Public Member Functions
	walk ($query, array $callbacks, array $args=[], $connection=null)
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)

Protected Member Functions
	_getStatement ($query, AdapterInterface $connection=null)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Additional Inherited Members
Protected Attributes inherited from DataObject
	$_data = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Definition at line 16 of file Iterator.php.

Member Function Documentation

_getStatement()

_getStatement (   $query, AdapterInterface  $connection = null  )

protected

Fetch Zend statement instance

Parameters

\Zend_Db_Statement_Interface | \Magento\Framework\DB\Select | string	$query
AdapterInterface	$connection

Returns

\Zend_Db_Statement_Interface

Exceptions

LocalizedException

Definition at line 53 of file Iterator.php.

    {
        if ($query instanceof \Zend_Db_Statement_Interface) {
            return $query;
        }

        if ($query instanceof \Zend_Db_Select) {
            return $query->query();
        }

        if (is_string($query)) {
            if (!$connection instanceof AdapterInterface) {
                throw new LocalizedException(
                    new Phrase('The connection is invalid. Verify the connection and try again.')
                );
            }
            return $connection->query($query);
        }

        throw new LocalizedException(new Phrase('The query is invalid. Verify the query and try again.'));
    }

walk()

walk	(		$query,
		array	$callbacks,
		array	$args = [],
			$connection = null
	)

Walk over records fetched from query one by one using callback function

Parameters

\Zend_Db_Statement_Interface | \Magento\Framework\DB\Select | string	$query
array | string	$callbacks
array	$args
AdapterInterface	$connection

Returns

\Magento\Framework\Model\ResourceModel\Iterator

Definition at line 27 of file Iterator.php.

    {
        $stmt = $this->_getStatement($query, $connection);
        $args['idx'] = 0;
        while ($row = $stmt->fetch()) {
            $args['row'] = $row;
            foreach ($callbacks as $callback) {
                $result = call_user_func($callback, $args);
                if (!empty($result)) {
                    $args = array_merge($args, (array)$result);
                }
            }
            $args['idx']++;
        }

        return $this;
    }

---

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

• vendor/magento/framework/Model/ResourceModel/Iterator.php