QueryOperations::getFetchQueryParameters() - Code Metrics - Inspection of "Removing php version limits to allow building on h..." - ntentan/nibii - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7f591d...75938c )

by James Ekow Abaka

created 2017-06-26 16:34 UTC

QueryOperations::getFetchQueryParameters() B

↳ Parent: QueryOperations

Complexity

Conditions	5
Paths	4

Size

Total Lines	19
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	5

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * The MIT License
 *
 * Copyright 2015 ekow.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace ntentan\nibii;

use ntentan\utils\Text;

class QueryOperations {

    /**
     *
     * @var RecordWrapper
     */
    private $wrapper;
    private $adapter;
    private $queryParameters;
    private $pendingMethod;
    private $dynamicMethods = [
        "/(?<method>filterBy)(?<variable>[A-Z][A-Za-z]+){1}/",
        "/(?<method>sort)(?<direction>Asc|Desc)?(By)(?<variable>[A-Z][A-Za-z]+){1}/",
        "/(?<method>fetch)(?<first>First)?(With)(?<variable>[A-Za-z]+)/"
    ];
    private $dataOperations;
    private $driver;

    /**
     * 
     * @param RecordWrapper $wrapper
     * @param DriverAdapter $adapter
     * @param DataOperations $dataOperations
     */
    public function __construct(ORMContext $context, RecordWrapper $wrapper, DriverAdapter $adapter, $dataOperations) {
        $this->wrapper = $wrapper;
        $this->adapter = $adapter;
        $this->dataOperations = $dataOperations;
        $this->driver = $context->getDbContext()->getDriver();
    }

    public function doFetch($id = null) {
        $parameters = $this->getFetchQueryParameters($id);
        $data = $this->adapter->select($parameters);
        $this->wrapper->setData($data);
        $this->resetQueryParameters();
        return $this->wrapper;
    }

    private function getFetchQueryParameters($arg, $instantiate = true) {
        if ($arg instanceof \ntentan\nibii\QueryParameters) {
            return $arg;
        }        
        
        $parameters = $this->getQueryParameters($instantiate);
        
        if (is_numeric($arg)) {
            $description = $this->wrapper->getDescription();
            $parameters->addFilter($description->getPrimaryKey()[0], $arg);
            $parameters->setFirstOnly(true);
        } else if (is_array($arg)) {
            foreach ($arg as $field => $value) {
                $parameters->addFilter($field, $value);
            }
        }
        
        return $parameters;
    }

    /**
     *
     * @return \ntentan\nibii\QueryParameters
     */
    private function getQueryParameters($instantiate = true) {
        if ($this->queryParameters === null && $instantiate) {
            $this->queryParameters = new QueryParameters($this->wrapper->getDBStoreInformation()['quoted_table']);
        }
        return $this->queryParameters;
    }

    private function resetQueryParameters() {
        $this->queryParameters = null;
    }

    public function doFetchFirst($id = null) {
        $this->getQueryParameters()->setFirstOnly(true);
        return $this->doFetch($id);
    }

    public function doFields() {
        $fields = [];
        $arguments = func_get_args();
        foreach ($arguments as $argument) {
            if (is_array($argument)) {
                $fields = array_merge($fields, $argument);
            } else {
                $fields[] = $argument;
            }
        }
        $this->getQueryParameters()->setFields($fields);
        return $this->wrapper;
    }
    
    public function doSortBy($field, $direction = 'ASC') {
        $this->getQueryParameters()->addSort($field, $direction);
    }

    private function getFilter($arguments) {
        if (count($arguments) == 2 && is_array($arguments[1])) {
            $filter = $arguments[0];
            $data = $arguments[1];
        } else {
            $filter = array_shift($arguments);
            $data = $arguments;
        }
        return ['filter' => $filter, 'data' => $data];
    }

