keeko\core\domain\base\RegionAreaDomainTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	paginate()	0	27	3
A	read()	0	14	2
	applyFilter()	0	1	?
	getServiceContainer()	0	1	?

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

use keeko\core\model\RegionArea;
use keeko\core\model\RegionAreaQuery;
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;

/**
 */
trait RegionAreaDomainTrait {

	/**
	 * @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 = RegionAreaQuery::create();

		// sorting
		$sort = $params->getSort(RegionArea::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 RegionAreaDomainTrait::applyFilter() has too many arguments starting with $filter.

		}

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

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

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

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

		// run response
		return $payload;
	}

	/**
	 * Implement this functionality at keeko\core\domain\RegionAreaDomain
	 * 
	 * @param RegionAreaQuery $query
	 */
	abstract protected function applyFilter(RegionAreaQuery $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();
}