Oc\GeoCache\Persistence\GeoCacheLog\GeoCacheLogRepository

Complexity

Total Complexity

23

Size/Duplication

Total Lines	303
Duplicated Lines	35.31 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

10 Methods

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

<?php

namespace Oc\GeoCache\Persistence\GeoCacheLog;

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

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

    /**
     * @var Connection

Connection => \Doctrine\DBAL\Connection

     */
    private $connection;

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

Connection => \Doctrine\DBAL\Connection

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

    /**
     * Fetches all GeoCacheLogs.
     *
     * @return GeoCacheLogEntity[]

GeoCacheLogEntity[] => \Array\GeoCacheLogEntity[]

     *
     * @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');
        }

        $records = [];

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

        return $records;
    }

    /**
     * Fetches a GeoCacheLog by given where clause.
     *
     * @param array $where
     *
     * @return null|GeoCacheLogEntity

GeoCacheLogEntity => \Array\GeoCacheLogEntity

     *
     * @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);
    }

    /**
     * Fetches all GeoCacheLogs by given where clause.
     *
     * @param array $where
     *
     * @return GeoCacheLogEntity[]

GeoCacheLogEntity[] => \Array\GeoCacheLogEntity[]

     *
     * @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 = [])

This method seems to be duplicated in your project.

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

        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->fetchAll();

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

        $geoCaches = [];

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

        return $geoCaches;
    }

    /**
     * Fetch latest user geo cache log.
     *
     * @param int $userId
     *
     * @return GeoCacheLogEntity

GeoCacheLogEntity => \Array\GeoCacheLogEntity

     *
     * @throws RecordNotFoundException

RecordNotFoundException => \Oc\Repository\Exception\RecordNotFoundException

     */
    public function getLatestUserLog($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 GeoCacheLog in the database.
     *
     * @param GeoCacheLogEntity $entity

GeoCacheLogEntity => \Array\GeoCacheLogEntity

     *
     * @return GeoCacheLogEntity

GeoCacheLogEntity => \Array\GeoCacheLogEntity

     *
     * @throws RecordAlreadyExistsException

RecordAlreadyExistsException => \Oc\Repository\Exception\RecordAlreadyExistsException

     */
    public function create(GeoCacheLogEntity $entity)
    {
        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 GeoCacheLog in the database.
     *
     * @param GeoCacheLogEntity $entity

GeoCacheLogEntity => \Array\GeoCacheLogEntity

     *
     * @return GeoCacheLogEntity

GeoCacheLogEntity => \Array\GeoCacheLogEntity

     *
     * @throws RecordNotPersistedException

RecordNotPersistedException => \Oc\Repository\Exception\RecordNotPersistedException

     */
    public function update(GeoCacheLogEntity $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 GeoCacheLog from the database.
     *
     * @param GeoCacheLogEntity $entity

GeoCacheLogEntity => \Array\GeoCacheLogEntity

     *
     * @return GeoCacheLogEntity

GeoCacheLogEntity => \Array\GeoCacheLogEntity

     *
     * @throws RecordNotPersistedException

RecordNotPersistedException => \Oc\Repository\Exception\RecordNotPersistedException

     */
    public function remove(GeoCacheLogEntity $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 GeoCacheLogEntity $entity

GeoCacheLogEntity => \Array\GeoCacheLogEntity

     *
     * @return array
     */
    public function getDatabaseArrayFromEntity(GeoCacheLogEntity $entity)
    {
        return [
            'id' => $entity->id,
            'uuid' => $entity->uuid,
            'node' => $entity->node,
            'date_created' => $entity->dateCreated->format(DateTime::ATOM),
            'entry_last_modified' => $entity->entryLastModified->format(DateTime::ATOM),
            'last_modified' => $entity->lastModified->format(DateTime::ATOM),
            'okapi_syncbase' => $entity->okapiSyncbase,
            'log_last_modified' => $entity->logLastModified->format(DateTime::ATOM),
            'cache_id' => $entity->cacheId,
            'user_id' => $entity->userId,
            'type' => $entity->type,
            'oc_team_comment' => $entity->ocTeamComment,
            'date' => $entity->date->format(DateTime::ATOM),
            'order_date' => $entity->orderDate->format(DateTime::ATOM),
            'needs_maintenance' => $entity->needsMaintenance,
            'listing_outdated' => $entity->listingOutdated,
            'text' => $entity->text,
            'text_html' => $entity->textHtml,
            'text_htmledit' => $entity->textHtmledit,
            'owner_notified' => $entity->ownerNotified,
            'picture' => $entity->picture
        ];
    }

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

GeoCacheLogEntity => \Array\GeoCacheLogEntity

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

No whitespace should be between cast and variable.

        $entity->uuid = $data['uuid'];
        $entity->node = (int) $data['node'];

No whitespace should be between cast and variable.

        $entity->dateCreated = new DateTime($data['date_created']);
        $entity->entryLastModified = new DateTime($data['entry_last_modified']);
        $entity->lastModified = new DateTime($data['last_modified']);
        $entity->okapiSyncbase = (int) $data['okapi_syncbase'];

No whitespace should be between cast and variable.

        $entity->logLastModified = new DateTime($data['log_last_modified']);
        $entity->cacheId = (int) $data['cache_id'];

No whitespace should be between cast and variable.

        $entity->userId = (int) $data['user_id'];

No whitespace should be between cast and variable.

        $entity->type = (int) $data['type'];

No whitespace should be between cast and variable.

        $entity->ocTeamComment = (bool) $data['oc_team_comment'];

No whitespace should be between cast and variable.

        $entity->date = new DateTime($data['date']);
        $entity->orderDate = new DateTime($data['order_date']);
        $entity->needsMaintenance = (bool) $data['needs_maintenance'];

No whitespace should be between cast and variable.

        $entity->listingOutdated = (bool) $data['listing_outdated'];

No whitespace should be between cast and variable.

        $entity->text = $data['text'];
        $entity->textHtml = (bool) $data['text_html'];

No whitespace should be between cast and variable.

        $entity->textHtmledit = (bool) $data['text_htmledit'];

No whitespace should be between cast and variable.

        $entity->ownerNotified = (bool) $data['owner_notified'];

No whitespace should be between cast and variable.

        $entity->picture = (int) $data['picture'];

No whitespace should be between cast and variable.

        return $entity;
    }
}