UserOptionsRepository::getEntityFromDatabaseArray() - Code Metrics - Inspection of "Feature/import gc logs" - OpencachingDeutschland/oc-server3 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — development (#720)

by Thomas

created 2018-08-10 14:22 UTC

getEntityFromDatabaseArray() A

↳ Parent: UserOptionsRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	10
Ratio	100 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	10
loc	10
rs	9.9332
c	0
b	0
f	0

<?php 

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 UserOptionsRepository
namespace YourVendor;

class YourClass { }
{
    const TABLE = 'user_options';

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

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

    /**
     * @return UserOptionsEntity[]
     */
    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');
        }

        $records = [];

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

        return $records;
    }

    /**
     * @param array $where
     * @return UserOptionsEntity
     */
    public function fetchOneBy(array $where = [])
    {
        $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));
            }
        }

        $statement = $queryBuilder->execute();

        $result = $statement->fetch();

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

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

    /**
     * @param array $where
     * @return UserOptionsEntity[]
     */
    public function fetchBy(array $where = [])
    {
        $queryBuilder = $this->connection->createQueryBuilder()
                     ->select('*')
                     ->from(self::TABLE);

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

        $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;
    }

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

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

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

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

        return $entity;
    }

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

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

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

        return $entity;
    }

    /**
     * @param UserOptionsEntity $entity
     * @return UserOptionsEntity
     */
    public function remove(UserOptionsEntity $entity)
    {
        if ($entity->isNew()) {
            throw new RecordNotPersistedException('The entity does not exist.');
        }

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

        $entity->cacheId = null;


        return $entity;
    }

    /**
     * @param UserOptionsEntity $entity
     * @return []

     */
    public function getDatabaseArrayFromEntity(UserOptionsEntity $entity)
    {
        return [
        'user_id' => $entity->userId,
        'option_id' => $entity->optionId,
        'option_visible' => $entity->optionVisible,
        'option_value' => $entity->optionValue,
        ];
    }

    /**
     * @param array $data
     * @return UserOptionsEntity
     */
    public function getEntityFromDatabaseArray(array $data)
    {
        $entity = new UserOptionsEntity();
        $entity->userId = $data['user_id'];
        $entity->optionId = $data['option_id'];
        $entity->optionVisible = $data['option_visible'];
        $entity->optionValue = $data['option_value'];

        return $entity;
    }
}


1		<?php
2
3		use Doctrine\DBAL\Connection;
4		use Oc\Repository\Exception\RecordAlreadyExistsException;
5		use Oc\Repository\Exception\RecordNotFoundException;
6		use Oc\Repository\Exception\RecordNotPersistedException;
7		use Oc\Repository\Exception\RecordsNotFoundException;
8
9	View Code Duplication	class UserOptionsRepository
		0 ignored issues – show Duplication introduced 2018-08-10 14:46 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history... Coding Style Compatibility introduced 2018-08-10 14:46 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
