Oc\GeoCache\Persistence\GeoCache\GeoCacheRepository

Complexity

Total Complexity

24

Size/Duplication

Total Lines	334
Duplicated Lines	31.44 %

Coupling/Cohesion

Components	1
Dependencies	8

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	fetchGCWaypoint()	0	23	3
A	create()	0	17	2
A	update()	18	18	2
A	remove()	15	15	2
B	getDatabaseArrayFromEntity()	0	40	1
B	getEntityFromDatabaseArray()	0	41	1

<?php

namespace Oc\GeoCache\Persistence\GeoCache;

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

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

    /**
     * @var Connection

Connection => \Doctrine\DBAL\Connection

     */
    private $connection;

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

Connection => \Doctrine\DBAL\Connection

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

    /**
     * Fetches all GeoCaches.
     *
     * @return GeoCacheEntity[]

GeoCacheEntity[] => \Array\GeoCacheEntity[]

     *
     * @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 GeoCache by given where clause.
     *
     * @param array $where
     *
     * @return null|GeoCacheEntity

GeoCacheEntity => \Array\GeoCacheEntity

     *
     * @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 GeoCaches by given where clause.
     *
     * @param array $where
     *
     * @return GeoCacheEntity[]

GeoCacheEntity[] => \Array\GeoCacheEntity[]

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

    /**
     * Fetches a GeoCache by given where clause.
     *
     * @param string $waypoint
     *
     * @return null|GeoCacheEntity

GeoCacheEntity => \Array\GeoCacheEntity

     *
     * @throws RecordNotFoundException Thrown when no record is found

RecordNotFoundException => \Oc\Repository\Exception\RecordNotFoundException

@throws tag comment must end with a full stop

     */
    public function fetchGCWaypoint($waypoint)
    {
        if (WaypointType::guess($waypoint) !== WaypointType::GC) {
            throw new RecordNotFoundException('Record by given gc waypoint not found');
        }

        $queryBuilder = $this->connection->createQueryBuilder()
            ->select('*')
            ->from(self::TABLE)
            ->where("IFELSE(wp_gc_maintained = '', wp_gc, g.wp_gc_maintained) = :waypoint")
            ->setParameter(':waypoint', $waypoint)
            ->setMaxResults(1);

        $statement = $queryBuilder->execute();

        $result = $statement->fetch();

        if ($statement->rowCount() === 0) {
            throw new RecordNotFoundException('Record by given gc waypoint not found');
        }

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

    /**
     * Creates a GeoCache in the database.
     *
     * @param GeoCacheEntity $entity

GeoCacheEntity => \Array\GeoCacheEntity

     *
     * @return GeoCacheEntity

GeoCacheEntity => \Array\GeoCacheEntity

     *
     * @throws RecordAlreadyExistsException

RecordAlreadyExistsException => \Oc\Repository\Exception\RecordAlreadyExistsException

     */
    public function create(GeoCacheEntity $entity)
    {
        if (!$entity->isNew()) {
            throw new RecordAlreadyExistsException('The entity does already exist.');
        }

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

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

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

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

        return $entity;
    }

    /**
     * Update a GeoCache in the database.
     *
     * @param GeoCacheEntity $entity

GeoCacheEntity => \Array\GeoCacheEntity

     *
     * @return GeoCacheEntity

GeoCacheEntity => \Array\GeoCacheEntity

     *
     * @throws RecordNotPersistedException

RecordNotPersistedException => \Oc\Repository\Exception\RecordNotPersistedException

     */
    public function update(GeoCacheEntity $entity)

This method seems to be duplicated in your project.

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

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

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

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

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

        return $entity;
    }

    /**
     * Removes a GeoCache from the database.
     *
     * @param GeoCacheEntity $entity

GeoCacheEntity => \Array\GeoCacheEntity

     *
     * @return GeoCacheEntity

GeoCacheEntity => \Array\GeoCacheEntity

     *
     * @throws RecordNotPersistedException

RecordNotPersistedException => \Oc\Repository\Exception\RecordNotPersistedException

     */
    public function remove(GeoCacheEntity $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,
            ['cache_id' => $entity->cacheId]
        );

        $entity->cacheId = null;

        return $entity;
    }

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