    public function doFilter() {

        $arguments = func_get_args();
        $details = $this->getFilter($arguments);
        $this->getQueryParameters()->setFilter($details['filter'], $details['data']);
        return $this->wrapper;
    }

    public function doFilterBy() {

        $arguments = func_get_args();
        $details = $this->getFilter($arguments);
        $this->getQueryParameters()->addFilter($details['filter'], $details['data']);
        return $this->wrapper;
    }

    public function doUpdate($data) {
        $this->driver->beginTransaction();
        $parameters = $this->getQueryParameters();
        $this->adapter->bulkUpdate($data, $parameters);
        $this->driver->commit();
        $this->resetQueryParameters();
    }

    public function doDelete($args = null) {
        $this->driver->beginTransaction();
        $parameters = $this->getFetchQueryParameters($args);

        if ($parameters === null) {
            $primaryKey = $this->wrapper->getDescription()->getPrimaryKey();
            $parameters = $this->getQueryParameters();
            $data = $this->wrapper->getData();
            $keys = [];

            foreach ($data as $datum) {
                if ($this->dataOperations->isItemDeletable($primaryKey, $datum)) {
                    $keys[] = $datum[$primaryKey[0]];
                }
            }

            $parameters->addFilter($primaryKey[0], $keys);
            $this->adapter->delete($parameters);
        } else {
            $this->adapter->delete($parameters);
        }

        $this->driver->commit();
        $this->resetQueryParameters();
    }

    public function runDynamicMethod($arguments) {
        $arguments = count($arguments) > 1 ? $arguments : $arguments[0];
        switch ($this->pendingMethod['method']) {
            case 'filterBy':
                $this->getQueryParameters()->addFilter(Text::deCamelize($this->pendingMethod['variable']), $arguments);
                return $this->wrapper;
            case 'sort':
                $this->getQueryParameters()->addSort(Text::deCamelize($this->pendingMethod['variable']), $this->pendingMethod['direction']);
                return $this->wrapper;
            case 'fetch':
                $parameters = $this->getQueryParameters();
                $parameters->addFilter(Text::deCamelize($this->pendingMethod['variable']), $arguments);
                if ($this->pendingMethod['first'] === 'First') {
                    $parameters->setFirstOnly(true);
                }
                return $this->doFetch();
        }
    }

    public function initDynamicMethod($method) {
        $return = false;

        foreach ($this->dynamicMethods as $regexp) {
            if (preg_match($regexp, $method, $matches)) {
                $return = true;
                $this->pendingMethod = $matches;
                break;
            }
        }

        return $return;
    }

    public function doCount() {

        return $this->adapter->count($this->getQueryParameters());
    }

    public function doLimit($numItems) {
        $this->getQueryParameters()->setLimit($numItems);
        return $this->wrapper;
    }

    public function doOffset($offset) {
        $this->getQueryParameters()->setOffset($offset);
        return $this->wrapper;
    }
    
    public function doWith($model) {

        $relationship = $this->wrapper->getDescription()->getRelationships()[$model];
        return $relationship->getQuery();
    }

}


