ActivityDomainTrait::setObjectId() - Code Metrics - Inspection of "add newly generated code with relationship refacto..." - keeko/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 944dfb...9c93d5 )

by Thomas

created 2016-04-19 14:36 UTC

ActivityDomainTrait::setObjectId() A

↳ Parent: ActivityDomainTrait

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	17
rs	9.4285
cc	3
eloc	9
nc	3
nop	2

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

use keeko\core\model\Activity;
use keeko\core\model\ActivityQuery;
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 ActivityDomainTrait {

	/**
	 */
	protected $pool;

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

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

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

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

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

		// delete
		$activity->delete();

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

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

	/**
	 * 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 = ActivityQuery::create();

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

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

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

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

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

	/**
	 * Sets the User id
	 * 
	 * @param mixed $id
	 * @param mixed $actorId
	 * @return PayloadInterface
	 */
	public function setActorId($id, $actorId) {
		// find
		$activity = $this->get($id);

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

		// update
		if ($activity->getActorId() !== $actorId) {
			$activity->setActorId($actorId);
			$activity->save();
			return Updated(['model' => $activity]);
		}

		return NotUpdated(['model' => $activity]);
	}

	/**
	 * Sets the ActivityObject id
	 * 
	 * @param mixed $id
	 * @param mixed $targetId
	 * @return PayloadInterface
	 */
	public function setTargetId($id, $targetId) {
		// find
		$activity = $this->get($id);

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

		// update
		if ($activity->getTargetId() !== $targetId) {
			$activity->setTargetId($targetId);
			$activity->save();
			return Updated(['model' => $activity]);
		}

		return NotUpdated(['model' => $activity]);
	}

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

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

		// hydrate
		$serializer = Activity::getSerializer();
		$activity = $serializer->hydrate($activity, $data);

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

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

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

		return new Updated($payload);
	}

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


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

		$activity = ActivityQuery::create()->findOneById($id);
		$this->pool->set($id, $activity);

		return $activity;
	}

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


