steevanb\EntityUtils\Repository\GetTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
	find()	0	1	?
	findOneBy()	0	1	?
	getClassMetadata()	0	1	?
A	assertIsEntity()	0	13	4
A	get()	0	7	1
A	getOneBy()	0	7	1

<?php

namespace steevanb\EntityUtils\Repository;

use Doctrine\ORM\EntityNotFoundException;
use Doctrine\ORM\Mapping\ClassMetadata;

trait GetTrait
{
    /**
     * @param mixed $id
     * @param int|null $lockMode
     * @param int|null $lockVersion
     * @return object
     */
    abstract public function find($id, $lockMode = null, $lockVersion = null);

    /**
     * @param array $criteria
     * @param array|null $orderBy
     * @return object
     */
    abstract public function findOneBy(array $criteria, array $orderBy = null);

    /**
     * @return ClassMetadata
     */
    abstract protected function getClassMetadata();

    /**
     * @param mixed $entity
     * @param array $criteria
     * @throws EntityNotFoundException
     */
    protected function assertIsEntity($entity, array $criteria)
    {
        if ($entity instanceof \stdClass === false) {
            $message = 'Entity of type "' . $this->getClassMetadata()->getName() . '"';
            $criteriaForMessage = [];
            foreach ($criteria as $name => $value) {
                $criteriaForMessage[] = $name . ' = ' . $value;
            }
            $message .= ' was not found with ' . (count($criteriaForMessage) > 1 ? ' criteria' : 'criterion');
            $message .= ' : ' . implode(', ', $criteriaForMessage);
            throw new EntityNotFoundException($message);
        }
    }

    /**
     * @param mixed $id
     * @param int|null $lockMode
     * @param int|null $lockVersion
     * @return object
     * @throws EntityNotFoundException
     */
    public function get($id, $lockMode = null, $lockVersion = null)
    {
        $entity = $this->find($id, $lockMode, $lockVersion);
        $this->assertIsEntity($entity, array('id' => $id));

        return $entity;
    }

    /**
     * @param array $criteria
     * @param array|null $orderBy
     * @return object
     * @throws EntityNotFoundException
     */
    public function getOneBy(array $criteria, array $orderBy = null)
    {
        $entity = $this->findOneBy($criteria, $orderBy);
        $this->assertIsEntity($entity, $criteria);

        return $entity;
    }
}