SoftDbRepository::getAllSoft() - Code Metrics - Inspection of "Updated requirements" - lrc-se/bth-anax-repository - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 281d16...f910eb )

by LRC

created 2017-10-22 08:09 UTC

SoftDbRepository::getAllSoft() B

↳ Parent: SoftDbRepository

Complexity

Conditions	5
Paths	4

Size

Total Lines	19
Code Lines	13

Duplication

Lines	19
Ratio	100 %

Code Coverage

Tests	16
CRAP Score	5

Importance

Changes

Metric	Value
dl	19
loc	19
ccs	16
cts	16
cp	1
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	13
nc	4
nop	3
crap	5

<?php

namespace LRC\Repository;

/**
 * Base class for database-backed soft-deletion-aware repositories for data access.
 */
class SoftDbRepository extends DbRepository implements SoftRepositoryInterface
{
    /**
     * @var string  Soft deletion attribute.
     */
    protected $deleted;
    
    
    /**
     * Constructor.
     *
     * @param \Anax\Database\DatabaseQueryBuilder   $db         Database service.
     * @param string                                $table      Database table name.
     * @param string                                $modelClass Model class name.
     * @param string                                $deleted    Soft deletion attribute.
     * @param string                                $key        Primary key column.
     */
    public function __construct($db, $table, $modelClass, $deleted = 'deleted', $key = 'id')
    {
        parent::__construct($db, $table, $modelClass, $key);
        $this->deleted = $deleted;
    }
    
    
    /**
     * Return the name of the attribute used to mark soft deletion.
     */
    public function getDeletedAttribute()
    {
        return $this->deleted;
    }
    
    
    /**
     * Find and return first entry by key, ignoring soft-deleted entries.
     *
     * @param string|null   $column Key column name (pass null to use registered primary key).
     * @param mixed         $value  Key value.
     *
     * @return mixed                Model instance.
     */
    public function findSoft($column, $value)
    {
        return $this->getFirstSoft((is_null($column) ? $this->key : $column) . ' = ?', [$value]);
    }
    
    
    /**
     * Retrieve first entry ignoring soft-deleted ones, optionally filtered by search criteria.
     * 
     * @param string $conditions    Where conditions.
     * @param array  $values        Array of condition values to bind.
     * @param array  $options       Query options.
     * 
     * @return mixed                Model instance.
     */
    public function getFirstSoft($conditions = null, $values = [], $options = [])

