Processor::defaultFormat() - Code Metrics - mav3rick177/rapid-pagination - Measure and Improve Code Quality continuously with Scrutinizer

Processor::defaultFormat() A
last analyzed 2021-05-06 14:43 UTC

↳ Parent: Processor

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
nc	1
nop	3
dl	0
loc	4
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php

namespace mav3rick177\RapidPagination;

use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Support\Traits\Macroable;
use mav3rick177\RapidPagination\Base\AbstractProcessor;
use mav3rick177\RapidPagination\Base\Query;

/**
 * Class Processor
 *
 * @see AbstractProcessor
 */
class Processor extends AbstractProcessor
{
    use Macroable;

    /**
     * @var mixed
     */
    protected $builder;

    /**
     * Get result.
     *
     * @param  Query                       $query
     * @param  Collection|Model[]|object[] $rows
     * @return mixed
     */
    public function process(Query $query, $rows)
    {
        $this->builder = $query->builder();
        return parent::process($query, $rows);
    }

    /**
     * Return comparable value from a row.
     *
     * @param  mixed      $row
     * @param  string     $column
     * @return int|string
     */
    protected function field($row, $column)
    {
        $column = static::dropTablePrefix($column);
        if ($this->builder instanceof BelongsToMany && strpos($column, 'pivot_') === 0) {
            return $this->pivotField($row, substr($column, 6), $this->pivotAccessor());
        }
        $value = $row->$column;
        return is_object($value) ? (string)$value : $value;
    }

    /**
     * Extract pivot from a row.
     *
     * @param  mixed      $row
     * @param  string     $column
     * @param  string     $accessor
     * @throws \Exception
     * @return int|string
     */
    protected function pivotField($row, $column, $accessor)
    {
        $pivot = $row->$accessor;
        if (!isset($pivot->$column)) {
            throw new \Exception("The column `$column` is not included in the pivot \"$accessor\".");
        }
        return $this->field($pivot, $column);
    }

    /**
     * Extract pivot accessor from a relation.
     *
     * @return string
     */
    protected function pivotAccessor()
    {
        return $this->builder->getPivotAccessor();
    }

    /**
     * Return the n-th element of collection.
     * Must return null if not exists.
     *
     * @param  Collection|Model[]|object[] $rows
     * @param  int                         $offset
     * @return Model|object
     */
    protected function offset($rows, $offset)
    {
        return isset($rows[$offset]) ? $rows[$offset] : null;
    }

    /**
     * Slice rows, like PHP function array_slice().
     *
     * @param  Collection|Model[]|object[] $rows
     * @param  int                         $offset
     * @param  null|int                    $length
     * @return Collection|Model[]|object[]
     */
    protected function slice($rows, $offset, $length = null)
    {
        return $rows->slice($offset, $length)->values();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
    }

    /**
     * Count rows, like PHP function count().
     *
     * @param  Collection|Model[]|object[] $rows
     * @return int
     */
    protected function count($rows)
    {
        return $rows->count();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
    }

    /**
     * Reverse rows, like PHP function array_reverse().
     *
     * @param  Collection|Model[]|object[] $rows
     * @return Collection|Model[]|object[]
     */
    protected function reverse($rows)
    {
        return $rows->reverse()->values();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
    }

    /**
     * Format result.
     *
     * @param  Collection|Model[]|object[] $rows
     * @param  array                       $meta
     * @param  Query                       $query
     * @return PaginationResult
     */
    protected function defaultFormat($rows, array $meta, Query $query)
    {
        return new PaginationResult($rows, $meta);
    }

    /**
     * Drop table prefix on column name.
     *
     * @param  string $column
     * @return string
     */
    protected static function dropTablePrefix(string $column)
    {
        $segments = explode('.', $column);

        return end($segments);
    }
}


