Maslosoft\Manganel\Filters\SearchFilter

Complexity

Total Complexity

5

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Test Coverage

Coverage

91.67%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	fromModel()	0	25	4
A	toModel()	0	4	1

<?php

/**
 * This software package is licensed under `AGPL-3.0-only, proprietary` license[s].
 *
 * @package maslosoft/manganel
 * @license AGPL-3.0-only, proprietary
 *
 * @copyright Copyright (c) Peter Maselkowski <pmaselkowski@gmail.com>
 * @link https://maslosoft.com/manganel/
 */

namespace Maslosoft\Manganel\Filters;

use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Interfaces\Filters\Property\TransformatorFilterInterface;
use Maslosoft\Mangan\Meta\DocumentPropertyMeta;
use Maslosoft\Manganel\Meta\ManganelMeta;

/**
 * Search Filter is meant to filter out non indexable properties from model.
 *
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
class SearchFilter implements TransformatorFilterInterface
{

	/**
	 * This will filter out:
	 *
	 * 1. Fields marked with:
	 * ```
	 * @Search(false)
	 * ```
	 * 2. Secret fields marked in any way with:
	 * ```
	 * @Secret
	 * ```
	 * 3. Non-persistent fields marked with:
	 * ```
	 * @Persistent(false)
	 * ```
	 *
	 * @param AnnotatedInterface $model
	 * @param DocumentPropertyMeta $fieldMeta
	 * @return boolean
	 */
	public function fromModel($model, DocumentPropertyMeta $fieldMeta)
	{
		$name = $fieldMeta->name;
		// Create Manganel meta instance of field
		$meta = ManganelMeta::create($model)->field($name);

		// Skip if explicitly not searchable
		if (false === $meta->searchable)
		{
			return false;
		}

		// Skip non-persistent fields
		if (false === $meta->persistent)
		{
			return false;
		}

		// Skip secret fields
		if ($meta->secret)
		{
			return false;
		}
		return true;
	}

	/**
	 * Allow any previously set fields to be set.
	 * @param AnnotatedInterface $model
	 * @param DocumentPropertyMeta $fieldMeta
	 * @return boolean
	 */
	public function toModel($model, DocumentPropertyMeta $fieldMeta)
	{
		return true;
	}

}