    {
        $query = $this->executeQuerySoft(null, $conditions, $values, $options);
        if (!empty($this->fetchRefs)) {
            $res = $query->fetch();
            $model = ($res ? $this->populateModelFromJoin($res) : $res);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
            $model = $query->fetchClass($this->modelClass);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        if ($model && isset($this->manager)) {
            $this->manager->manageModel($model);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }
        $this->fetchReferences(false);
        return $model;
    }
    
    
    /**
     * Retrieve all entries ignoring soft-deleted ones, optionally filtered by search criteria.
     * 
     * @param string $conditions    Where conditions.
     * @param array  $values        Array of condition values to bind.
     * @param array  $options       Query options.
     * 
     * @return array                Array of all matching entries.
     */
    public function getAllSoft($conditions = null, $values = [], $options = [])

    {
        $query = $this->executeQuerySoft(null, $conditions, $values, $options);
        if (!empty($this->fetchRefs)) {
            $models = [];
            foreach ($query->fetchAll() as $model) {
                $models[] = $this->populateModelFromJoin($model);
            }
        } else {
            $models = $query->fetchAllClass($this->modelClass);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        if (isset($this->manager)) {
            foreach ($models as $model) {
                $this->manager->manageModel($model);
            }
        }
        $this->fetchReferences(false);
        return $models;
    }
    
    
    /**
     * Soft delete entry.
     *
     * @param mixed $model  Model instance.
     */
    public function deleteSoft($model)
    {
        $model->deleted = date('Y-m-d H:i:s');
        $this->save($model);
    }
    
    
    /**
     * Restore soft-deleted entry.
     *
     * @param mixed $model  Model instance.
     */
    public function restoreSoft($model)
    {
        $model->deleted = null;
        $this->save($model);
    }
    
    
    /**
     * Count entries ignoring soft-deleted ones, optionally filtered by search criteria.
     *
     * @param string $conditions    Where conditions.
     * @param array  $values        Array of condition values to bind.
     * 
     * @return int                  Number of entries.
     */
    public function countSoft($conditions = null, $values = [])
    {
        $res = $this->executeQuerySoft('COUNT(' . $this->key . ') AS num', $conditions, $values)
            ->fetch();
        return (isset($res->num) ? (int)$res->num : 0);
    }
    
    
    /**
     * Execute soft-deletion-aware query for selection methods.
     * 
     * @param   string  $select                     Selection criteria.
     * @param   string  $conditions                 Where conditions.
     * @param   array   $values                     Array of where condition values to bind.
     * @param   array   $options                    Query options.
     * 
     * @return \Anax\Database\DatabaseQueryBuilder  Database service instance with executed internal query.
     */
    protected function executeQuerySoft($select = null, $conditions = null, $values = [], $options = [])
    {
        $delCond = $this->deleted . ' IS NULL';
        $conditions = (is_null($conditions) ? $delCond : "($conditions) AND $delCond");
        return $this->executeQuery($select, $conditions, $values, $options);
    }
}


1			<?php
2
3			namespace LRC\Repository;
4
5			/**
6			* Base class for database-backed soft-deletion-aware repositories for data access.
7			*/
8			class SoftDbRepository extends DbRepository implements SoftRepositoryInterface
9			{
10			/**
11			* @var string Soft deletion attribute.
12			*/
13			protected $deleted;
14
15
16			/**
17			* Constructor.
18			*
19			* @param \Anax\Database\DatabaseQueryBuilder $db Database service.
20			* @param string $table Database table name.
21			* @param string $modelClass Model class name.
22			* @param string $deleted Soft deletion attribute.
23			* @param string $key Primary key column.
24			*/
25	15		public function __construct($db, $table, $modelClass, $deleted = 'deleted', $key = 'id')
26			{
27	15		parent::__construct($db, $table, $modelClass, $key);
28	15		$this->deleted = $deleted;
29	15		}
30
31
32			/**
33			* Return the name of the attribute used to mark soft deletion.
34			*/
35	3		public function getDeletedAttribute()
36			{
37	3		return $this->deleted;
38			}
39
40
41			/**
42			* Find and return first entry by key, ignoring soft-deleted entries.
43			*
44			* @param string\|null $column Key column name (pass null to use registered primary key).
45			* @param mixed $value Key value.
46			*
47			* @return mixed Model instance.
48			*/
49	8		public function findSoft($column, $value)
50			{
51	8		return $this->getFirstSoft((is_null($column) ? $this->key : $column) . ' = ?', [$value]);
52			}
53
54
55			/**
56			* Retrieve first entry ignoring soft-deleted ones, optionally filtered by search criteria.
57			*
58			* @param string $conditions Where conditions.
59			* @param array $values Array of condition values to bind.
60			* @param array $options Query options.
61			*
62			* @return mixed Model instance.
63			*/
64	9	View Code Duplication	public function getFirstSoft($conditions = null, $values = [], $options = [])
			0 ignored issues – show Duplication introduced 2017-10-22 08:11 UTC by Report Bug Copy Issue Report This method 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...
65			{
66	9		$query = $this->executeQuerySoft(null, $conditions, $values, $options);
67	9		if (!empty($this->fetchRefs)) {
68	2		$res = $query->fetch();
69	2		$model = ($res ? $this->populateModelFromJoin($res) : $res);
			0 ignored issues – show Documentation introduced 2017-10-22 08:11 UTC by Report Bug Copy Issue Report `$res` is of type `array`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
70	2		} else {
71	7		$model = $query->fetchClass($this->modelClass);
			0 ignored issues – show Documentation introduced 2017-10-22 08:11 UTC by Report Bug Copy Issue Report `$this->modelClass` is of type `string`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
72			}
73	9		if ($model && isset($this->manager)) {
74	4		$this->manager->manageModel($model);
			0 ignored issues – show Bug introduced 2017-10-22 08:11 UTC by Report Bug Copy Issue Report It seems like `$model` can also be of type `array`; however, `LRC\Repository\RepositoryManager::manageModel()` does only seem to accept `object`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
75	4		}
76	9		$this->fetchReferences(false);
77	9		return $model;
78			}
79
80
81			/**
82			* Retrieve all entries ignoring soft-deleted ones, optionally filtered by search criteria.
83			*
84			* @param string $conditions Where conditions.
85			* @param array $values Array of condition values to bind.
86			* @param array $options Query options.
87			*
88			* @return array Array of all matching entries.
89			*/
90	2	View Code Duplication	public function getAllSoft($conditions = null, $values = [], $options = [])
			0 ignored issues – show Duplication introduced 2017-10-22 08:11 UTC by Report Bug Copy Issue Report This method 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...
91			{
92	2		$query = $this->executeQuerySoft(null, $conditions, $values, $options);
93	2		if (!empty($this->fetchRefs)) {
94	1		$models = [];
95	1		foreach ($query->fetchAll() as $model) {
96	1		$models[] = $this->populateModelFromJoin($model);
97	1		}
98	1		} else {
99	1		$models = $query->fetchAllClass($this->modelClass);
			0 ignored issues – show Documentation introduced 2017-10-22 08:11 UTC by Report Bug Copy Issue Report `$this->modelClass` is of type `string`, but the function expects a `object`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
100			}
101	2		if (isset($this->manager)) {
102	1		foreach ($models as $model) {
103	1		$this->manager->manageModel($model);
104	1		}
105	1		}
106	2		$this->fetchReferences(false);
107	2		return $models;
108			}
109
110
111			/**
112			* Soft delete entry.
113			*
114			* @param mixed $model Model instance.
115			*/
116	1		public function deleteSoft($model)
117			{
118	1		$model->deleted = date('Y-m-d H:i:s');
119	1		$this->save($model);
120	1		}
121
122
123			/**
124			* Restore soft-deleted entry.
125			*
126			* @param mixed $model Model instance.
127			*/
128	1		public function restoreSoft($model)
129			{
130	1		$model->deleted = null;
131	1		$this->save($model);
132	1		}
133
134
135			/**
136			* Count entries ignoring soft-deleted ones, optionally filtered by search criteria.
137			*
138			* @param string $conditions Where conditions.
139			* @param array $values Array of condition values to bind.
140			*
141			* @return int Number of entries.
142			*/
143	1		public function countSoft($conditions = null, $values = [])
144			{
145	1		$res = $this->executeQuerySoft('COUNT(' . $this->key . ') AS num', $conditions, $values)
146	1		->fetch();
147	1		return (isset($res->num) ? (int)$res->num : 0);
148			}
149
150
151			/**
152			* Execute soft-deletion-aware query for selection methods.
153			*
154			* @param string $select Selection criteria.
155			* @param string $conditions Where conditions.
156			* @param array $values Array of where condition values to bind.
157			* @param array $options Query options.
158			*
159			* @return \Anax\Database\DatabaseQueryBuilder Database service instance with executed internal query.
160			*/
161	11		protected function executeQuerySoft($select = null, $conditions = null, $values = [], $options = [])
162			{
163	11		$delCond = $this->deleted . ' IS NULL';
164	11		$conditions = (is_null($conditions) ? $delCond : "($conditions) AND $delCond");
165	11		return $this->executeQuery($select, $conditions, $values, $options);
166			}
167			}
168

lrc-se / bth-anax-repository

Push — master ( 281d16...f910eb )

SoftDbRepository::getAllSoft() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like