10		{
11		const TABLE = 'user_options';
12
13		/** @var Connection */
14		private $connection;
15
16		public function __construct(Connection $connection)
17		{
18		$this->connection = $connection;
19		}
20
21		/**
22		* @return UserOptionsEntity[]
23		*/
24		public function fetchAll()
25		{
26		$statement = $this->connection->createQueryBuilder()
27		->select('*')
28		->from(self::TABLE)
29		->execute();
30
31		$result = $statement->fetchAll();
32
33		if ($statement->rowCount() === 0) {
34		throw new RecordsNotFoundException('No records found');
35		}
36
37		$records = [];
38
39		foreach ($result as $item) {
40		$records[] = $this->getEntityFromDatabaseArray($item);
41		}
42
43		return $records;
44		}
45
46		/**
47		* @param array $where
48		* @return UserOptionsEntity
49		*/
50		public function fetchOneBy(array $where = [])
51		{
52		$queryBuilder = $this->connection->createQueryBuilder()
53		->select('*')
54		->from(self::TABLE)
55		->setMaxResults(1);
56
57		if (count($where) > 0) {
58		foreach ($where as $column => $value) {
59		$queryBuilder->andWhere($column . ' = ' . $queryBuilder->createNamedParameter($value));
60		}
61		}
62
63		$statement = $queryBuilder->execute();
64
65		$result = $statement->fetch();
66
67		if ($statement->rowCount() === 0) {
68		throw new RecordNotFoundException('Record with given where clause not found');
69		}
70
71		return $this->getEntityFromDatabaseArray($result);
72		}
73
74		/**
75		* @param array $where
76		* @return UserOptionsEntity[]
77		*/
78		public function fetchBy(array $where = [])
79		{
80		$queryBuilder = $this->connection->createQueryBuilder()
81		->select('*')
82		->from(self::TABLE);
83
84		if (count($where) > 0) {
85		foreach ($where as $column => $value) {
86		$queryBuilder->andWhere($column . ' = ' . $queryBuilder->createNamedParameter($value));
87		}
88		}
89
90		$statement = $queryBuilder->execute();
91
92		$result = $statement->fetchAll();
93
94		if ($statement->rowCount() === 0) {
95		throw new RecordsNotFoundException('No records with given where clause found');
96		}
97
98		$entities = [];
99
100		foreach ($result as $item) {
101		$entities[] = $this->getEntityFromDatabaseArray($item);
102		}
103
104		return $entities;
105		}
106
107		/**
108		* @param UserOptionsEntity $entity
109		* @return UserOptionsEntity
110		*/
111		public function create(UserOptionsEntity $entity)
112		{
113		if (!$entity->isNew()) {
114		throw new RecordAlreadyExistsException('The entity does already exist.');
115		}
116
117		$databaseArray = $this->getDatabaseArrayFromEntity($entity);
118
119		$this->connection->insert(
120		self::TABLE,
121		$databaseArray
122		);
123
124		$entity->userId = (int) $this->connection->lastInsertId();
125
126		return $entity;
127		}
128
129		/**
130		* @param UserOptionsEntity $entity
131		* @return UserOptionsEntity
132		*/
133		public function update(UserOptionsEntity $entity)
134		{
135		if ($entity->isNew()) {
136		throw new RecordNotPersistedException('The entity does not exist.');
137		}
138
139		$databaseArray = $this->getDatabaseArrayFromEntity($entity);
140
141		$this->connection->update(
142		self::TABLE,
143		$databaseArray,
144		['user_id' => $entity->userId]
145		);
146
147		return $entity;
148		}
149
150		/**
151		* @param UserOptionsEntity $entity
152		* @return UserOptionsEntity
153		*/
154		public function remove(UserOptionsEntity $entity)
155		{
156		if ($entity->isNew()) {
157		throw new RecordNotPersistedException('The entity does not exist.');
158		}
159
160		$this->connection->delete(
161		self::TABLE,
162		['user_id' => $entity->userId]
163		);
164
165		$entity->cacheId = null;
		0 ignored issues – show Bug introduced 2018-08-10 14:46 UTC by Report Bug Copy Issue Report The property `cacheId` does not seem to exist in `UserOptionsEntity`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
166
167		return $entity;
168		}
169
170		/**
171		* @param UserOptionsEntity $entity
172		* @return []
		0 ignored issues – show Documentation introduced 2018-08-10 14:46 UTC by Report Bug Copy Issue Report The doc-type `[]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
173		*/
174		public function getDatabaseArrayFromEntity(UserOptionsEntity $entity)
175		{
176		return [
177		'user_id' => $entity->userId,
178		'option_id' => $entity->optionId,
179		'option_visible' => $entity->optionVisible,
180		'option_value' => $entity->optionValue,
181		];
182		}
183
184		/**
185		* @param array $data
186		* @return UserOptionsEntity
187		*/
188		public function getEntityFromDatabaseArray(array $data)
189		{
190		$entity = new UserOptionsEntity();
191		$entity->userId = $data['user_id'];
192		$entity->optionId = $data['option_id'];
193		$entity->optionVisible = $data['option_visible'];
194		$entity->optionValue = $data['option_value'];
195
196		return $entity;
197		}
198		}
199

OpencachingDeutschland / oc-server3

Pull Request — development (#720)

getEntityFromDatabaseArray() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like