1			<?php
2			namespace keeko\core\domain\base;
3
4			use keeko\core\model\Activity;
5			use keeko\core\model\ActivityQuery;
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 ActivityDomainTrait {
23
24			/**
25			*/
26			protected $pool;
27
28			/**
29			* Creates a new Activity with the provided data
30			*
31			* @param mixed $data
32			* @return PayloadInterface
33			*/
34			public function create($data) {
35			// hydrate
36			$serializer = Activity::getSerializer();
37			$activity = $serializer->hydrate(new Activity(), $data);
38
39			// validate
40			if (!$activity->validate()) {
41			return new NotValid([
42			'errors' => $activity->getValidationFailures()
43			]);
44			}
45
46			$activity->save();
47			return new Created(['model' => $activity]);
48			}
49
50			/**
51			* Deletes a Activity with the given id
52			*
53			* @param mixed $id
54			* @return PayloadInterface
55			*/
56			public function delete($id) {
57			// find
58			$activity = $this->get($id);
59
60			if ($activity === null) {
61			return new NotFound(['message' => 'Activity not found.']);
62			}
63
64			// delete
65			$activity->delete();
66
67			if ($activity->isDeleted()) {
68			return new Deleted(['model' => $activity]);
69			}
70
71			return new NotDeleted(['message' => 'Could not delete Activity']);
72			}
73
74			/**
75			* Returns a paginated result
76			*
77			* @param Parameters $params
78			* @return PayloadInterface
79			*/
80			public function paginate(Parameters $params) {
81			$sysPrefs = $this->getServiceContainer()->getPreferenceLoader()->getSystemPreferences();
82			$defaultSize = $sysPrefs->getPaginationSize();
83			$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...
84			$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...
85
86			$query = ActivityQuery::create();
87
88			// sorting
89			$sort = $params->getSort(Activity::getSerializer()->getSortFields());
90			foreach ($sort as $field => $order) {
91			$method = 'orderBy' . NameUtils::toStudlyCase($field);
92			$query->$method($order);
93			}
94
95			// filtering
96			$filter = $params->getFilter();
97			if (!empty($filter)) {
98			$this->applyFilter($query, $filter);
99			}
100
101			// paginate
102			$activity = $query->paginate($page, $size);
103
104			// run response
105			return new Found(['model' => $activity]);
106			}
107
108			/**
109			* Returns one Activity with the given id
110			*
111			* @param mixed $id
112			* @return PayloadInterface
113			*/
114			public function read($id) {
115			// read
116			$activity = $this->get($id);
117
118			// check existence
119			if ($activity === null) {
120			return new NotFound(['message' => 'Activity not found.']);
121			}
122
123			return new Found(['model' => $activity]);
124			}
125
126			/**
127			* Sets the User id
128			*
129			* @param mixed $id
130			* @param mixed $actorId
131			* @return PayloadInterface
132			*/
133			public function setActorId($id, $actorId) {
134			// find
135			$activity = $this->get($id);
136
137			if ($activity === null) {
138			return new NotFound(['message' => 'Activity not found.']);
139			}
140
141			// update
142			if ($activity->getActorId() !== $actorId) {
143			$activity->setActorId($actorId);
144			$activity->save();
145			return Updated(['model' => $activity]);
146			}
147
148			return NotUpdated(['model' => $activity]);
149			}
150
151			/**
152			* Sets the ActivityObject id
153			*
154			* @param mixed $id
155			* @param mixed $targetId
156			* @return PayloadInterface
157			*/
158			public function setTargetId($id, $targetId) {
159			// find
160			$activity = $this->get($id);
161
162			if ($activity === null) {
163			return new NotFound(['message' => 'Activity not found.']);
164			}
165
166			// update
167			if ($activity->getTargetId() !== $targetId) {
168			$activity->setTargetId($targetId);
169			$activity->save();
170			return Updated(['model' => $activity]);
171			}
172
173			return NotUpdated(['model' => $activity]);
174			}
175
176			/**
177			* Updates a Activity with the given idand the provided data
178			*
179			* @param mixed $id
180			* @param mixed $data
181			* @return PayloadInterface
182			*/
183			public function update($id, $data) {
184			// find
185			$activity = $this->get($id);
186
187			if ($activity === null) {
188			return new NotFound(['message' => 'Activity not found.']);
189			}
190
191			// hydrate
192			$serializer = Activity::getSerializer();
193			$activity = $serializer->hydrate($activity, $data);
194
195			// validate
196			if (!$activity->validate()) {
197			return new NotValid([
198			'errors' => $activity->getValidationFailures()
199			]);
200			}
201
202			$rows = $activity->save();
203			$payload = ['model' => $activity];
204
205			if ($rows === 0) {
206			return new NotUpdated($payload);
207			}
208
209			return new Updated($payload);
210			}
211
212			/**
213			* Implement this functionality at keeko\core\domain\ActivityDomain
214			*
215			* @param ActivityQuery $query
216			* @param mixed $filter
217			*/
218			abstract protected function applyFilter(ActivityQuery $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...
219
220			/**
221			* Returns one Activity with the given id from cache
222			*
223			* @param mixed $id
224			* @return Activity\|null
225			*/
226			protected function get($id) {
227			if ($this->pool === null) {
228			$this->pool = new Map();
229			} else if ($this->pool->has($id)) {
230			return $this->pool->get($id);
231			}
232
233			$activity = ActivityQuery::create()->findOneById($id);
234			$this->pool->set($id, $activity);
235
236			return $activity;
237			}
238
239			/**
240			* Returns the service container
241			*
242			* @return ServiceContainer
243			*/
244			abstract protected function getServiceContainer();
245			}
246

keeko / core

Push — master ( 944dfb...9c93d5 )

ActivityDomainTrait::setObjectId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like