keeko\core\serializer\base\GroupSerializerTrait

Complexity

Total Complexity

10

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	3
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	actions()	0	4	1
A	getAttributes()	0	11	1
A	getFields()	0	3	1
A	getId()	0	3	1
A	getRelationships()	0	6	1
A	getSortFields()	0	3	1
A	getType()	0	3	1
A	hydrate()	0	11	2
A	users()	0	4	1
	hydrateRelationships()	0	1	?

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

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

/**
 */
trait GroupSerializerTrait {

	/**
	 * @param mixed $model
	 * @return Relationship
	 */
	public function actions($model) {
		$relationship = new Relationship(new Collection($model->getActions(), Action::getSerializer()));
		return $this->addRelationshipSelfLink($relationship, $model, 'actions');

It seems like addRelationshipSelfLink() must be provided by classes using this trait. How about adding it as abstract method to this trait?

	}

	/**
	 * @param mixed $model
	 * @param array $fields
	 */
	public function getAttributes($model, array $fields = null) {
		return [
			'id' => $model->getId(),
			'owner_id' => $model->getOwnerId(),
			'name' => $model->getName(),
			'is_guest' => $model->getIsGuest(),
			'is_default' => $model->getIsDefault(),
			'is_active' => $model->getIsActive(),
			'is_system' => $model->getIsSystem(),
		];
	}

	/**
	 */
	public function getFields() {
		return ['id', 'owner_id', 'name', 'is_guest', 'is_default', 'is_active', 'is_system', 'created_at', 'updated_at'];
	}

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

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

	/**
	 */
	public function getSortFields() {
		return ['id', 'owner_id', 'name', 'is_guest', 'is_default', 'is_active', 'is_system'];
	}

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

	/**
	 * @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', 'owner_id', 'name', 'is_guest', 'is_default', 'is_active', 'is_system']);

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

		return $model;
	}

	/**
	 * @param mixed $model
	 * @return Relationship
	 */
	public function users($model) {
		$relationship = new Relationship(new Collection($model->getUsers(), User::getSerializer()));
		return $this->addRelationshipSelfLink($relationship, $model, 'users');

It seems like addRelationshipSelfLink() must be provided by classes using this trait. How about adding it as abstract method to this trait?

	}

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

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.

}