ApiDomainTrait::paginate() - Code Metrics - Inspection of "generated domain popos" - keeko/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b30b3b...5895ce )

by Thomas

created 2016-04-08 15:27 UTC

ApiDomainTrait::paginate() B

↳ Parent: ApiDomainTrait

Complexity

Conditions	3
Paths	4

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	27
rs	8.8571
cc	3
eloc	15
nc	4
nop	1

<?php
namespace keeko\core\domain\base;

use keeko\core\model\Api;
use keeko\core\model\ApiQuery;
use keeko\framework\service\ServiceContainer;
use keeko\framework\domain\payload\Found;
use keeko\framework\domain\payload\NotFound;
use Tobscure\JsonApi\Parameters;
use keeko\framework\utils\NameUtils;
use keeko\framework\domain\payload\Created;
use keeko\framework\domain\payload\Updated;
use keeko\framework\domain\payload\NotUpdated;
use keeko\framework\domain\payload\NotValid;
use keeko\framework\domain\payload\Deleted;
use keeko\framework\domain\payload\NotDeleted;

/**
 */
trait ApiDomainTrait {

	/**
	 * @param mixed $data
	 */
	public function create($data) {
		// hydrate
		$serializer = Api::getSerializer();
		$api = $serializer->hydrate(new Api(), $data);

		// validate
		if (!$api->validate()) {
			return new NotValid([
				'errors' => $api->getValidationFailures()
			]);
		}

		$api->save();
		return new Created(['model' => $api]);
	}

	/**
	 * @param mixed $id
	 */
	public function delete($id) {
		// find
		$api = ApiQuery::create()->findOneById($id);

		if ($api === null) {
			return new NotFound(['message' => 'Api not found.']);
		}

		// delete
		$api->delete();
		$payload = ['model' => $api];

		if ($api->isDeleted()) {
			return new Deleted($payload);
		}

		return new NotDeleted($payload);
	}

	/**
	 * @param Parameters $params
	 */
	public function paginate(Parameters $params) {
		$sysPrefs = $this->getServiceContainer()->getPreferenceLoader()->getSystemPreferences();
		$defaultSize = $sysPrefs->getPaginationSize();
		$page = $params->getPage('number');

		$size = $params->getPage('size', $defaultSize);


		$query = ApiQuery::create();

		// sorting
		$sort = $params->getSort(Api::getSerializer()->getSortFields());
		foreach ($sort as $field => $order) {
			$method = 'orderBy' . NameUtils::toStudlyCase($field);
			$query->$method($order);
		}

		// filtering
		$filter = $params->getFilter();
		if (!empty($filter)) {
			$this->applyFilter($query, $filter);

		}

		// paginate
		$api = $query->paginate($page, $size);

		// run response
		return new Found(['model' => $api]);
	}

	/**
	 * @param mixed $id
	 */
	public function read($id) {
		// read
		$api = ApiQuery::create()->findOneById($id);

		// check existence
		if ($api === null) {
			$payload = new NotFound(['message' => 'Api not found.']);
		} else {
			$payload = new Found(['model' => $api]);
		}

		// run response
		return $payload;
	}

	/**
	 * @param mixed $id
	 * @param mixed $data
	 */
	public function update($id, $data) {
		// find
		$api = ApiQuery::create()->findOneById($id);

		if ($api === null) {
			return new NotFound(['message' => 'Api not found.']);
		}

		// hydrate
		$serializer = Api::getSerializer();
		$api = $serializer->hydrate($api, $data);

		// validate
		if (!$api->validate()) {
			return new NotValid([
				'errors' => $api->getValidationFailures()
			]);
		}

		$rows = $api->save();
		$payload = ['model' => $api];

		if ($rows === 0) {
			return new NotUpdated($payload);
		}

		return new Updated($payload);
	}

	/**
	 * Implement this functionality at keeko\core\domain\ApiDomain
	 * 
	 * @param ApiQuery $query
	 */
	abstract protected function applyFilter(ApiQuery $query);


	/**
	 * Returns the service container
	 * 
	 * @return ServiceContainer
	 */
	abstract protected function getServiceContainer();
}


