Oc\FieldNotes\Persistence\FieldNoteRepository

Complexity

Total Complexity

23

Size/Duplication

Total Lines	284
Duplicated Lines	33.8 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	fetchAll()	21	21	3
B	fetchBy()	0	30	5
B	fetchOneBy()	23	23	4
A	getLatestUserFieldNote()	20	20	2
A	create()	17	17	2
A	update()	0	18	2
A	remove()	15	15	2
A	getDatabaseArrayFromEntity()	0	11	1
A	getEntityFromDatabaseArray()	0	15	1

<?php

namespace Oc\FieldNotes\Persistence;

use DateTime;
use Doctrine\DBAL\Connection;
use Oc\GeoCache\Persistence\GeoCache\GeoCacheRepository;
use Oc\Repository\Exception\RecordAlreadyExistsException;
use Oc\Repository\Exception\RecordNotFoundException;
use Oc\Repository\Exception\RecordNotPersistedException;
use Oc\Repository\Exception\RecordsNotFoundException;

/**
 * Class FieldNoteRepository
 *
 * @package Oc\FieldNotes\Persistence

Unexpected tag type @package in doc block

 */
class FieldNoteRepository
{
    /**
     * Database table name that this repository maintains.
     *
     * @var string
     */
    const TABLE = 'field_note';

    /**
     * @var Connection

Connection => \Doctrine\DBAL\Connection

     */
    private $connection;
    /**
     * @var GeoCacheRepository

GeoCacheRepository => \Oc\GeoCache\Persistence\GeoCache\GeoCacheRepository

     */
    private $geoCacheRepository;

Expected 1 blank line before member var with comment; 0 found

    /**
     * FieldNoteRepository constructor.
     *
     * @param Connection $connection

Connection => \Doctrine\DBAL\Connection

     * @param GeoCacheRepository $geoCacheRepository

GeoCacheRepository => \Oc\GeoCache\Persistence\GeoCache\GeoCacheRepository

     */
    public function __construct(Connection $connection, GeoCacheRepository $geoCacheRepository)
    {
        $this->connection = $connection;
        $this->geoCacheRepository = $geoCacheRepository;
    }

    /**
     * Fetches all countries.
     *
     * @return FieldNoteEntity[]

FieldNoteEntity[] => \Array\FieldNoteEntity[]

     *
     * @throws RecordsNotFoundException Thrown when no records are found

RecordsNotFoundException => \Oc\Repository\Exception\RecordsNotFoundException

@throws tag comment must end with a full stop

     */
    public function fetchAll()

This method seems to be duplicated in your project.

    {
        $statement = $this->connection->createQueryBuilder()
            ->select('*')
            ->from(self::TABLE)
            ->execute();

        $result = $statement->fetchAll();

        if ($statement->rowCount() === 0) {
            throw new RecordsNotFoundException('No records found');
        }

        $entities = [];

        foreach ($result as $item) {
            $entities[] = $this->getEntityFromDatabaseArray($item);
        }

        return $entities;
    }

    /**

Doc comment for parameter "$order" missing

     * Fetches all GeoCaches by given where clause.
     *
     * @param array $where
     *
     * @return FieldNoteEntity[]

FieldNoteEntity[] => \Array\FieldNoteEntity[]

     *
     * @throws RecordsNotFoundException Thrown when no records are found

RecordsNotFoundException => \Oc\Repository\Exception\RecordsNotFoundException

@throws tag comment must end with a full stop

     */
    public function fetchBy(array $where = [], array $order = [])

Doc Block params do not match method signature

    {
        $queryBuilder = $this->connection->createQueryBuilder()
            ->select('*')
            ->from(self::TABLE);

        foreach ($where as $column => $value) {
            $queryBuilder->andWhere($column . ' = ' .  $queryBuilder->createNamedParameter($value));

Expected 1 space after ., but 2 found

        }

        foreach ($order as $field => $direction) {
            $queryBuilder->addOrderBy($field, $direction);
        }

        $statement = $queryBuilder->execute();

        $result = $statement->fetchAll();

        if ($statement->rowCount() === 0) {
            throw new RecordsNotFoundException('No records with given where clause found');
        }

        $entities = [];

        foreach ($result as $item) {
            $entities[] = $this->getEntityFromDatabaseArray($item);
        }

        return $entities;
    }

    /**
     * Fetches a field note by given where clause.
     *
     * @param array $where
     *
     * @return null|FieldNoteEntity

FieldNoteEntity => \Array\FieldNoteEntity

     *
     * @throws RecordNotFoundException Thrown when no record is found

RecordNotFoundException => \Oc\Repository\Exception\RecordNotFoundException

@throws tag comment must end with a full stop

     */
    public function fetchOneBy(array $where = [])

This method seems to be duplicated in your project.

    {
        $queryBuilder = $this->connection->createQueryBuilder()
            ->select('*')
            ->from(self::TABLE)
            ->setMaxResults(1);

        if (count($where) > 0) {
            foreach ($where as $column => $value) {
                $queryBuilder->andWhere($column . ' = ' .  $queryBuilder->createNamedParameter($value));

Expected 1 space after ., but 2 found

            }
        }

        $statement = $queryBuilder->execute();

        $result = $statement->fetch();

        if ($statement->rowCount() === 0) {
            throw new RecordNotFoundException('Record with given where clause not found');
        }

        return $this->getEntityFromDatabaseArray($result);
    }

