QueryBuilderTrait - Code Metrics - Inspection of "Added dynamic where query builder" - Codexshaper/laravel-woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d5512a...a63d8f )

by CodexShaper

created 2020-05-07 23:41 UTC

QueryBuilderTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	294
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	41
lcom	1
cbo	0
dl	0
loc	294
ccs	0
cts	157
cp	0
rs	9.1199
c	0
b	0
f	0

14 Methods

Rating	Name	Size	Complexity
A	all()	4	1
A	find()	4	1
A	create()	4	1
A	update()	4	1
A	delete()	4	1
A	batch()	4	1
A	get()	9	2
A	first()	4	1
A	options()	16	4
D	where()	60	21
A	orderBy()	7	1
A	paginate()	33	3
A	count()	11	2
A	save()	6	1

How to fix Complexity

<?php

namespace Codexshaper\WooCommerce\Traits;

use Codexshaper\WooCommerce\Facades\WooCommerce;

trait QueryBuilderTrait
{
    /**
     * @var
     */
    protected $options = [];
    /**
     * @var
     */
    protected $where = [];
    /**
     * @var
     */
    protected $properties = [];

    /**
     * Retrieve all Items.
     *
     * @param array $options
     *
     * @return array
     */
    protected function all($options = [])
    {
        return WooCommerce::all($this->endpoint, $options);
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Retrieve single Item.
     *
     * @param int   $id
     * @param array $options
     *
     * @return object
     */
    protected function find($id, $options = [])
    {
        return WooCommerce::find("{$this->endpoint}/{$id}", $options);
    }

    /**
     * Create new Item.
     *
     * @param array $data
     *
     * @return object
     */
    protected function create($data)
    {
        return WooCommerce::create($this->endpoint, $data);
    }

    /**
     * Update Existing Item.
     *
     * @param int   $id
     * @param array $data
     *
     * @return object
     */
    protected function update($id, $data)
    {
        return WooCommerce::update("{$this->endpoint}/{$id}", $data);
    }

    /**
     * Destroy Item.
     *
     * @param int   $id
     * @param array $options
     *
     * @return object
     */
    protected function delete($id, $options = [])
    {
        return WooCommerce::delete("{$this->endpoint}/{$id}", $options);
    }

    /**
     * Batch Update.
     *
     * @param array $data
     *
     * @return object
     */
    protected function batch($data)
    {
        return WooCommerce::create("{$this->endpoint}/batch", $data);
    }

    /**
     * Retrieve data.
     *
     * @return array
     */
    protected function get()
    {
        try {
            $results = WooCommerce::all($this->endpoint, $this->options);
            return $results;
        } catch (\Exception $ex) {
            throw new \Exception($ex->getMessage(), 1);
        }
    }

    /**
     * Retrieve data.
     *
     * @return object
     */
    protected function first()
    {
        return $this->get()[0] ?? new \stdClass();
    }

    /**
     * Set options for woocommerce request.
     *
     * @param array $parameters
     *
     * @return object $this
     */
    protected function options($parameters)
    {
        if (!is_array($parameters)) {
            throw new \Exception('Options must be an array', 1);
        }

        if (empty($parameters)) {
            throw new \Exception('Options must be pass at least one element', 1);
        }

        foreach ($parameters as $key => $value) {
            $this->options[$key] = $value;
        }

        return $this;
    }

    /**
     * Join options for woocommerce request.
     *
     * @param array $parameters
     *
     * @return object $this
     */
    protected function where(...$parameters)
    {
        if (count($parameters) < 2 || count($parameters) > 3) {
            throw new \Exception("Too many arguments. You can pass minimum 2 and maximum 3 paramneters");
        }
        $field = $parameters[0];
        $value = count($parameters) == 3 ? $parameters[2] : $parameters[1];

        switch ($field) {
            case 'name':
            case 'title':
            case 'description':
                $this->options['search'] = $value;
                break;
            case 'sku':
                $this->options['sku'] = $value;
                break;
            case 'type':
                $this->options['type'] = $value;
                break;
            case 'category':
                $this->options['category'] = $value;
                break;
            case 'tag':
                $this->options['tag'] = $value;
                break;
            case 'after':
                $this->options['after'] = $value;
                break;
            case 'before':
                $this->options['before'] = $value;
                break;
            case 'attribute':
                $this->options['attribute'] = $value;
                break;
            case 'attribute_term':
                $this->options['attribute_term'] = $value;
                break;
            case 'in_stock':
                $this->options['in_stock'] = $value;
                break;
            case 'featured':
                $this->options['featured'] = $value;
                break;
            case 'min_price':
                $this->options['min_price'] = $value;
                break;
            case 'max_price':
                $this->options['max_price'] = $value;
                break;
            case 'shipping_class':
                $this->options['shipping_class'] = $value;
                break;
            case 'tax_class':
                $this->options['tax_class'] = $value;
                break;
        }

        return $this;
    }

    /**
     * Set order direction.
     *
     * @param string $name
     * @param string $direction
     *
     * @return object $this
     */
    protected function orderBy($name, $direction = 'desc')
    {
        $this->options['orderby'] = $name;
        $this->options['order'] = $direction;

        return $this;
    }

    /**
     * Paginate results.
     *
     * @param int $per_page
     * @param int $current_page
     *
     * @return array
     */
    protected function paginate($per_page, $current_page = 1)
    {
        try {
            $this->options['per_page'] = (int) $per_page;

            if ($current_page > 0) {
                $this->options['page'] = (int) $current_page;
            }

            $results = $this->get();
            $totalResults = WooCommerce::countResults();
            $totalPages = WooCommerce::countPages();
            $currentPage = WooCommerce::current();
            $previousPage = WooCommerce::previous();
            $nextPage = WooCommerce::next();

            $pagination = [
                'total_results' => $totalResults,
                'total_pages'   => $totalPages,
                'current_page'  => $currentPage,
                'previous_page' => $previousPage,
                'next_page'     => $nextPage,
                'first_page'    => 1,
                'last_page'     => $totalResults,
            ];

            $results['pagination'] = $pagination;

            return $results;
        } catch (\Exception $ex) {
            throw new \Exception($ex->getMessage(), 1);
        }
    }

    /**
     * Count all results.
     *
     * @return int
     */
    protected function count()
    {
        try {
            $results = WooCommerce::all($this->endpoint, $this->options);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $totalResults = WooCommerce::countResults();

            return $totalResults;
        } catch (\Exception $ex) {
            throw new \Exception($ex->getMessage(), 1);
        }
    }

    /**
     * Store data.
     *
     * @return array
     */
    public function save()
    {
        $this->results = WooCommerce::create($this->endpoint, $this->properties);
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this->results;
    }
}


1			<?php
2
3			namespace Codexshaper\WooCommerce\Traits;
4
5			use Codexshaper\WooCommerce\Facades\WooCommerce;
6
7			trait QueryBuilderTrait
8			{
9			/**
10			* @var
11			*/
12			protected $options = [];
13			/**
14			* @var
15			*/
16			protected $where = [];
17			/**
18			* @var
19			*/
20			protected $properties = [];
21
22			/**
23			* Retrieve all Items.
24			*
25			* @param array $options
26			*
27			* @return array
28			*/
29			protected function all($options = [])
30			{
31			return WooCommerce::all($this->endpoint, $options);
			0 ignored issues – show Bug introduced 2020-03-27 10:36 UTC by Report Bug Copy Issue Report The property `endpoint` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
32			}
33
34			/**
35			* Retrieve single Item.
36			*
37			* @param int $id
38			* @param array $options
39			*
40			* @return object
41			*/
42			protected function find($id, $options = [])
43			{
44			return WooCommerce::find("{$this->endpoint}/{$id}", $options);
45			}
46
47			/**
48			* Create new Item.
49			*
50			* @param array $data
51			*
52			* @return object
53			*/
54			protected function create($data)
55			{
56			return WooCommerce::create($this->endpoint, $data);
57			}
58
59			/**
60			* Update Existing Item.
61			*
62			* @param int $id
63			* @param array $data
64			*
65			* @return object
66			*/
67			protected function update($id, $data)
68			{
69			return WooCommerce::update("{$this->endpoint}/{$id}", $data);
70			}
71
72			/**
73			* Destroy Item.
74			*
75			* @param int $id
76			* @param array $options
77			*
78			* @return object
79			*/
80			protected function delete($id, $options = [])
81			{
82			return WooCommerce::delete("{$this->endpoint}/{$id}", $options);
83			}
84
85			/**
86			* Batch Update.
87			*
88			* @param array $data
89			*
90			* @return object
91			*/
92			protected function batch($data)
93			{
94			return WooCommerce::create("{$this->endpoint}/batch", $data);
95			}
96
97			/**
98			* Retrieve data.
99			*
100			* @return array
101			*/
102			protected function get()
103			{
104			try {
105			$results = WooCommerce::all($this->endpoint, $this->options);
106			return $results;
107			} catch (\Exception $ex) {
108			throw new \Exception($ex->getMessage(), 1);
109			}
110			}
111
112			/**
113			* Retrieve data.
114			*
115			* @return object
116			*/
117			protected function first()
118			{
119			return $this->get()[0] ?? new \stdClass();
120			}
121
122			/**
123			* Set options for woocommerce request.
124			*
125			* @param array $parameters
126			*
127			* @return object $this
128			*/
129			protected function options($parameters)
130			{
131			if (!is_array($parameters)) {
132			throw new \Exception('Options must be an array', 1);
133			}
134
135			if (empty($parameters)) {
136			throw new \Exception('Options must be pass at least one element', 1);
137			}
138
139			foreach ($parameters as $key => $value) {
140			$this->options[$key] = $value;
141			}
142
143			return $this;
144			}
145
146			/**
147			* Join options for woocommerce request.
148			*
149			* @param array $parameters
150			*
151			* @return object $this
152			*/
153			protected function where(...$parameters)
154			{
155			if (count($parameters) < 2 \|\| count($parameters) > 3) {
156			throw new \Exception("Too many arguments. You can pass minimum 2 and maximum 3 paramneters");
157			}
158			$field = $parameters[0];
159			$value = count($parameters) == 3 ? $parameters[2] : $parameters[1];
160
161			switch ($field) {
162			case 'name':
163			case 'title':
164			case 'description':
165			$this->options['search'] = $value;
166			break;
167			case 'sku':
168			$this->options['sku'] = $value;
169			break;
170			case 'type':
171			$this->options['type'] = $value;
172			break;
173			case 'category':
174			$this->options['category'] = $value;
175			break;
176			case 'tag':
177			$this->options['tag'] = $value;
178			break;
179			case 'after':
180			$this->options['after'] = $value;
181			break;
182			case 'before':
183			$this->options['before'] = $value;
184			break;
185			case 'attribute':
186			$this->options['attribute'] = $value;
187			break;
188			case 'attribute_term':
189			$this->options['attribute_term'] = $value;
190			break;
191			case 'in_stock':
192			$this->options['in_stock'] = $value;
193			break;
194			case 'featured':
195			$this->options['featured'] = $value;
196			break;
197			case 'min_price':
198			$this->options['min_price'] = $value;
199			break;
200			case 'max_price':
201			$this->options['max_price'] = $value;
202			break;
203			case 'shipping_class':
204			$this->options['shipping_class'] = $value;
205			break;
206			case 'tax_class':
207			$this->options['tax_class'] = $value;
208			break;
209			}
210
211			return $this;
212			}
213
214			/**
215			* Set order direction.
216			*
217			* @param string $name
218			* @param string $direction
219			*
220			* @return object $this
221			*/
222			protected function orderBy($name, $direction = 'desc')
223			{
224			$this->options['orderby'] = $name;
225			$this->options['order'] = $direction;
226
227			return $this;
228			}
229
230			/**
231			* Paginate results.
232			*
233			* @param int $per_page
234			* @param int $current_page
235			*
236			* @return array
237			*/
238			protected function paginate($per_page, $current_page = 1)
239			{
240			try {
241			$this->options['per_page'] = (int) $per_page;
242
243			if ($current_page > 0) {
244			$this->options['page'] = (int) $current_page;
245			}
246
247			$results = $this->get();
248			$totalResults = WooCommerce::countResults();
249			$totalPages = WooCommerce::countPages();
250			$currentPage = WooCommerce::current();
251			$previousPage = WooCommerce::previous();
252			$nextPage = WooCommerce::next();
253
254			$pagination = [
255			'total_results' => $totalResults,
256			'total_pages' => $totalPages,
257			'current_page' => $currentPage,
258			'previous_page' => $previousPage,
259			'next_page' => $nextPage,
260			'first_page' => 1,
261			'last_page' => $totalResults,
262			];
263
264			$results['pagination'] = $pagination;
265
266			return $results;
267			} catch (\Exception $ex) {
268			throw new \Exception($ex->getMessage(), 1);
269			}
270			}
271
272			/**
273			* Count all results.
274			*
275			* @return int
276			*/
277			protected function count()
278			{
279			try {
280			$results = WooCommerce::all($this->endpoint, $this->options);
			0 ignored issues – show Unused Code introduced 2020-04-28 08:01 UTC by Report Bug Copy Issue Report `$results` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
281			$totalResults = WooCommerce::countResults();
282
283			return $totalResults;
284			} catch (\Exception $ex) {
285			throw new \Exception($ex->getMessage(), 1);
286			}
287			}
288
289			/**
290			* Store data.
291			*
292			* @return array
293			*/
294			public function save()
295			{
296			$this->results = WooCommerce::create($this->endpoint, $this->properties);
			0 ignored issues – show Bug introduced 2020-03-27 10:36 UTC by Report Bug Copy Issue Report The property `results` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
297
298			return $this->results;
299			}
300			}
301

Codexshaper / laravel-woocommerce

Push — master ( d5512a...a63d8f )

QueryBuilderTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

14 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like