Oc\User\UserRepository

Complexity

Total Complexity

18

Size/Duplication

Total Lines	247
Duplicated Lines	24.29 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	fetchOneById()	0	6	1
B	fetchOneBy()	24	24	4
A	create()	0	17	2
A	update()	18	18	2
A	remove()	18	18	2
A	getEntityArrayFromDatabaseArray()	0	10	2
A	getDatabaseArrayFromEntity()	0	16	1
A	getEntityFromDatabaseArray()	0	17	1
A	fetchAll()	0	15	2

<?php

namespace Oc\User;

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 UserRepository
 *
 * @package Oc\User

Unexpected tag type @package in doc block

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

    /**
     * @var Connection

Connection => \Doctrine\DBAL\Connection

     */
    private $connection;

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

Connection => \Doctrine\DBAL\Connection

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

    /**
     * Fetches all users.
     *
     * @return UserEntity[]

UserEntity[] => \Array\UserEntity[]

     *
     * @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()
    {
        $statement = $this->connection->createQueryBuilder()
            ->select('*')
            ->from(self::TABLE)
            ->execute();

        $result = $statement->fetchAll();

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

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

    /**
     * Fetches a user by its id.
     *
     * @param int $id
     *
     * @return UserEntity

UserEntity => \Array\UserEntity

     *
     * @throws RecordNotFoundException Thrown when the request record is not found

RecordNotFoundException => \Oc\Repository\Exception\RecordNotFoundException

@throws tag comment must end with a full stop

     */
    public function fetchOneById($id)
    {
        return $this->fetchOneBy([
            'user_id' => $id
        ]);
    }

    /**
     * Fetches a user by given where array.
     *
     * @param array $where
     *
     * @return UserEntity|null

UserEntity => \Array\UserEntity

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

    /**
     * Creates a user in the database.
     *
     * @param UserEntity $entity

UserEntity => \Array\UserEntity

     *
     * @return UserEntity

UserEntity => \Array\UserEntity

     *
     * @throws RecordAlreadyExistsException

RecordAlreadyExistsException => \Oc\Repository\Exception\RecordAlreadyExistsException

     */
    public function create(UserEntity $entity)
    {
        if (!$entity->isNew()) {
            throw new RecordAlreadyExistsException('The user entity already exists');
        }

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

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

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

No whitespace should be between cast and variable.

        return $entity;
    }

    /**
     * Update a user in the database.
     *
     * @param UserEntity $entity

UserEntity => \Array\UserEntity

     *
     * @return UserEntity

UserEntity => \Array\UserEntity

     *
     * @throws RecordNotPersistedException

RecordNotPersistedException => \Oc\Repository\Exception\RecordNotPersistedException

     */
    public function update(UserEntity $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,
            ['user_id' => $entity->id]
        );

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

No whitespace should be between cast and variable.

        return $entity;
    }

    /**
     * Removes a user from the database.
     *
     * @param UserEntity $entity

UserEntity => \Array\UserEntity

     *
     * @return UserEntity

UserEntity => \Array\UserEntity

     *
     * @throws RecordNotPersistedException

RecordNotPersistedException => \Oc\Repository\Exception\RecordNotPersistedException

     */
    public function remove(UserEntity $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->delete(
            self::TABLE,
            $databaseArray,
            ['user_id' => $entity->id]
        );

        $entity->id = null;

        return $entity;
    }

    /**
     * Converts database array to entity array.
     *
     * @param array $result
     *
     * @return UserEntity[]

UserEntity[] => \Array\UserEntity[]

     */
    private function getEntityArrayFromDatabaseArray(array $result)
    {
        $languages = [];

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

        return $languages;
    }

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

UserEntity => \Array\UserEntity

     *
     * @return array
     */
    public function getDatabaseArrayFromEntity(UserEntity $entity)
    {
        return [
            'user_id' => $entity->id,
            'username' => $entity->username,
            'password' => $entity->password,
            'email' => $entity->email,
            'latitude' => $entity->latitude,
            'longitude' => $entity->longitude,
            'is_active_flag' => $entity->isActive,
            'first_name' => $entity->firstname,
            'last_name' => $entity->lastname,
            'country' => $entity->country,
            'language' => $entity->language,
        ];
    }

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

UserEntity => \Array\UserEntity

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

No whitespace should be between cast and variable.

        $entity->username = (string) $data['username'];

No whitespace should be between cast and variable.

        $entity->password = (string) $data['password'];

No whitespace should be between cast and variable.

        $entity->email = (string) $data['email'];

No whitespace should be between cast and variable.

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

No whitespace should be between cast and variable.

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

No whitespace should be between cast and variable.

        $entity->isActive = (bool) $data['is_active_flag'];

No whitespace should be between cast and variable.

        $entity->firstname = (string) $data['first_name'];

No whitespace should be between cast and variable.

        $entity->lastname = (string) $data['last_name'];

No whitespace should be between cast and variable.

        $entity->country = (string) $data['country'];

No whitespace should be between cast and variable.

        $entity->language = strtolower($data['language']);

        return $entity;
    }
}