GeoCacheEntity => \Array\GeoCacheEntity

     *
     * @return array
     */
    public function getDatabaseArrayFromEntity(GeoCacheEntity $entity)
    {
        return [
            'cache_id' => $entity->cacheId,
            'uuid' => $entity->uuid,
            'node' => $entity->node,
            'date_created' => $entity->dateCreated->format(DateTime::ATOM),
            'is_publishdate' => $entity->isPublishdate,
            'last_modified' => $entity->lastModified->format(DateTime::ATOM),
            'okapi_syncbase' => $entity->okapiSyncbase,
            'listing_last_modified' => $entity->listingLastModified->format(DateTime::ATOM),
            'meta_last_modified' => $entity->metaLastModified->format(DateTime::ATOM),
            'user_id' => $entity->userId,
            'name' => $entity->name,
            'longitude' => $entity->longitude,
            'latitude' => $entity->latitude,
            'type' => $entity->type,
            'status' => $entity->status,
            'country' => $entity->country,
            'date_hidden' => $entity->dateHidden->format(DateTime::ATOM),
            'size' => $entity->size,
            'difficulty' => $entity->difficulty,
            'terrain' => $entity->terrain,
            'logpw' => $entity->logpw,
            'search_time' => $entity->searchTime,
            'way_length' => $entity->wayLength,
            'wp_gc' => $entity->wpGc,
            'wp_gc_maintained' => $entity->wpGcMaintained,
            'wp_oc' => $entity->wpOc,
            'desc_languages' => $entity->descLanguages,
            'default_desclang' => $entity->defaultDesclang,
            'date_activate' => $entity->dateActivate->format(DateTime::ATOM),
            'need_npa_recalc' => $entity->needNpaRecalc,
            'show_cachelists' => $entity->showCachelists,
            'protect_old_coords' => $entity->protectOldCoords,
            'needs_maintenance' => $entity->needsMaintenance,
            'listing_outdated' => $entity->listingOutdated,
            'flags_last_modified' => $entity->flagsLastModified->format(DateTime::ATOM)
        ];
    }

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

GeoCacheEntity => \Array\GeoCacheEntity

     */
    public function getEntityFromDatabaseArray(array $data)
    {
        $entity = new GeoCacheEntity();
        $entity->cacheId = $data['cache_id'];
        $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->isPublishdate = (bool) $data['is_publishdate'];

No whitespace should be between cast and variable.

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

No whitespace should be between cast and variable.

        $entity->listingLastModified = new DateTime($data['listing_last_modified']);
        $entity->metaLastModified = new DateTime($data['meta_last_modified']);
        $entity->userId = (int) $data['user_id'];

No whitespace should be between cast and variable.

        $entity->name = $data['name'];
        $entity->longitude = (double) $data['longitude'];

No whitespace should be between cast and variable.

        $entity->latitude = (double) $data['latitude'];

No whitespace should be between cast and variable.

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

No whitespace should be between cast and variable.

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

No whitespace should be between cast and variable.

        $entity->country = $data['country'];
        $entity->dateHidden = new DateTime($data['date_hidden']);
        $entity->size = (int) $data['size'];

No whitespace should be between cast and variable.

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

No whitespace should be between cast and variable.

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

No whitespace should be between cast and variable.

        $entity->logpw = $data['logpw'];
        $entity->searchTime = (float) $data['search_time'];

No whitespace should be between cast and variable.

        $entity->wayLength = (float) $data['way_length'];

No whitespace should be between cast and variable.

        $entity->wpGc = $data['wp_gc'];
        $entity->wpGcMaintained = $data['wp_gc_maintained'];
        $entity->wpOc = $data['wp_oc'];
        $entity->descLanguages = $data['desc_languages'];
        $entity->defaultDesclang = $data['default_desclang'];
        $entity->dateActivate = new DateTime($data['date_activate']);
        $entity->needNpaRecalc = (bool) $data['need_npa_recalc'];

No whitespace should be between cast and variable.

The property $needNpaRecalc was declared of type integer, but (bool) $data['need_npa_recalc'] is of type boolean. Maybe add a type cast?

        $entity->showCachelists = (bool) $data['show_cachelists'];

No whitespace should be between cast and variable.

The property $showCachelists was declared of type integer, but (bool) $data['show_cachelists'] is of type boolean. Maybe add a type cast?

        $entity->protectOldCoords = (bool) $data['protect_old_coords'];

No whitespace should be between cast and variable.

The property $protectOldCoords was declared of type integer, but (bool) $data['protect_old_coords'] is of type boolean. Maybe add a type cast?

        $entity->needsMaintenance = (bool) $data['needs_maintenance'];

No whitespace should be between cast and variable.

The property $needsMaintenance was declared of type integer, but (bool) $data['needs_maintenance'] is of type boolean. Maybe add a type cast?

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

No whitespace should be between cast and variable.

The property $listingOutdated was declared of type integer, but (bool) $data['listing_outdated'] is of type boolean. Maybe add a type cast?

        $entity->flagsLastModified = new DateTime($data['flags_last_modified']);

        return $entity;
    }
}