keeko\core\domain\base\ActionDomainTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	15	2
A	delete()	0	18	3
B	paginate()	0	27	3
A	read()	0	14	2
B	update()	0	28	4
	applyFilter()	0	1	?
	getServiceContainer()	0	1	?

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

use keeko\core\model\Action;
use keeko\core\model\ActionQuery;
use keeko\framework\service\ServiceContainer;
use keeko\framework\domain\payload\Found;
use keeko\framework\domain\payload\NotFound;
use Tobscure\JsonApi\Parameters;
use keeko\framework\utils\NameUtils;
use keeko\framework\domain\payload\Created;
use keeko\framework\domain\payload\Updated;
use keeko\framework\domain\payload\NotUpdated;
use keeko\framework\domain\payload\NotValid;
use keeko\framework\domain\payload\Deleted;
use keeko\framework\domain\payload\NotDeleted;

/**
 */
trait ActionDomainTrait {

	/**
	 * @param mixed $data
	 */
	public function create($data) {
		// hydrate
		$serializer = Action::getSerializer();
		$action = $serializer->hydrate(new Action(), $data);

		// validate
		if (!$action->validate()) {
			return new NotValid([
				'errors' => $action->getValidationFailures()
			]);
		}

		$action->save();
		return new Created(['model' => $action]);
	}

	/**
	 * @param mixed $id
	 */
	public function delete($id) {
		// find
		$action = ActionQuery::create()->findOneById($id);

		if ($action === null) {
			return new NotFound(['message' => 'Action not found.']);
		}

		// delete
		$action->delete();
		$payload = ['model' => $action];

		if ($action->isDeleted()) {
			return new Deleted($payload);
		}

		return new NotDeleted($payload);
	}

	/**
	 * @param Parameters $params
	 */
	public function paginate(Parameters $params) {
		$sysPrefs = $this->getServiceContainer()->getPreferenceLoader()->getSystemPreferences();
		$defaultSize = $sysPrefs->getPaginationSize();
		$page = $params->getPage('number');

The method getPage() cannot be called from this context as it is declared protected in class Tobscure\JsonApi\Parameters.

		$size = $params->getPage('size', $defaultSize);

The method getPage() cannot be called from this context as it is declared protected in class Tobscure\JsonApi\Parameters.

The call to Parameters::getPage() has too many arguments starting with $defaultSize.

		$query = ActionQuery::create();

		// sorting
		$sort = $params->getSort(Action::getSerializer()->getSortFields());
		foreach ($sort as $field => $order) {
			$method = 'orderBy' . NameUtils::toStudlyCase($field);
			$query->$method($order);
		}

		// filtering
		$filter = $params->getFilter();
		if (!empty($filter)) {
			$this->applyFilter($query, $filter);

The call to ActionDomainTrait::applyFilter() has too many arguments starting with $filter.

		}

		// paginate
		$action = $query->paginate($page, $size);

		// run response
		return new Found(['model' => $action]);
	}

	/**
	 * @param mixed $id
	 */
	public function read($id) {
		// read
		$action = ActionQuery::create()->findOneById($id);

		// check existence
		if ($action === null) {
			$payload = new NotFound(['message' => 'Action not found.']);
		} else {
			$payload = new Found(['model' => $action]);
		}

		// run response
		return $payload;
	}

	/**
	 * @param mixed $id
	 * @param mixed $data
	 */
	public function update($id, $data) {
		// find
		$action = ActionQuery::create()->findOneById($id);

		if ($action === null) {
			return new NotFound(['message' => 'Action not found.']);
		}

		// hydrate
		$serializer = Action::getSerializer();
		$action = $serializer->hydrate($action, $data);

		// validate
		if (!$action->validate()) {
			return new NotValid([
				'errors' => $action->getValidationFailures()
			]);
		}

		$rows = $action->save();
		$payload = ['model' => $action];

		if ($rows === 0) {
			return new NotUpdated($payload);
		}

		return new Updated($payload);
	}

	/**
	 * Implement this functionality at keeko\core\domain\ActionDomain
	 * 
	 * @param ActionQuery $query
	 */
	abstract protected function applyFilter(ActionQuery $query);

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.

	/**
	 * Returns the service container
	 * 
	 * @return ServiceContainer
	 */
	abstract protected function getServiceContainer();
}