Maslosoft Mangan 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 58 59 60 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan\Traits;
use Maslosoft\Mangan\Interfaces\SortInterface;
use Maslosoft\Mangan\Sort;
/**
* SortAwareTrait
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
trait SortAwareTrait
{
/**
* @var SortInterface
*/
private $sort;
/**
* Returns the sort object.
* @return Sort the sorting object. If this is false, it means the sorting is disabled.
*/
public function getSort()
{
if ($this->sort === null)
{
$this->sort = new Sort;
$this->sort->setModel($this->getModel());
}
return $this->sort;
}
/**
* Set sort
* @param SortInterface $sort
* @return static
*/
public function setSort(SortInterface $sort)
{
$this->sort = $sort;
$this->sort->setModel($this->getModel());
return $this;
}
abstract public function getModel();
}
API documentation generated by ApiGen