Generator Class Reference

Inheritance diagram for Generator:

Public Member Functions
	__construct (array $rowPattern, $limit)
	valid ()
Public Member Functions inherited from AbstractSource
	__construct (array $colNames)
	getColNames ()
	current ()
	next ()
	key ()
	valid ()
	rewind ()
	seek ($position)

Protected Member Functions
	_getNextRow ()
Protected Member Functions inherited from AbstractSource
	_getNextRow ()

Protected Attributes
	$_pattern = []
	$_dynamicColumns = []
	$_limit = 0
Protected Attributes inherited from AbstractSource
	$_colNames = []
	$_colQty
	$_row = []
	$_key = -1
	$_foundWrongQuoteFlag = false

Detailed Description

Definition at line 14 of file Generator.php.

Constructor & Destructor Documentation

__construct()

__construct	(	array	$rowPattern,
			$limit
	)

Read the row pattern to determine which columns are dynamic, set the collection size

Parameters

array	$rowPattern
int	$limit	how many records to generate

Definition at line 41 of file Generator.php.

    {
        foreach ($rowPattern as $key => $value) {
            if (is_callable($value) || is_string($value) && (false !== strpos($value, '%s'))) {
                $this->_dynamicColumns[$key] = $value;
            }
        }
        $this->_pattern = $rowPattern;
        $this->_limit = (int)$limit;
        parent::__construct(array_keys($rowPattern));
    }

Member Function Documentation

_getNextRow()

_getNextRow ( )

protected

Render next row

Return array or false on error

Returns

array|false

Definition at line 70 of file Generator.php.

    {
        $row = $this->_pattern;
        foreach ($this->_dynamicColumns as $key => $dynamicValue) {
            $index = $this->_key + 1;
            if (is_callable($dynamicValue)) {
                $row[$key] = call_user_func($dynamicValue, $index);
            } else {
                $row[$key] = str_replace('%s', $index, $dynamicValue);
            }
        }
        return $row;
    }

valid()

valid

(

)

Whether limit of generated elements is reached (according to "Iterator" interface)

Returns

bool

Definition at line 58 of file Generator.php.

    {
        return $this->_key + 1 <= $this->_limit;
    }

Field Documentation

$_dynamicColumns

$_dynamicColumns = []

protected

Definition at line 28 of file Generator.php.

$_limit

$_limit = 0

protected

Definition at line 33 of file Generator.php.

$_pattern

$_pattern = []

protected

Definition at line 21 of file Generator.php.

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Model/Generator.php