EntityManager Class Reference

Public Member Functions
	__construct (OperationPool $operationPool, MetadataPool $metadataPool, TypeResolver $typeResolver, CallbackHandler $callbackHandler)
	load ($entity, $identifier, $arguments=[])
	save ($entity, $arguments=[])
	has ($entity)
	delete ($entity, $arguments=[])

Detailed Description

It's not recommended to use EntityManager and its infrastructure for your entities persistence. In the nearest future new Persistence Entity Manager would be released which will cover all the requirements for persistence layer along with Query API as performance efficient APIs for Read scenarios.

Currently, it's recommended to use Resource Model infrastructure and make a successor of Magento\Framework\Model\ResourceModel\Db\AbstractDb class or successor of Magento\Eav\Model\Entity\AbstractEntity if EAV attributes support needed.

For filtering operations, it's recommended to use successor of Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection class.

Definition at line 26 of file EntityManager.php.

Constructor & Destructor Documentation

__construct()

__construct	(	OperationPool	$operationPool,
		MetadataPool	$metadataPool,
		TypeResolver	$typeResolver,
		CallbackHandler	$callbackHandler
	)

Parameters

OperationPool	$operationPool
MetadataPool	$metadataPool
TypeResolver	$typeResolver
CallbackHandler	$callbackHandler

Definition at line 44 of file EntityManager.php.

      {
        $this->operationPool = $operationPool;
        $this->metadataPool = $metadataPool;
        $this->typeResolver = $typeResolver;
        $this->callbackHandler = $callbackHandler;
    }

Member Function Documentation

delete()

delete	(		$entity,
			$arguments = []
	)

Parameters

object	$entity
array	$arguments

Returns

bool

Exceptions

Definition at line 127 of file EntityManager.php.

    {
        $entityType = $this->typeResolver->resolve($entity);
        $operation = $this->operationPool->getOperation($entityType, 'delete');
        if (!($operation instanceof DeleteInterface)) {
            throw new \LogicException(get_class($operation) . ' must implement ' . DeleteInterface::class);
        }
        try {
            $operation->execute($entity, $arguments);
            $this->callbackHandler->process($entityType);
        } catch (\Exception $e) {
            $this->callbackHandler->clear($entityType);
            throw $e;
        }
        return true;
    }

has()

has

(

$entity

)

Parameters

object

$entity

Returns

bool

Exceptions

Definition at line 110 of file EntityManager.php.

    {
        $entityType = $this->typeResolver->resolve($entity);
        $operation = $this->operationPool->getOperation($entityType, 'checkIfExists');
        if (!($operation instanceof CheckIfExistsInterface)) {
            throw new \LogicException(get_class($operation) . ' must implement ' . CheckIfExistsInterface::class);
        }
        return $operation->execute($entity);
    }

load()

load	(		$entity,
			$identifier,
			$arguments = []
	)

Parameters

object	$entity
string	$identifier
array	$arguments

Returns

mixed

Exceptions

Definition at line 63 of file EntityManager.php.

    {
        $entityType = $this->typeResolver->resolve($entity);
        $operation = $this->operationPool->getOperation($entityType, 'read');
        if (!($operation instanceof ReadInterface)) {
            throw new \LogicException(get_class($operation) . ' must implement ' . ReadInterface::class);
        }
        $entity = $operation->execute($entity, $identifier, $arguments);
        return $entity;
    }

save()

save	(		$entity,
			$arguments = []
	)

Parameters

object	$entity
array	$arguments

Returns

object

Exceptions

Definition at line 81 of file EntityManager.php.

    {
        $entityType = $this->typeResolver->resolve($entity);
        if ($this->has($entity)) {
            $operation = $this->operationPool->getOperation($entityType, 'update');
            if (!($operation instanceof UpdateInterface)) {
                throw new \LogicException(get_class($operation) . ' must implement ' . UpdateInterface::class);
            }
        } else {
            $operation = $this->operationPool->getOperation($entityType, 'create');
            if (!($operation instanceof CreateInterface)) {
                throw new \LogicException(get_class($operation) . ' must implement ' . CreateInterface::class);
            }
        }
        try {
            $entity = $operation->execute($entity, $arguments);
            $this->callbackHandler->process($entityType);
        } catch (\Exception $e) {
            $this->callbackHandler->clear($entityType);
            throw $e;
        }
        return $entity;
    }

---

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

• vendor/magento/framework/EntityManager/EntityManager.php