Maslosoft\Mangan\Traits\DataProvider\DataTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

66.67%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setData()	0	4	1
	fetchData()	0	1	?
A	getData()	0	12	4

<?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();
}