Maslosoft\Manganel\Traits\IndexAwareTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getIndex()	0	8	2
A	setIndex()	0	9	2

<?php

/**
 * This software package is licensed under `AGPL, Commercial` license[s].
 *
 * @package maslosoft/manganel
 * @license AGPL, Commercial
 *
 * @copyright Copyright (c) Peter Maselkowski <pmaselkowski@gmail.com>
 * @link http://maslosoft.com/manganel/
 */

namespace Maslosoft\Manganel\Traits;

use Maslosoft\Manganel\Interfaces\IndexAwareInterface;
use UnexpectedValueException;

/**
 * IndexAwareTrait
 *
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
trait IndexAwareTrait
{

	private $index = '';

	/**
	 * Get currently used index
	 * @return string
	 */
	public function getIndex()
	{
		if (!$this instanceof IndexAwareInterface)
		{
			throw new UnexpectedValueException(sprintf('Class `%s` using `%s` must implement `%s`', get_class($this), __CLASS__, IndexAwareInterface::class)); // @codeCoverageIgnore
		}
		return $this->index;

Accessing index on the interface Maslosoft\Manganel\Interfaces\IndexAwareInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

	}

	/**
	 * Set currently used index
	 * @param string $index
	 * @return static
	 */
	public function setIndex($index)
	{
		if (!$this instanceof IndexAwareInterface)
		{
			throw new UnexpectedValueException(sprintf('Class `%s` using `%s` must implement `%s`', get_class($this), __CLASS__, IndexAwareInterface::class)); // @codeCoverageIgnore
		}
		$this->index = $index;

Accessing index on the interface Maslosoft\Manganel\Interfaces\IndexAwareInterface suggest that you code against a concrete implementation. How about adding an instanceof check?

		return $this;
	}

}