1			<?php
2			namespace keeko\core\domain\base;
3
4			use keeko\core\model\Api;
5			use keeko\core\model\ApiQuery;
6			use keeko\framework\service\ServiceContainer;
7			use keeko\framework\domain\payload\Found;
8			use keeko\framework\domain\payload\NotFound;
9			use Tobscure\JsonApi\Parameters;
10			use keeko\framework\utils\NameUtils;
11			use keeko\framework\domain\payload\Created;
12			use keeko\framework\domain\payload\Updated;
13			use keeko\framework\domain\payload\NotUpdated;
14			use keeko\framework\domain\payload\NotValid;
15			use keeko\framework\domain\payload\Deleted;
16			use keeko\framework\domain\payload\NotDeleted;
17
18			/**
19			*/
20			trait ApiDomainTrait {
21
22			/**
23			* @param mixed $data
24			*/
25			public function create($data) {
26			// hydrate
27			$serializer = Api::getSerializer();
28			$api = $serializer->hydrate(new Api(), $data);
29
30			// validate
31			if (!$api->validate()) {
32			return new NotValid([
33			'errors' => $api->getValidationFailures()
34			]);
35			}
36
37			$api->save();
38			return new Created(['model' => $api]);
39			}
40
41			/**
42			* @param mixed $id
43			*/
44			public function delete($id) {
45			// find
46			$api = ApiQuery::create()->findOneById($id);
47
48			if ($api === null) {
49			return new NotFound(['message' => 'Api not found.']);
50			}
51
52			// delete
53			$api->delete();
54			$payload = ['model' => $api];
55
56			if ($api->isDeleted()) {
57			return new Deleted($payload);
58			}
59
60			return new NotDeleted($payload);
61			}
62
63			/**
64			* @param Parameters $params
65			*/
66			public function paginate(Parameters $params) {
67			$sysPrefs = $this->getServiceContainer()->getPreferenceLoader()->getSystemPreferences();
68			$defaultSize = $sysPrefs->getPaginationSize();
69			$page = $params->getPage('number');
			0 ignored issues – show Bug introduced 2016-04-08 15:36 UTC by Report Bug Copy Issue Report The method `getPage()` cannot be called from this context as it is declared protected in class `Tobscure\JsonApi\Parameters`. This check looks for access to methods that are not accessible from the current context. If you need to make a method accessible to another context you can raise its visibility level in the defining class. Loading history...
70			$size = $params->getPage('size', $defaultSize);
			0 ignored issues – show Bug introduced 2016-04-08 15:36 UTC by Report Bug Copy Issue Report The method `getPage()` cannot be called from this context as it is declared protected in class `Tobscure\JsonApi\Parameters`. This check looks for access to methods that are not accessible from the current context. If you need to make a method accessible to another context you can raise its visibility level in the defining class. Loading history... Unused Code introduced 2016-04-08 15:36 UTC by Report Bug Copy Issue Report The call to `Parameters::getPage()` has too many arguments starting with `$defaultSize`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
71
72			$query = ApiQuery::create();
73
74			// sorting
75			$sort = $params->getSort(Api::getSerializer()->getSortFields());
76			foreach ($sort as $field => $order) {
77			$method = 'orderBy' . NameUtils::toStudlyCase($field);
78			$query->$method($order);
79			}
80
81			// filtering
82			$filter = $params->getFilter();
83			if (!empty($filter)) {
84			$this->applyFilter($query, $filter);
			0 ignored issues – show Unused Code introduced 2016-04-08 15:36 UTC by Report Bug Copy Issue Report The call to `ApiDomainTrait::applyFilter()` has too many arguments starting with `$filter`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
85			}
86
87			// paginate
88			$api = $query->paginate($page, $size);
89
90			// run response
91			return new Found(['model' => $api]);
92			}
93
94			/**
95			* @param mixed $id
96			*/
97			public function read($id) {
98			// read
99			$api = ApiQuery::create()->findOneById($id);
100
101			// check existence
102			if ($api === null) {
103			$payload = new NotFound(['message' => 'Api not found.']);
104			} else {
105			$payload = new Found(['model' => $api]);
106			}
107
108			// run response
109			return $payload;
110			}
111
112			/**
113			* @param mixed $id
114			* @param mixed $data
115			*/
116			public function update($id, $data) {
117			// find
118			$api = ApiQuery::create()->findOneById($id);
119
120			if ($api === null) {
121			return new NotFound(['message' => 'Api not found.']);
122			}
123
124			// hydrate
125			$serializer = Api::getSerializer();
126			$api = $serializer->hydrate($api, $data);
127
128			// validate
129			if (!$api->validate()) {
130			return new NotValid([
131			'errors' => $api->getValidationFailures()
132			]);
133			}
134
135			$rows = $api->save();
136			$payload = ['model' => $api];
137
138			if ($rows === 0) {
139			return new NotUpdated($payload);
140			}
141
142			return new Updated($payload);
143			}
144
145			/**
146			* Implement this functionality at keeko\core\domain\ApiDomain
147			*
148			* @param ApiQuery $query
149			*/
150			abstract protected function applyFilter(ApiQuery $query);
			0 ignored issues – show Documentation introduced 2016-04-08 15:36 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
151
152			/**
153			* Returns the service container
154			*
155			* @return ServiceContainer
156			*/
157			abstract protected function getServiceContainer();
158			}
159

keeko / core

Push — master ( b30b3b...5895ce )

ApiDomainTrait::paginate() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like