keeko\core\serializer\base\ActionSerializerTrait

Complexity

Total Complexity

18

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	addGroups()	0	8	3
A	getAttributes()	0	10	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	group()	0	4	1
A	hydrate()	0	11	2
A	module()	0	8	1
A	removeGroups()	0	8	3
A	setGroups()	0	4	1
A	setModule()	0	3	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 keeko\core\model\GroupQuery;
use Tobscure\JsonApi\Collection;
use keeko\core\model\GroupActionQuery;

/**
 */
trait ActionSerializerTrait {

	/**
	 * @param mixed $model
	 * @param mixed $data
	 */
	public function addGroups($model, $data) {
		foreach ($data as $item) {
			$group = GroupQuery::create()->findOneById($item['id']);
			if ($group !== null) {
				$model->addGroup($group);
			}
		}
	}

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

The parameter $fields is not used and could be removed.

		return [
			'id' => $model->Id(),
			'name' => $model->Name(),
			'title' => $model->Title(),
			'description' => $model->Description(),
			'class_name' => $model->ClassName(),
			'module_id' => $model->ModuleId(),
		];
	}

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

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

The return type could not be reliably inferred; please add a @return annotation.

		return $model->getId();
	}

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

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

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

The parameter $model is not used and could be removed.

		return 'core/action';
	}

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

The return type could not be reliably inferred; please add a @return annotation.

		$relationship = new Relationship(new Collection($model->getGroups(), Group::getSerializer()));
		return $this->addRelationshipSelfLink($relationship, $model, $related);

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
	 */
	public function hydrate($model, $data) {

The return type could not be reliably inferred; please add a @return annotation.

		// 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);

The method hydrateRelationships() does not exist on keeko\core\serializer\base\ActionSerializerTrait. Did you maybe mean hydrate()?

		return $model;
	}

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

The return type could not be reliably inferred; please add a @return annotation.

		$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, $related);

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
	 */
	public function removeGroups($model, $data) {
		foreach ($data as $item) {
			$group = GroupQuery::create()->findOneById($item['id']);
			if ($group !== null) {
				$model->removeGroup($group);
			}
		}
	}

	/**
	 * @param mixed $model
	 * @param mixed $data
	 */
	public function setGroups($model, $data) {
		GroupActionQuery::create()->filterByGroup($model)->delete();
		$this->addGroups($model, $data);
	}

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