ActionSerializerTrait::group() - 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

ActionSerializerTrait::group() A

↳ Parent: ActionSerializerTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	3
nc	1
nop	1

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

use keeko\framework\utils\HydrateUtils;
use Tobscure\JsonApi\Relationship;
use keeko\core\model\Module;
use Tobscure\JsonApi\Resource;
use keeko\core\model\Group;
use Tobscure\JsonApi\Collection;

/**
 */
trait ActionSerializerTrait {

	/**
	 * @param mixed $model
	 * @param array $fields
	 */
	public function getAttributes($model, array $fields = null) {
		return [
			'id' => $model->getId(),
			'name' => $model->getName(),
			'title' => $model->getTitle(),
			'description' => $model->getDescription(),
			'class_name' => $model->getClassName(),
			'module_id' => $model->getModuleId(),
		];
	}

	/**
	 */
	public function getFields() {
		return ['id', 'name', 'title', 'description', 'class_name', 'module_id'];
	}

	/**
	 * @param mixed $model
	 * @return string
	 */
	public function getId($model) {
		return $model->getId();
	}

	/**
	 */
	public function getRelationships() {
		return [
			'module' => Module::getSerializer()->getType(null),
			'groups' => Group::getSerializer()->getType(null)
		];
	}

	/**
	 */
	public function getSortFields() {
		return ['id', 'name', 'title', 'description', 'class_name', 'module_id'];
	}

	/**
	 * @param mixed $model
	 * @return string
	 */
	public function getType($model) {
		return 'core/action';
	}

	/**
	 * @param mixed $model
	 * @return Relationship
	 */
	public function groups($model) {
		$relationship = new Relationship(new Collection($model->getGroups(), Group::getSerializer()));
		return $this->addRelationshipSelfLink($relationship, $model, 'groups');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
	}

	/**
	 * @param mixed $model
	 * @param mixed $data
	 * @return mixed The model
	 */
	public function hydrate($model, $data) {
		// attributes
		$attribs = isset($data['attributes']) ? $data['attributes'] : [];

		$model = HydrateUtils::hydrate($attribs, $model, ['id', 'name', 'title', 'description', 'class_name', 'module_id']);

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

		return $model;
	}

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

	/**
	 * @param mixed $model
	 * @param mixed $data
	 */
	abstract protected function hydrateRelationships($model, $data);

}


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\Module;
7			use Tobscure\JsonApi\Resource;
8			use keeko\core\model\Group;
9			use Tobscure\JsonApi\Collection;
10
11			/**
12			*/
13			trait ActionSerializerTrait {
14
15			/**
16			* @param mixed $model
17			* @param array $fields
18			*/
19			public function getAttributes($model, array $fields = null) {
20			return [
21			'id' => $model->getId(),
22			'name' => $model->getName(),
23			'title' => $model->getTitle(),
24			'description' => $model->getDescription(),
25			'class_name' => $model->getClassName(),
26			'module_id' => $model->getModuleId(),
27			];
28			}
29
30			/**
31			*/
32			public function getFields() {
33			return ['id', 'name', 'title', 'description', 'class_name', 'module_id'];
34			}
35
36			/**
37			* @param mixed $model
38			* @return string
39			*/
40			public function getId($model) {
41			return $model->getId();
42			}
43
44			/**
45			*/
46			public function getRelationships() {
47			return [
48			'module' => Module::getSerializer()->getType(null),
49			'groups' => Group::getSerializer()->getType(null)
50			];
51			}
52
53			/**
54			*/
55			public function getSortFields() {
56			return ['id', 'name', 'title', 'description', 'class_name', 'module_id'];
57			}
58
59			/**
60			* @param mixed $model
61			* @return string
62			*/
63			public function getType($model) {
64			return 'core/action';
65			}
66
67			/**
68			* @param mixed $model
69			* @return Relationship
70			*/
71			public function groups($model) {
72			$relationship = new Relationship(new Collection($model->getGroups(), Group::getSerializer()));
73			return $this->addRelationshipSelfLink($relationship, $model, 'groups');
			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...
74			}
75
76			/**
77			* @param mixed $model
78			* @param mixed $data
79			* @return mixed The model
80			*/
81			public function hydrate($model, $data) {
82			// attributes
83			$attribs = isset($data['attributes']) ? $data['attributes'] : [];
84
85			$model = HydrateUtils::hydrate($attribs, $model, ['id', 'name', 'title', 'description', 'class_name', 'module_id']);
86
87			// relationships
88			$this->hydrateRelationships($model, $data);
89
90			return $model;
91			}
92
93			/**
94			* @param mixed $model
95			* @return Relationship
96			*/
97			public function module($model) {
98			$serializer = Module::getSerializer();
99			$relationship = new Relationship(new Resource($model->getModule(), $serializer));
100			$relationship->setLinks([
101			'related' => '%apiurl%' . $serializer->getType(null) . '/' . $serializer->getId($model)
102			]);
103			return $this->addRelationshipSelfLink($relationship, $model, 'module');
			0 ignored issues – show Bug introduced 2016-04-14 19:00 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...
104			}
105
106			/**
107			* @param mixed $model
108			* @param mixed $data
109			*/
110			abstract protected function hydrateRelationships($model, $data);
			0 ignored issues – show Documentation introduced 2016-04-19 14:46 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...
111			}
112

keeko / core

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

ActionSerializerTrait::group() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like