ModuleDomainTrait::create() - Code Metrics - Inspection of "keeko magic (2)" - keeko/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f579b8...c5e777 )

by Thomas

created 2016-04-18 22:38 UTC

ModuleDomainTrait::create() A

↳ Parent: ModuleDomainTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	15
rs	9.4285
cc	2
eloc	8
nc	2
nop	1

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

use keeko\core\model\Module;
use keeko\core\model\ModuleQuery;
use keeko\framework\service\ServiceContainer;
use keeko\framework\domain\payload\PayloadInterface;
use phootwork\collection\Map;
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 ModuleDomainTrait {

	/**
	 * Creates a new Module with the provided data
	 * 
	 * @param mixed $data
	 * @return PayloadInterface
	 */
	public function create($data) {
		// hydrate
		$serializer = Module::getSerializer();
		$module = $serializer->hydrate(new Module(), $data);

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

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

	/**
	 * Deletes a Module with the given id
	 * 
	 * @param mixed $id
	 * @return PayloadInterface
	 */
	public function delete($id) {
		// find
		$module = $this->get($id);

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

		// delete
		$module->delete();

		if ($module->isDeleted()) {
			return new Deleted(['model' => $module]);
		}

		return new NotDeleted(['message' => 'Could not delete Module']);
	}

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

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


		$query = ModuleQuery::create();

		// sorting
		$sort = $params->getSort(Module::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
		$module = $query->paginate($page, $size);

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

	/**
	 * Returns one Module with the given id
	 * 
	 * @param mixed $id
	 * @return PayloadInterface
	 */
	public function read($id) {
		// read
		$module = $this->get($id);

		// check existence
		if ($module === null) {
			return new NotFound(['message' => 'Module not found.']);
		}

		return new Found(['model' => $module]);
	}

	/**
	 * Updates a Module with the given idand the provided data
	 * 
	 * @param mixed $id
	 * @param mixed $data
	 * @return PayloadInterface
	 */
	public function update($id, $data) {
		// find
		$module = $this->get($id);

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

		// hydrate
		$serializer = Module::getSerializer();
		$module = $serializer->hydrate($module, $data);

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

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

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

		return new Updated($payload);
	}

	/**
	 * Implement this functionality at keeko\core\domain\ModuleDomain
	 * 
	 * @param ModuleQuery $query
	 * @param mixed $filter
	 */
	abstract protected function applyFilter(ModuleQuery $query, $filter);


	/**
	 * Returns one Module with the given id from cache
	 * 
	 * @param mixed $id
	 * @return Module|null
	 */
	protected function get($id) {
		if ($this->pool === null) {
			$this->pool = new Map();
class MyClass { }

$x = new MyClass();
$x->foo = true;
		} else if ($this->pool->has($id)) {
			return $this->pool->get($id);
		}

		$module = ModuleQuery::create()->findOneById($id);
		$this->pool->set($id, $module);

		return $module;
	}

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


1			<?php
2			namespace keeko\core\domain\base;
3
4			use keeko\core\model\Module;
5			use keeko\core\model\ModuleQuery;
6			use keeko\framework\service\ServiceContainer;
7			use keeko\framework\domain\payload\PayloadInterface;
8			use phootwork\collection\Map;
9			use keeko\framework\domain\payload\Found;
10			use keeko\framework\domain\payload\NotFound;
11			use Tobscure\JsonApi\Parameters;
12			use keeko\framework\utils\NameUtils;
13			use keeko\framework\domain\payload\Created;
14			use keeko\framework\domain\payload\Updated;
15			use keeko\framework\domain\payload\NotUpdated;
16			use keeko\framework\domain\payload\NotValid;
17			use keeko\framework\domain\payload\Deleted;
18			use keeko\framework\domain\payload\NotDeleted;
19
20			/**
21			*/
22			trait ModuleDomainTrait {
23
24			/**
25			* Creates a new Module with the provided data
26			*
27			* @param mixed $data
28			* @return PayloadInterface
29			*/
30			public function create($data) {
31			// hydrate
32			$serializer = Module::getSerializer();
33			$module = $serializer->hydrate(new Module(), $data);
34
35			// validate
36			if (!$module->validate()) {
37			return new NotValid([
38			'errors' => $module->getValidationFailures()
39			]);
40			}
41
42			$module->save();
43			return new Created(['model' => $module]);
44			}
45
46			/**
47			* Deletes a Module with the given id
48			*
49			* @param mixed $id
50			* @return PayloadInterface
51			*/
52			public function delete($id) {
53			// find
54			$module = $this->get($id);
55
56			if ($module === null) {
57			return new NotFound(['message' => 'Module not found.']);
58			}
59
60			// delete
61			$module->delete();
62
63			if ($module->isDeleted()) {
64			return new Deleted(['model' => $module]);
65			}
66
67			return new NotDeleted(['message' => 'Could not delete Module']);
68			}
69
70			/**
71			* Returns a paginated result
72			*
73			* @param Parameters $params
74			* @return PayloadInterface
75			*/
76			public function paginate(Parameters $params) {
77			$sysPrefs = $this->getServiceContainer()->getPreferenceLoader()->getSystemPreferences();
78			$defaultSize = $sysPrefs->getPaginationSize();
79			$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...
80			$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...
81
82			$query = ModuleQuery::create();
83
84			// sorting
85			$sort = $params->getSort(Module::getSerializer()->getSortFields());
86			foreach ($sort as $field => $order) {
87			$method = 'orderBy' . NameUtils::toStudlyCase($field);
88			$query->$method($order);
89			}
90
91			// filtering
92			$filter = $params->getFilter();
93			if (!empty($filter)) {
94			$this->applyFilter($query, $filter);
95			}
96
97			// paginate
98			$module = $query->paginate($page, $size);
99
100			// run response
101			return new Found(['model' => $module]);
102			}
103
104			/**
105			* Returns one Module with the given id
106			*
107			* @param mixed $id
108			* @return PayloadInterface
109			*/
110			public function read($id) {
111			// read
112			$module = $this->get($id);
113
114			// check existence
115			if ($module === null) {
116			return new NotFound(['message' => 'Module not found.']);
117			}
118
119			return new Found(['model' => $module]);
120			}
121
122			/**
123			* Updates a Module with the given idand the provided data
124			*
125			* @param mixed $id
126			* @param mixed $data
127			* @return PayloadInterface
128			*/
129			public function update($id, $data) {
130			// find
131			$module = $this->get($id);
132
133			if ($module === null) {
134			return new NotFound(['message' => 'Module not found.']);
135			}
136
137			// hydrate
138			$serializer = Module::getSerializer();
139			$module = $serializer->hydrate($module, $data);
140
141			// validate
142			if (!$module->validate()) {
143			return new NotValid([
144			'errors' => $module->getValidationFailures()
145			]);
146			}
147
148			$rows = $module->save();
149			$payload = ['model' => $module];
150
151			if ($rows === 0) {
152			return new NotUpdated($payload);
153			}
154
155			return new Updated($payload);
156			}
157
158			/**
159			* Implement this functionality at keeko\core\domain\ModuleDomain
160			*
161			* @param ModuleQuery $query
162			* @param mixed $filter
163			*/
164			abstract protected function applyFilter(ModuleQuery $query, $filter);
			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...
165
166			/**
167			* Returns one Module with the given id from cache
168			*
169			* @param mixed $id
170			* @return Module\|null
171			*/
172			protected function get($id) {
173			if ($this->pool === null) {
174			$this->pool = new Map();
			0 ignored issues – show Bug introduced 2016-04-14 19:00 UTC by Report Bug Copy Issue Report The property `pool` 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...
175			} else if ($this->pool->has($id)) {
176			return $this->pool->get($id);
177			}
178
179			$module = ModuleQuery::create()->findOneById($id);
180			$this->pool->set($id, $module);
181
182			return $module;
183			}
184
185			/**
186			* Returns the service container
187			*
188			* @return ServiceContainer
189			*/
190			abstract protected function getServiceContainer();
191			}
192

keeko / core

Push — master ( f579b8...c5e777 )

ModuleDomainTrait::create() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like