Mapper::equals() - Code Metrics - darya/framework - Measure and Improve Code Quality continuously with Scrutinizer

Mapper::equals() A
last analyzed 2021-02-13 01:04 UTC

↳ Parent: Mapper
Complexity

Conditions	3
Paths	3
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	3
eloc	2
c	1
b	0
f	0
nc	3
nop	1
dl	0
loc	4
rs	10
<?php

namespace Darya\ORM;

use Darya\ORM\Exception\EntityNotFoundException;
use Darya\Storage;
use ReflectionClass;
use ReflectionException;
use UnexpectedValueException;

/**
 * Darya's entity mapper.
 *
 * Maps a single type of entity to a queryable storage interface.
 *
 * TODO: Entity factory for instantiation; this could allow dynamically defined entities
 * TODO: Entity caching
 * TODO: Map to array, for lighter data mapping that avoids any instantiation
 * TODO: Consider other types of storage, e.g. a cache, which may only find by ID
 * TODO: Composite key support
 *
 * @author Chris Andrew <[email protected]>
 */
class Mapper
{
	/**
	 * The entity manager.
	 *
	 * @var EntityManager
	 */
	private $orm;

	/**
	 * The EntityMap to map to storage.
	 *
	 * @var EntityMap
	 */
	protected $entityMap;

	/**
	 * The storage to map to.
	 *
	 * @var Storage\Queryable
	 */
	protected $storage;

	/**
	 * Create a new mapper.
	 *
	 * @param EntityManager     $orm       The entity manager.
	 * @param EntityMap         $entityMap The entity map to use.
	 * @param Storage\Queryable $storage   The storage to map to.
	 */
	public function __construct(EntityManager $orm, EntityMap $entityMap, Storage\Queryable $storage)
	{
		$this->orm       = $orm;
		$this->entityMap = $entityMap;
		$this->storage   = $storage;
	}

	/**
	 * Check whether a single entity exists with the given ID.
	 *
	 * @param mixed $id The ID of the entity to check.
	 * @return bool
	 */
	public function has($id): bool
	{
		if ($id === null) {
			return false;
		}

		$entityMap  = $this->getEntityMap();
		$resource   = $entityMap->getResource();
		$storageKey = $entityMap->getStorageKey();

		$result = $this->storage->query($resource)
			->fields([$storageKey])
			->/** @scrutinizer ignore-call */ fields([$storageKey])
			->where($storageKey, $id)
			->/** @scrutinizer ignore-call */ where($storageKey, $id)
			->limit(1)
			->/** @scrutinizer ignore-call */ limit(1)
			->run();
			->/** @scrutinizer ignore-call */ run();

		return $result->count > 0;
	}