    /**
     * Fetch latest user field note.
     *
     * @param int $userId
     *
     * @return FieldNoteEntity

FieldNoteEntity => \Array\FieldNoteEntity

     *
     * @throws RecordNotFoundException

RecordNotFoundException => \Oc\Repository\Exception\RecordNotFoundException

     */
    public function getLatestUserFieldNote($userId)

This method seems to be duplicated in your project.

    {
        $queryBuilder = $this->connection->createQueryBuilder()
            ->select('*')
            ->from(self::TABLE)
            ->where('user_id = :userId')
            ->orderBy('date', 'DESC')
            ->setParameter('userId', $userId)
            ->setMaxResults(1);

        $statement = $queryBuilder->execute();

        $result = $statement->fetch();

        if ($statement->rowCount() === 0) {
            throw new RecordNotFoundException('Record with given where clause not found');
        }

        return $this->getEntityFromDatabaseArray($result);
    }

    /**
     * Creates a field note in the database.
     *
     * @param FieldNoteEntity $entity

FieldNoteEntity => \Array\FieldNoteEntity

     *
     * @return FieldNoteEntity

FieldNoteEntity => \Array\FieldNoteEntity

     *
     * @throws RecordAlreadyExistsException

RecordAlreadyExistsException => \Oc\Repository\Exception\RecordAlreadyExistsException

     */
    public function create(FieldNoteEntity $entity)

This method seems to be duplicated in your project.

    {
        if (!$entity->isNew()) {
            throw new RecordAlreadyExistsException('The entity does already exist.');
        }

        $databaseArray = $this->getDatabaseArrayFromEntity($entity);

        $this->connection->insert(
            self::TABLE,
            $databaseArray
        );

        $entity->id = $this->connection->lastInsertId();

The property $id was declared of type integer, but $this->connection->lastInsertId() is of type string. Maybe add a type cast?

        return $entity;
    }

    /**
     * Update a field note in the database.
     *
     * @param FieldNoteEntity $entity

FieldNoteEntity => \Array\FieldNoteEntity

     *
     * @return FieldNoteEntity

FieldNoteEntity => \Array\FieldNoteEntity

     *
     * @throws RecordNotPersistedException

RecordNotPersistedException => \Oc\Repository\Exception\RecordNotPersistedException

     */
    public function update(FieldNoteEntity $entity)
    {
        if ($entity->isNew()) {
            throw new RecordNotPersistedException('The entity does not exist.');
        }

        $databaseArray = $this->getDatabaseArrayFromEntity($entity);

        $this->connection->update(
            self::TABLE,
            $databaseArray,
            ['id' => $entity->id]
        );

        $entity->id = $this->connection->lastInsertId();

The property $id was declared of type integer, but $this->connection->lastInsertId() is of type string. Maybe add a type cast?

        return $entity;
    }

    /**
     * Removes a field note from the database.
     *
     * @param FieldNoteEntity $entity

FieldNoteEntity => \Array\FieldNoteEntity

     *
     * @return FieldNoteEntity

FieldNoteEntity => \Array\FieldNoteEntity

     *
     * @throws RecordNotPersistedException

RecordNotPersistedException => \Oc\Repository\Exception\RecordNotPersistedException

     */
    public function remove(FieldNoteEntity $entity)

This method seems to be duplicated in your project.

    {
        if ($entity->isNew()) {
            throw new RecordNotPersistedException('The entity does not exist.');
        }

        $this->connection->delete(
            self::TABLE,
            ['id' => $entity->id]
        );

        $entity->id = null;

        return $entity;
    }

    /**
     * Maps the given entity to the database array.
     *
     * @param FieldNoteEntity $entity

FieldNoteEntity => \Array\FieldNoteEntity

     *
     * @return array
     */
    public function getDatabaseArrayFromEntity(FieldNoteEntity $entity)
    {
        return [
            'id' => $entity->id,
            'user_id' => $entity->userId,
            'geocache_id' => $entity->geocacheId,
            'type' => $entity->type,
            'date' => $entity->date->format(DateTime::ATOM),
            'text' => $entity->text
        ];
    }

    /**
     * Prepares database array from properties.
     *
     * @param array $data
     *
     * @return FieldNoteEntity

FieldNoteEntity => \Array\FieldNoteEntity

     */
    public function getEntityFromDatabaseArray(array $data)
    {
        $entity = new FieldNoteEntity();
        $entity->id = (string) $data['id'];

No whitespace should be between cast and variable.

The property $id was declared of type integer, but (string) $data['id'] is of type string. Maybe add a type cast?

        $entity->userId = $data['user_id'];
        $entity->geocacheId = $data['geocache_id'];
        $entity->type = $data['type'];
        $entity->date = new DateTime($data['date']);
        $entity->text = $data['text'];
        $entity->geoCache = $this->geoCacheRepository->fetchOneBy([
            'cache_id' => $entity->geocacheId
        ]);

        return $entity;
    }
}