1		<?php
2
3		namespace mav3rick177\RapidPagination;
4
5		use Illuminate\Database\Eloquent\Collection;
6		use Illuminate\Database\Eloquent\Model;
7		use Illuminate\Database\Eloquent\Relations\BelongsToMany;
8		use Illuminate\Support\Traits\Macroable;
9		use mav3rick177\RapidPagination\Base\AbstractProcessor;
10		use mav3rick177\RapidPagination\Base\Query;
11
12		/**
13		* Class Processor
14		*
15		* @see AbstractProcessor
16		*/
17		class Processor extends AbstractProcessor
18		{
19		use Macroable;
20
21		/**
22		* @var mixed
23		*/
24		protected $builder;
25
26		/**
27		* Get result.
28		*
29		* @param Query $query
30		* @param Collection\|Model[]\|object[] $rows
31		* @return mixed
32		*/
33	2	public function process(Query $query, $rows)
34		{
35	2	$this->builder = $query->builder();
36	2	return parent::process($query, $rows);
37		}
38
39		/**
40		* Return comparable value from a row.
41		*
42		* @param mixed $row
43		* @param string $column
44		* @return int\|string
45		*/
46		protected function field($row, $column)
47		{
48		$column = static::dropTablePrefix($column);
49		if ($this->builder instanceof BelongsToMany && strpos($column, 'pivot_') === 0) {
50		return $this->pivotField($row, substr($column, 6), $this->pivotAccessor());
51		}
52		$value = $row->$column;
53		return is_object($value) ? (string)$value : $value;
54		}
55
56		/**
57		* Extract pivot from a row.
58		*
59		* @param mixed $row
60		* @param string $column
61		* @param string $accessor
62		* @throws \Exception
63		* @return int\|string
64		*/
65		protected function pivotField($row, $column, $accessor)
66		{
67		$pivot = $row->$accessor;
68		if (!isset($pivot->$column)) {
69		throw new \Exception("The column `$column` is not included in the pivot \"$accessor\".");
70		}
71		return $this->field($pivot, $column);
72		}
73
74		/**
75		* Extract pivot accessor from a relation.
76		*
77		* @return string
78		*/
79		protected function pivotAccessor()
80		{
81		return $this->builder->getPivotAccessor();
82		}
83
84		/**
85		* Return the n-th element of collection.
86		* Must return null if not exists.
87		*
88		* @param Collection\|Model[]\|object[] $rows
89		* @param int $offset
90		* @return Model\|object
91		*/
92	2	protected function offset($rows, $offset)
93		{
94	2	return isset($rows[$offset]) ? $rows[$offset] : null;
95		}
96
97		/**
98		* Slice rows, like PHP function array_slice().
99		*
100		* @param Collection\|Model[]\|object[] $rows
101		* @param int $offset
102		* @param null\|int $length
103		* @return Collection\|Model[]\|object[]
104		*/
105		protected function slice($rows, $offset, $length = null)
106		{
107		return $rows->slice($offset, $length)->values();
		0 ignored issues – show Bug introduced 2021-03-25 00:26 UTC by Report Bug Copy Issue Report It seems like `$rows` is not always an object, but can also be of type `array<integer,object>`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
108		}
109
110		/**
111		* Count rows, like PHP function count().
112		*
113		* @param Collection\|Model[]\|object[] $rows
114		* @return int
115		*/
116	2	protected function count($rows)
117		{
118	2	return $rows->count();
		0 ignored issues – show Bug introduced 2021-03-25 00:26 UTC by Report Bug Copy Issue Report It seems like `$rows` is not always an object, but can also be of type `array<integer,object>`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
119		}
120
121		/**
122		* Reverse rows, like PHP function array_reverse().
123		*
124		* @param Collection\|Model[]\|object[] $rows
125		* @return Collection\|Model[]\|object[]
126		*/
127		protected function reverse($rows)
128		{
129		return $rows->reverse()->values();
		0 ignored issues – show Bug introduced 2021-03-25 00:26 UTC by Report Bug Copy Issue Report It seems like `$rows` is not always an object, but can also be of type `array<integer,object>`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
130		}
131
132		/**
133		* Format result.
134		*
135		* @param Collection\|Model[]\|object[] $rows
136		* @param array $meta
137		* @param Query $query
138		* @return PaginationResult
139		*/
140		protected function defaultFormat($rows, array $meta, Query $query)
141		{
142		return new PaginationResult($rows, $meta);
143		}
144
145		/**
146		* Drop table prefix on column name.
147		*
148		* @param string $column
149		* @return string
150		*/
151		protected static function dropTablePrefix(string $column)
152		{
153		$segments = explode('.', $column);
154
155		return end($segments);
156		}
157		}
158

mav3rick177 / rapid-pagination

Processor::defaultFormat() A last analyzed 2021-05-06 14:43 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Processor::defaultFormat() A
last analyzed 2021-05-06 14:43 UTC