SessionSerializerTrait::getId() - 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

SessionSerializerTrait::getId() A

↳ Parent: SessionSerializerTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

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

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

/**
 */
trait SessionSerializerTrait {

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

		return [
			'token' => $model->Token(),
			'user_id' => $model->UserId(),
		];
	}

	/**
	 */
	public function getFields() {
		return ['token', 'user_id', 'created_at', 'updated_at'];
	}

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

		return $model->getId();
	}

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

	/**
	 */
	public function getSortFields() {
		return ['token', 'user_id'];
	}

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

		return 'core/session';
	}

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

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

		$model = HydrateUtils::hydrate($attribs, $model, ['token', 'user_id']);

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


		return $model;
	}

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

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

		$serializer = User::getSerializer();
		$relationship = new Relationship(new Resource($model->getUser(), $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();
    }
}
	}
}


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\User;
7			use Tobscure\JsonApi\Resource;
8
9			/**
10			*/
11			trait SessionSerializerTrait {
12
13			/**
14			* @param mixed $model
15			* @param array $fields
16			*/
17			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...
18			return [
19			'token' => $model->Token(),
20			'user_id' => $model->UserId(),
21			];
22			}
23
24			/**
25			*/
26			public function getFields() {
27			return ['token', 'user_id', 'created_at', 'updated_at'];
28			}
29
30			/**
31			* @param mixed $model
32			*/
33			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...
34			return $model->getId();
35			}
36
37			/**
38			*/
39			public function getRelationships() {
40			return [
41			'user' => User::getSerializer()->getType(null)
42			];
43			}
44
45			/**
46			*/
47			public function getSortFields() {
48			return ['token', 'user_id'];
49			}
50
51			/**
52			* @param mixed $model
53			*/
54			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...
55			return 'core/session';
56			}
57
58			/**
59			* @param mixed $model
60			* @param mixed $data
61			*/
62			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...
63			// attributes
64			$attribs = isset($data['attributes']) ? $data['attributes'] : [];
65
66			$model = HydrateUtils::hydrate($attribs, $model, ['token', 'user_id']);
67
68			// relationships
69			$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\SessionSerializerTrait`. 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...
70
71			return $model;
72			}
73
74			/**
75			* @param mixed $model
76			* @param mixed $data
77			*/
78			public function setUser($model, $data) {
79			$model->setUserId($data['id']);
80			}
81
82			/**
83			* @param mixed $model
84			* @param mixed $related
85			*/
86			public function user($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...
87			$serializer = User::getSerializer();
88			$relationship = new Relationship(new Resource($model->getUser(), $serializer));
89			$relationship->setLinks([
90			'related' => '%apiurl%' . $serializer->getType(null) . '/' . $serializer->getId($model)
91			]);
92			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...
93			}
94			}
95

keeko / core

Push — master ( a7ae23...b30b3b )

SessionSerializerTrait::getId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like