1			<?php
2
3			/*
4			* The MIT License
5			*
6			* Copyright 2015 ekow.
7			*
8			* Permission is hereby granted, free of charge, to any person obtaining a copy
9			* of this software and associated documentation files (the "Software"), to deal
10			* in the Software without restriction, including without limitation the rights
11			* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12			* copies of the Software, and to permit persons to whom the Software is
13			* furnished to do so, subject to the following conditions:
14			*
15			* The above copyright notice and this permission notice shall be included in
16			* all copies or substantial portions of the Software.
17			*
18			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20			* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21			* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22			* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23			* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24			* THE SOFTWARE.
25			*/
26
27			namespace ntentan\nibii;
28
29			use ntentan\utils\Text;
30
31			class QueryOperations {
32
33			/**
34			*
35			* @var RecordWrapper
36			*/
37			private $wrapper;
38			private $adapter;
39			private $queryParameters;
40			private $pendingMethod;
41			private $dynamicMethods = [
42			"/(?<method>filterBy)(?<variable>[A-Z][A-Za-z]+){1}/",
43			"/(?<method>sort)(?<direction>Asc\|Desc)?(By)(?<variable>[A-Z][A-Za-z]+){1}/",
44			"/(?<method>fetch)(?<first>First)?(With)(?<variable>[A-Za-z]+)/"
45			];
46			private $dataOperations;
47			private $driver;
48
49			/**
50			*
51			* @param RecordWrapper $wrapper
52			* @param DriverAdapter $adapter
53			* @param DataOperations $dataOperations
54			*/
55	35	View Code Duplication	public function __construct(ORMContext $context, RecordWrapper $wrapper, DriverAdapter $adapter, $dataOperations) {
56	35		$this->wrapper = $wrapper;
57	35		$this->adapter = $adapter;
58	35		$this->dataOperations = $dataOperations;
59	35		$this->driver = $context->getDbContext()->getDriver();
60	35		}
61
62	25		public function doFetch($id = null) {
63	25		$parameters = $this->getFetchQueryParameters($id);
64	25		$data = $this->adapter->select($parameters);
65	25		$this->wrapper->setData($data);
66	25		$this->resetQueryParameters();
67	25		return $this->wrapper;
68			}
69
70	27		private function getFetchQueryParameters($arg, $instantiate = true) {
71	27		if ($arg instanceof \ntentan\nibii\QueryParameters) {
72	12		return $arg;
73			}
74
75	27		$parameters = $this->getQueryParameters($instantiate);
76
77	27		if (is_numeric($arg)) {
78	6		$description = $this->wrapper->getDescription();
79	6		$parameters->addFilter($description->getPrimaryKey()[0], $arg);
80	6		$parameters->setFirstOnly(true);
81	23		} else if (is_array($arg)) {
82	6		foreach ($arg as $field => $value) {
83	6		$parameters->addFilter($field, $value);
84			}
85			}
86
87	27		return $parameters;
88			}
89
90			/**
91			*
92			* @return \ntentan\nibii\QueryParameters
93			*/
94	33		private function getQueryParameters($instantiate = true) {
95	33		if ($this->queryParameters === null && $instantiate) {
96	33		$this->queryParameters = new QueryParameters($this->wrapper->getDBStoreInformation()['quoted_table']);
97			}
98	33		return $this->queryParameters;
99			}
100
101	33		private function resetQueryParameters() {
102	33		$this->queryParameters = null;
103	33		}
104
105	10		public function doFetchFirst($id = null) {
106	10		$this->getQueryParameters()->setFirstOnly(true);
107	10		return $this->doFetch($id);
108			}
109
110	12		public function doFields() {
111	12		$fields = [];
112	12		$arguments = func_get_args();
113	12		foreach ($arguments as $argument) {
114	12		if (is_array($argument)) {
115	6		$fields = array_merge($fields, $argument);
116			} else {
117	6		$fields[] = $argument;
118			}
119			}
120	12		$this->getQueryParameters()->setFields($fields);
121	12		return $this->wrapper;
122			}
123
124			public function doSortBy($field, $direction = 'ASC') {
125			$this->getQueryParameters()->addSort($field, $direction);
126			}
127
128	10		private function getFilter($arguments) {
129	10		if (count($arguments) == 2 && is_array($arguments[1])) {
130	2		$filter = $arguments[0];
131	2		$data = $arguments[1];
132			} else {
133	10		$filter = array_shift($arguments);
134	10		$data = $arguments;
135			}
136	10		return ['filter' => $filter, 'data' => $data];
137			}
138
139	6	View Code Duplication	public function doFilter() {
			0 ignored issues – show Duplication introduced 2017-06-19 17:30 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...
140	6		$arguments = func_get_args();
141	6		$details = $this->getFilter($arguments);
142	6		$this->getQueryParameters()->setFilter($details['filter'], $details['data']);
143	6		return $this->wrapper;
144			}
145
146	4	View Code Duplication	public function doFilterBy() {
			0 ignored issues – show Duplication introduced 2017-06-19 17:30 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...
147	4		$arguments = func_get_args();
148	4		$details = $this->getFilter($arguments);
149	4		$this->getQueryParameters()->addFilter($details['filter'], $details['data']);
150	4		return $this->wrapper;
151			}
152
153	6		public function doUpdate($data) {
154	6		$this->driver->beginTransaction();
155	6		$parameters = $this->getQueryParameters();
156	6		$this->adapter->bulkUpdate($data, $parameters);
157	6		$this->driver->commit();
158	6		$this->resetQueryParameters();
159	6		}
160
161	2		public function doDelete($args = null) {
162	2		$this->driver->beginTransaction();
163	2		$parameters = $this->getFetchQueryParameters($args);
164
165	2		if ($parameters === null) {
166			$primaryKey = $this->wrapper->getDescription()->getPrimaryKey();
167			$parameters = $this->getQueryParameters();
168			$data = $this->wrapper->getData();
169			$keys = [];
170
171			foreach ($data as $datum) {
172			if ($this->dataOperations->isItemDeletable($primaryKey, $datum)) {
173			$keys[] = $datum[$primaryKey[0]];
174			}
175			}
176
177			$parameters->addFilter($primaryKey[0], $keys);
178			$this->adapter->delete($parameters);
179			} else {
180	2		$this->adapter->delete($parameters);
181			}
182
183	2		$this->driver->commit();
184	2		$this->resetQueryParameters();
185	2		}
186
187	10		public function runDynamicMethod($arguments) {
188	10		$arguments = count($arguments) > 1 ? $arguments : $arguments[0];
189	10		switch ($this->pendingMethod['method']) {
190	10		case 'filterBy':
191	4		$this->getQueryParameters()->addFilter(Text::deCamelize($this->pendingMethod['variable']), $arguments);
192	4		return $this->wrapper;
193	8		case 'sort':
194			$this->getQueryParameters()->addSort(Text::deCamelize($this->pendingMethod['variable']), $this->pendingMethod['direction']);
195			return $this->wrapper;
196	8		case 'fetch':
197	8		$parameters = $this->getQueryParameters();
198	8		$parameters->addFilter(Text::deCamelize($this->pendingMethod['variable']), $arguments);
199	8		if ($this->pendingMethod['first'] === 'First') {
200	8		$parameters->setFirstOnly(true);
201			}
202	8		return $this->doFetch();
203			}
204			}
205
206	10		public function initDynamicMethod($method) {
207	10		$return = false;
208
209	10		foreach ($this->dynamicMethods as $regexp) {
210	10		if (preg_match($regexp, $method, $matches)) {
211	10		$return = true;
212	10		$this->pendingMethod = $matches;
213	10		break;
214			}
215			}
216
217	10		return $return;
218			}
219
220			public function doCount() {
			0 ignored issues – show Documentation introduced 2015-11-24 20:03 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
221			return $this->adapter->count($this->getQueryParameters());
222			}
223
224			public function doLimit($numItems) {
225			$this->getQueryParameters()->setLimit($numItems);
226			return $this->wrapper;
227			}
228
229			public function doOffset($offset) {
230			$this->getQueryParameters()->setOffset($offset);
231			return $this->wrapper;
232			}
233
234			public function doWith($model) {
			0 ignored issues – show Documentation introduced 2017-05-21 02:04 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
235			$relationship = $this->wrapper->getDescription()->getRelationships()[$model];
236			return $relationship->getQuery();
237			}
238
239			}
240

ntentan / nibii

Push — master ( 7f591d...75938c )

QueryOperations::getFetchQueryParameters() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like