ApiSerializerTrait::getRelationships() - Code Metrics - Inspection of "moved serializer to own root package" - keeko/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a7ae23...b30b3b )

by Thomas

created 2016-03-09 15:46 UTC

ApiSerializerTrait::getRelationships() A

↳ Parent: ApiSerializerTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

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

use keeko\framework\utils\HydrateUtils;
use Tobscure\JsonApi\Relationship;
use keeko\core\model\Action;
use Tobscure\JsonApi\Resource;

/**
 */
trait ApiSerializerTrait {

	/**
	 * @param mixed $model
	 * @param mixed $related
	 */
	public function action($model, $related) {

		$serializer = Action::getSerializer();
		$relationship = new Relationship(new Resource($model->getAction(), $serializer));
		$relationship->setLinks([
			'related' => '%apiurl%' . $serializer->getType(null) . '/' . $serializer->getId($model)
		]);
		return $this->addRelationshipSelfLink($relationship, $model, $related);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
	}

	/**
	 * @param mixed $model
	 * @param array $fields
	 */
	public function getAttributes($model, array $fields = null) {

		return [
			'id' => $model->Id(),
			'route' => $model->Route(),
			'method' => $model->Method(),
			'action_id' => $model->ActionId(),
			'required_params' => $model->RequiredParams(),
		];
	}

	/**
	 */
	public function getFields() {
		return ['id', 'route', 'method', 'action_id', 'required_params'];
	}

	/**
	 * @param mixed $model
	 */
	public function getId($model) {

		return $model->getId();
	}

	/**
	 */
	public function getRelationships() {
		return [
			'action' => Action::getSerializer()->getType(null)
		];
	}

	/**
	 */
	public function getSortFields() {
		return ['id', 'route', 'method', 'action_id', 'required_params'];
	}

	/**
	 * @param mixed $model
	 */
	public function getType($model) {

		return 'core/api';
	}

	/**
	 * @param mixed $model
	 * @param mixed $data
	 */
	public function hydrate($model, $data) {

		// attributes
		$attribs = isset($data['attributes']) ? $data['attributes'] : [];

		$model = HydrateUtils::hydrate($attribs, $model, ['id', 'route', 'method', 'action_id', 'required_params']);

		// relationships
		$this->hydrateRelationships($model, $data);


		return $model;
	}

	/**
	 * @param mixed $model
	 * @param mixed $data
	 */
	public function setAction($model, $data) {
		$model->setActionId($data['id']);
	}
}


1			<?php
2			namespace keeko\core\serializer\base;
3
4			use keeko\framework\utils\HydrateUtils;
5			use Tobscure\JsonApi\Relationship;
6			use keeko\core\model\Action;
7			use Tobscure\JsonApi\Resource;
8
9			/**
10			*/
11			trait ApiSerializerTrait {
12
13			/**
14			* @param mixed $model
15			* @param mixed $related
16			*/
17			public function action($model, $related) {
			0 ignored issues – show Documentation introduced 2016-03-09 15:56 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...
18			$serializer = Action::getSerializer();
19			$relationship = new Relationship(new Resource($model->getAction(), $serializer));
20			$relationship->setLinks([
21			'related' => '%apiurl%' . $serializer->getType(null) . '/' . $serializer->getId($model)
22			]);
23			return $this->addRelationshipSelfLink($relationship, $model, $related);
			0 ignored issues – show Bug introduced 2016-03-09 15:56 UTC by Report Bug Copy Issue Report It seems like `addRelationshipSelfLink()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
24			}
25
26			/**
27			* @param mixed $model
28			* @param array $fields
29			*/
30			public function getAttributes($model, array $fields = null) {
			1 ignored issue – show Unused Code introduced 2016-03-09 15:56 UTC by Report Bug Copy Issue Report The parameter `$fields` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
31			return [
32			'id' => $model->Id(),
33			'route' => $model->Route(),
34			'method' => $model->Method(),
35			'action_id' => $model->ActionId(),
36			'required_params' => $model->RequiredParams(),
37			];
38			}
39
40			/**
41			*/
42			public function getFields() {
43			return ['id', 'route', 'method', 'action_id', 'required_params'];
44			}
45
46			/**
47			* @param mixed $model
48			*/
49			public function getId($model) {
			0 ignored issues – show Documentation introduced 2016-03-09 15:56 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...
50			return $model->getId();
51			}
52
53			/**
54			*/
55			public function getRelationships() {
56			return [
57			'action' => Action::getSerializer()->getType(null)
58			];
59			}
60
61			/**
62			*/
63			public function getSortFields() {
64			return ['id', 'route', 'method', 'action_id', 'required_params'];
65			}
66
67			/**
68			* @param mixed $model
69			*/
70			public function getType($model) {
			1 ignored issue – show Unused Code introduced 2016-03-09 15:56 UTC by Report Bug Copy Issue Report The parameter `$model` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
71			return 'core/api';
72			}
73
74			/**
75			* @param mixed $model
76			* @param mixed $data
77			*/
78			public function hydrate($model, $data) {
			0 ignored issues – show Documentation introduced 2016-03-09 15:56 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...
79			// attributes
80			$attribs = isset($data['attributes']) ? $data['attributes'] : [];
81
82			$model = HydrateUtils::hydrate($attribs, $model, ['id', 'route', 'method', 'action_id', 'required_params']);
83
84			// relationships
85			$this->hydrateRelationships($model, $data);
			0 ignored issues – show Bug introduced 2016-03-09 15:56 UTC by Report Bug Copy Issue Report The method `hydrateRelationships()` does not exist on `keeko\core\serializer\base\ApiSerializerTrait`. Did you maybe mean `hydrate()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
86
87			return $model;
88			}
89
90			/**
91			* @param mixed $model
92			* @param mixed $data
93			*/
94			public function setAction($model, $data) {
95			$model->setActionId($data['id']);
96			}
97			}
98

keeko / core

Push — master ( a7ae23...b30b3b )

ApiSerializerTrait::getRelationships() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like