	/**
	 * Find a single entity with the given ID.
	 *
	 * Returns null if the entity is not found.
	 *
	 * @param mixed $id The ID of the entity to find.
	 * @return object|null The entity, or null if it is not found.
	 */
	public function find($id)
	{
		$storageKey = $this->getEntityMap()->getStorageKey();

		$entities = $this->query()
			->where($storageKey, $id)
			->/** @scrutinizer ignore-call */ where($storageKey, $id)
			->run();

		if (!count($entities)) {
		if (!count(/** @scrutinizer ignore-type */ $entities)) {
			return null;
		}

		return $entities[0];
	}

	/**
	 * Find a single entity with the given ID or error if it is not found.
	 *
	 * Throws an EntityNotFoundException if the entity is not found.
	 *
	 * @param mixed $id The ID of the entity to find.
	 * @return object The entity.
	 * @throws EntityNotFoundException When the entity is not found.
	 */
	public function findOrFail($id)
	{
		$entity = $this->find($id);

		if ($entity !== null) {
			return $entity;
		}

		$name = $this->getEntityMap()->getName();

		throw (new EntityNotFoundException())->setEntityName($name);
	}

	/**
	 * Find a single entity with the given ID or create a new one if it not found.
	 *
	 * @param mixed $id The ID of the entity to find.
	 * @return object The entity.
	 */
	public function findOrNew($id)
	{
		return $this->find($id) ?: $this->newInstance();
	}

	/**
	 * Find the entities with the given IDs.
	 *
	 * @param mixed[] $ids The IDs of the entities to find.
	 * @return object[]
	 */
	public function findMany(array $ids): array
	{
		$storageKey = $this->getEntityMap()->getStorageKey();

		return $this->query()

			->where($storageKey, $ids)
			->run();
	}

	/**
	 * Find all entities.
	 *
	 * @return object[]
	 */
	public function all(): array
	{
		return $this->query()->run();

	}

	/**
	 * Open a query to the storage that the entity is mapped to.
	 *
	 * @return Query\Builder
	 */
	public function query(): Query\Builder
	{
		$query = new Query\Builder(
			new Query($this),
			$this->orm
		);

		return $query;
	}

	/**
	 * Run a query.
	 *
	 * @param Query $query
	 * @return array TODO: Return a Storage\Result?
	 */
	public function run(Query $query): array
	{
		if ($this->equals($query->mapper)) {
			throw new UnexpectedValueException("Unexpected query mapper for entity '{$query->mapper->getEntityMap()->getName()}'");
		}

		// Load entities with relationship existence check
		$result   = $this->loadWhereHas($query);
		$entities = $this->newInstances($result->data);

		// Load related entities
		$this->loadWith($entities, $query);

		return $entities;
	}

	/**
	 * Load entities that match the query's relationship existence constraints.
	 *
	 * @param Query $query
	 * @return Storage\Result
	 */
	protected function loadWhereHas(Query $query): Storage\Result
	{
		// Load root entity IDs
		$storage    = $this->getStorage();
		$entityMap  = $this->getEntityMap();
		$resource   = $entityMap->getResource();
		$storageKey = $entityMap->getStorageKey();

		$result = $storage->query($resource)
			->copyFrom($query)
			->/** @scrutinizer ignore-call */ copyFrom($query)
			->fields($storageKey)
			->/** @scrutinizer ignore-call */ fields($storageKey)
			->run();

		$ids = array_column($result->data, $storageKey);

		// TODO: Check related entity existence ($query->has) to filter down IDs
		//       OR use a subquery in the below query (when count() is a thing)
		//          and when the storage for parent and related are the same

		// Filter down to entities matching the relationship existence check
		$query->where($storageKey, $ids);

		return $storage->run($query);
	}

	/**
	 * Eagerly-load relationships for, and match them to, the given entities.
	 *
	 * @param object[] $entities The entities to load relationships for.
	 * @param Query    $query    The query with the relationships to load.
	 * @return object[] The entities with the given relationships loaded.
	 */
	protected function loadWith(array $entities, Query $query): array
	{
		$graph         = $this->orm->graph();
		$entityName    = $this->getEntityMap()->getName();
		$relationships = $graph->getRelationships($entityName, $query->with);

		foreach ($relationships as $relationship) {
			$relationship      = $relationship->forParents($entities);
			$relatedEntityName = $relationship->getRelatedMap()->getName();

			$relatedMapper     = $this->orm->mapper($relatedEntityName);
			$relationshipQuery = $this->orm->prepareQuery($relationship);

			$relationship->match($entities, $relatedMapper->run($relationshipQuery));
		}

		return $entities;
	}

	/**
	 * Store an entity to its mapped storage.
	 *
	 * Creates or updates the entity in storage depending on whether it exists.
	 *
	 * If storage returns a key after a create query, it will be set on the entity
	 *
	 * TODO: Store relationships that aren't mapped to the same storage as the root entity.
	 * TODO: Implement storeMany($entities), or accept many in this $entity parameter
	 *
	 * @param object $entity
	 * @return object The mapped entity
	 */
	public function store($entity)
	{
		$entityMap   = $this->getEntityMap();
		$resource    = $entityMap->getResource();
		$storageKey  = $entityMap->getStorageKey();
		$storageData = $this->mapToStorage($entity);

		// Determine whether the entity exists in storage
		$id     = $storageData[$storageKey] ?? null;
		$exists = $this->has($id);

		// Update or create in storage accordingly
		$query = $this->storage->query($resource);

		if ($exists) {
			$query->update($storageData)
           update($storageData)
				->where($storageKey, $id)
				->run();

			return $entity;
		}

		$result = $query->create($storageData)->run();
		$result = $query->/** @scrutinizer ignore-call */ create($storageData)->run();

		// Set the insert ID as the entity's key, if one is returned
		if ($result->insertId) {
			$storageData              = $this->mapToStorage($entity);
			$storageData[$storageKey] = $result->insertId;
			$entity                   = $this->mapFromStorage($entity, $storageData);
		}

		return $entity;
	}

	/**
	 * Delete an entity from its mapped storage.
	 *
	 * @param object $entity
	 */
	public function delete($entity)
	{
		$entityMap   = $this->getEntityMap();
		$resource    = $entityMap->getResource();
		$storageKey  = $entityMap->getStorageKey();
		$storageData = $this->mapToStorage($entity);

		$this->storage->query($resource)
			->where($storageKey, $storageData[$storageKey])
			->delete();
			->/** @scrutinizer ignore-call */ delete();
	}

	/**
	 * Create a new instance of the mapper's entity.
	 *
	 * TODO: Factory work should happen here, via the entity map or otherwise
	 *
	 * @throws ReflectionException
	 * @return object
	 */
	public function newInstance()
	{
		$reflection = new ReflectionClass($this->getEntityMap()->getClass());

		return $reflection->newInstance();
	}

	/**
	 * Create new instances of the mapper's entity from the given storage data.
	 *
	 * @param array $storageData The storage data to create entities from.
	 * @return array The new entities.
	 */
	public function newInstances(array $storageData): array
	{
		$entities = [];

		foreach ($storageData as $entityDatum) {
			$entities[] = $this->mapFromStorage($this->newInstance(), $entityDatum);
		}

		return $entities;
	}

	/**
	 * Get the entity map.
	 *
	 * @return EntityMap
	 */
	public function getEntityMap(): EntityMap
	{
		return $this->entityMap;
	}

	/**
	 * Get the storage to map to.
	 *
	 * @return Storage\Queryable
	 */
	public function getStorage(): Storage\Queryable
	{
		return $this->storage;
	}

	/**
	 * Map from storage data to an entity.
	 *
	 * @param object $entity      The entity to map to.
	 * @param array  $storageData The storage data to map from.
	 * @return object The resulting entity.
	 */
	public function mapFromStorage($entity, array $storageData)
	{
		return $this->getEntityMap()->mapFromStorage($entity, $storageData);
	}

	/**
	 * Map from an entity to storage data.
	 *
	 * @param object $entity The entity to map from.
	 * @return array The resulting storage data.
	 */
	public function mapToStorage($entity): array
	{
		return $this->getEntityMap()->mapToStorage($entity);
	}

	/**
	 * Map an ORM query to a storage query.
	 *
	 * This method does not map relationship loading in any way.
	 *
	 * @param Query $query The ORM query to map.
	 * @return Storage\Query The mapped storage query.
	 */
	protected function mapToStorageQuery(Query $query): Storage\Query
	{
		$entityMap = $this->getEntityMap();
		$resource  = $entityMap->getResource();

		$storageQuery = new Storage\Query($resource);

		// TODO: Map all other identifiers in the query; fields, filters, etc

		$storageQuery->copyFrom($query);
		$storageQuery->resource($resource);

		return $storageQuery;
	}

	/**
	 * Compare a mapper with this mapper.
	 *
	 * Compares the equivalence of the entity maps and storages of the given
	 * mapper with this mapper.
	 *
	 * @param Mapper $mapper
	 * @return bool
	 */
	public function equals(Mapper $mapper)
	{
		return !($mapper->getEntityMap() === $this->getEntityMap()) ||
			   !($mapper->getStorage() === $this->getStorage() || $mapper->getStorage() === $this->orm);
	}
}

darya / framework

Mapper::equals() A last analyzed 2021-02-13 01:04 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Mapper::equals() A
last analyzed 2021-02-13 01:04 UTC
