keeko\core\domain\base\ModuleDomainTrait

Complexity

Total Complexity

17

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	15

Importance

Changes	5
Bugs	0	Features	0

8 Methods

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

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

use keeko\core\model\Module;
use keeko\core\model\ModuleQuery;
use keeko\framework\service\ServiceContainer;
use keeko\framework\domain\payload\PayloadInterface;
use phootwork\collection\Map;
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 ModuleDomainTrait {

	/**
	 * Creates a new Module with the provided data
	 * 
	 * @param mixed $data
	 * @return PayloadInterface
	 */
	public function create($data) {
		// hydrate
		$serializer = Module::getSerializer();
		$module = $serializer->hydrate(new Module(), $data);

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

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

	/**
	 * Deletes a Module with the given id
	 * 
	 * @param mixed $id
	 * @return PayloadInterface
	 */
	public function delete($id) {
		// find
		$module = $this->get($id);

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

		// delete
		$module->delete();

		if ($module->isDeleted()) {
			return new Deleted(['model' => $module]);
		}

		return new NotDeleted(['message' => 'Could not delete Module']);
	}

	/**
	 * Returns a paginated result
	 * 
	 * @param Parameters $params
	 * @return PayloadInterface
	 */
	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 = ModuleQuery::create();

		// sorting
		$sort = $params->getSort(Module::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);
		}

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

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

	/**
	 * Returns one Module with the given id
	 * 
	 * @param mixed $id
	 * @return PayloadInterface
	 */
	public function read($id) {
		// read
		$module = $this->get($id);

		// check existence
		if ($module === null) {
			return new NotFound(['message' => 'Module not found.']);
		}

		return new Found(['model' => $module]);
	}

	/**
	 * Updates a Module with the given idand the provided data
	 * 
	 * @param mixed $id
	 * @param mixed $data
	 * @return PayloadInterface
	 */
	public function update($id, $data) {
		// find
		$module = $this->get($id);

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

		// hydrate
		$serializer = Module::getSerializer();
		$module = $serializer->hydrate($module, $data);

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

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

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

		return new Updated($payload);
	}

	/**
	 * Implement this functionality at keeko\core\domain\ModuleDomain
	 * 
	 * @param ModuleQuery $query
	 * @param mixed $filter
	 */
	abstract protected function applyFilter(ModuleQuery $query, $filter);

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 one Module with the given id from cache
	 * 
	 * @param mixed $id
	 * @return Module|null
	 */
	protected function get($id) {
		if ($this->pool === null) {
			$this->pool = new Map();

The property pool does not exist. Did you maybe forget to declare it?

		} else if ($this->pool->has($id)) {
			return $this->pool->get($id);
		}

		$module = ModuleQuery::create()->findOneById($id);
		$this->pool->set($id, $module);

		return $module;
	}

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