UserSerializerTrait::hydrateRelationships()

Completed

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

by Thomas

created 2016-04-19 14:36 UTC

↳ Parent: UserSerializerTrait

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	1
nc	1

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

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

/**
 */
trait UserSerializerTrait {

	/**
	 * @param mixed $model
	 * @param array $fields
	 */
	public function getAttributes($model, array $fields = null) {
		return [
			'id' => $model->getId(),
			'login_name' => $model->getLoginName(),
			'password' => $model->getPassword(),
			'given_name' => $model->getGivenName(),
			'family_name' => $model->getFamilyName(),
			'display_name' => $model->getDisplayName(),
			'email' => $model->getEmail(),
			'birthday' => $model->getBirthday(\DateTime::ISO8601),
			'sex' => $model->getSex(),
		];
	}

	/**
	 */
	public function getFields() {
		return ['id', 'login_name', 'given_name', 'family_name', 'display_name', 'email', 'birthday', 'sex', 'created_at', 'updated_at'];
	}

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

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

	/**
	 */
	public function getSortFields() {
		return ['id', 'login_name', 'password', 'given_name', 'family_name', 'display_name', 'email', 'birthday', 'sex'];
	}

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

	/**
	 * @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', 'login_name', 'password' => function($v) {
			return password_hash($v, PASSWORD_BCRYPT);
		}, 'given_name', 'family_name', 'display_name', 'email', 'birthday', 'sex']);

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

		return $model;
	}

	/**
	 * @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\Group;
7			use Tobscure\JsonApi\Collection;
8
9			/**
10			*/
11			trait UserSerializerTrait {
12
13			/**
14			* @param mixed $model
15			* @param array $fields
16			*/
17			public function getAttributes($model, array $fields = null) {
18			return [
19			'id' => $model->getId(),
20			'login_name' => $model->getLoginName(),
21			'password' => $model->getPassword(),
22			'given_name' => $model->getGivenName(),
23			'family_name' => $model->getFamilyName(),
24			'display_name' => $model->getDisplayName(),
25			'email' => $model->getEmail(),
26			'birthday' => $model->getBirthday(\DateTime::ISO8601),
27			'sex' => $model->getSex(),
28			];
29			}
30
31			/**
32			*/
33			public function getFields() {
34			return ['id', 'login_name', 'given_name', 'family_name', 'display_name', 'email', 'birthday', 'sex', 'created_at', 'updated_at'];
35			}
36
37			/**
38			* @param mixed $model
39			* @return string
40			*/
41			public function getId($model) {
42			return $model->getId();
43			}
44
45			/**
46			*/
47			public function getRelationships() {
48			return [
49			'groups' => Group::getSerializer()->getType(null)
50			];
51			}
52
53			/**
54			*/
55			public function getSortFields() {
56			return ['id', 'login_name', 'password', 'given_name', 'family_name', 'display_name', 'email', 'birthday', 'sex'];
57			}
58
59			/**
60			* @param mixed $model
61			* @return string
62			*/
63			public function getType($model) {
64			return 'core/user';
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', 'login_name', 'password' => function($v) {
86			return password_hash($v, PASSWORD_BCRYPT);
87			}, 'given_name', 'family_name', 'display_name', 'email', 'birthday', 'sex']);
88
89			// relationships
90			$this->hydrateRelationships($model, $data);
91
92			return $model;
93			}
94
95			/**
96			* @param mixed $model
97			* @param mixed $data
98			*/
99			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...
100			}
101

keeko / core

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

UserSerializerTrait::hydrateRelationships()

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like