EntitySnapshot Class Reference

Public Member Functions
	__construct (MetadataPool $metadataPool, AttributeProvider $attributeProvider)
	registerSnapshot ($entityType, $entity)
	isModified ($entityType, $entity)

Protected Attributes
	$snapshotData = []
	$metadataPool
	$attributeProvider

Detailed Description

Class EntitySnapshot

Definition at line 15 of file EntitySnapshot.php.

Constructor & Destructor Documentation

__construct()

__construct	(	MetadataPool	$metadataPool,
		AttributeProvider	$attributeProvider
	)

Parameters

MetadataPool	$metadataPool
AttributeProvider	$attributeProvider

Definition at line 38 of file EntitySnapshot.php.

      {
        $this->metadataPool = $metadataPool;
        $this->attributeProvider = $attributeProvider;
    }

Member Function Documentation

isModified()

isModified	(		$entityType,
			$entity
	)

Check is current entity has changes, by comparing current object state with stored snapshot

Parameters

string	$entityType
object	$entity

Returns

bool

Definition at line 68 of file EntitySnapshot.php.

    {
        $metadata = $this->metadataPool->getMetadata($entityType);
        $hydrator = $this->metadataPool->getHydrator($entityType);
        $entityData = $hydrator->extract($entity);
        if (empty($entityData[$metadata->getIdentifierField()])) {
            return true;
        }
        $identifier = $entityData[$metadata->getIdentifierField()];
        if (!isset($this->snapshotData[$entityType][$identifier])) {
            return true;
        }
        foreach ($this->snapshotData[$entityType][$identifier] as $field => $value) {
            if (isset($entityData[$field]) && $entityData[$field] != $value) {
                return true;
            }
        }
        return false;
    }

registerSnapshot()

registerSnapshot	(		$entityType,
			$entity
	)

Parameters

string	$entityType
object	$entity

Returns

void

Definition at line 51 of file EntitySnapshot.php.

    {
        $metadata = $this->metadataPool->getMetadata($entityType);
        $hydrator = $this->metadataPool->getHydrator($entityType);
        $entityData = $hydrator->extract($entity);
        $attributes = $this->attributeProvider->getAttributes($entityType);
        $this->snapshotData[$entityType][$entityData[$metadata->getIdentifierField()]]
            = array_intersect_key($entityData, $attributes);
    }

Field Documentation

$attributeProvider

$attributeProvider

protected

Definition at line 32 of file EntitySnapshot.php.

$metadataPool

$metadataPool

protected

Definition at line 27 of file EntitySnapshot.php.

$snapshotData

$snapshotData = []

protected

Definition at line 22 of file EntitySnapshot.php.

---

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

• vendor/magento/framework/Model/EntitySnapshot.php