Maslosoft\Mangan\Traits\Criteria\SelectableTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

55.56%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	select()	0	8	2
A	getSelect()	0	4	1
A	setSelect()	0	17	3

<?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\Criteria;

use Maslosoft\Mangan\Interfaces\Criteria\SelectableInterface;
use Maslosoft\Mangan\Interfaces\CriteriaInterface;

/**
 * SelectableTrait
 * @see CriteriaInterface
 * @see SelectableInterface
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
trait SelectableTrait
{

	private $_select = [];

	/**
	 * List of fields to get from DB
	 * Multiple calls to this method will merge all given fields
	 *
	 * @param array $fields list of fields to select
	 * @return CriteriaInterface
	 */
	public function select(array $fields = null)
	{
		if ($fields !== null)
		{
			$this->setSelect(array_merge($this->_select, $fields));
		}
		return $this;
	}

	/**
	 * Return selected fields
	 * @return bool[] Fields used for select
	 * @since v1.3.1
	 */
	public function getSelect()
	{
		return $this->_select;
	}

	/**
	 * Set fields to select.
	 * Pass array with field names as keys and true as value, ie:
	 * ```php
	 * $criteria->setSelect(['_id' => true, 'title' => true]);
	 * ```
	 *
	 * NOTE: This resets entire select
	 *
	 * @param bool[] $select Fields to select
	 * @return CriteriaInterface
	 */
	public function setSelect(array $select)
	{
		$this->_select = [];
		// Convert the select array to field=>true/false format
		foreach ($select as $key => $value)
		{
			if (is_int($key))
			{
				$this->_select[$value] = true;
			}
			else
			{
				$this->_select[$key] = $value;
			}
		}
		return $this;
	}

}