Maslosoft Manganel API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 <?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 https://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;
}
/**
* 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;
return $this;
}
}
API documentation generated by ApiGen