EntityStorage Class Reference

Public Member Functions
	addByIdentifyingFields (FrameworkAbstractModel $object, array $identifyingFields, $storageName)
	add ($entity)
	get ($id)
	getByIdentifyingFields (array $identifyingFields, $storageName)
	remove ($id)
	has ($id)

Data Fields
const	GLUE = ''

Protected Member Functions
	getHash (array $fields)

Protected Attributes
	$registry = []
	$storageMapper = []

Detailed Description

Class EntityStorage store only one type of entity per instance

Definition at line 14 of file EntityStorage.php.

Member Function Documentation

add()

add

(

$entity

)

Add entity to registry if entity in it

Parameters

\Magento\Framework\Model\AbstractModel

$entity

Returns

void

Definition at line 60 of file EntityStorage.php.

    {
        $this->registry[$entity->getId()] = $entity;
    }

addByIdentifyingFields()

addByIdentifyingFields	(	FrameworkAbstractModel	$object,
		array	$identifyingFields,
			$storageName
	)

Adds entity using identifying fields mapping, entity should have an id

Parameters

FrameworkAbstractModel	$object
array	$identifyingFields
string	$storageName

Returns

void

Exceptions

Definition at line 42 of file EntityStorage.php.

    {
        if (empty($identifyingFields)) {
            throw new \Magento\Framework\Exception\InputException(__('Identifying Fields required'));
        }
        if (!$object->getId()) {
            throw new \Magento\Framework\Exception\InputException(__('An ID is needed. Set the ID and try again.'));
        }
        $this->storageMapper[$storageName][$this->getHash($identifyingFields)] = $object->getId();
        $this->registry[$object->getId()] = $object;
    }

get()

get

(

$id

)

Retrieve entity from registry if entity in it

Parameters

int

$id

Returns

bool|FrameworkAbstractModel

Definition at line 71 of file EntityStorage.php.

    {
        if ($this->has($id)) {
            return $this->registry[$id];
        }
        return false;
    }

getByIdentifyingFields()

getByIdentifyingFields	(	array	$identifyingFields,
			$storageName
	)

Gets entity by identifying fields

Parameters

array	$identifyingFields
string	$storageName

Returns

bool|FrameworkAbstractModel

Definition at line 86 of file EntityStorage.php.

    {
        $hash = $this->getHash($identifyingFields);
        if (isset($this->storageMapper[$storageName][$hash])) {
            return $this->get($this->storageMapper[$storageName][$hash]);
        }
        return false;
    }

getHash()

getHash ( array  $fields )

protected

Gets hash using concatenation of identifying fields

Parameters

array

$fields

Returns

string

Definition at line 125 of file EntityStorage.php.

    {
        $stringForKey = implode(self::GLUE, $fields);
        return sha1($stringForKey);
    }

has()

has

(

$id

)

Checks if entity is in storage

Parameters

int

$id

Returns

bool

Definition at line 114 of file EntityStorage.php.

    {
        return isset($this->registry[$id]);
    }

remove()

remove

(

$id

)

Remove entity from storage

Parameters

int

$id

Returns

void

Definition at line 101 of file EntityStorage.php.

    {
        if ($this->has($id)) {
            unset($this->registry[$id]);
        }
    }

Field Documentation

$registry

$registry = []

protected

Definition at line 19 of file EntityStorage.php.

$storageMapper

$storageMapper = []

protected

Definition at line 26 of file EntityStorage.php.

GLUE

const GLUE = ''

Using for array concatenation

Definition at line 31 of file EntityStorage.php.

---

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

• vendor/magento/module-sales/Model/EntityStorage.php