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 <?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\DataProvider;
/**
* DataTrait
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
trait DataTrait
{
private $data = null;
/**
* Returns the data items currently available, ensures that result is at leas empty array
* @param boolean $refresh whether the data should be re-fetched from persistent storage.
* @return array the list of data items currently available in this data provider.
*/
public function getData($refresh = false)
{
if ($this->data === null || $refresh)
{
$this->data = $this->fetchData();
}
if ($this->data === null)
{
return [];
}
return $this->data;
}
/**
* Manually set data. This is for special cases only,
* usually should not be used.
*
* @param array $data
*/
public function setData($data)
{
$this->data = $data;
}
abstract protected function fetchData();
}
API documentation generated by ApiGen