Maslosoft Manganel 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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 <?php
/**
* This software package is licensed under `AGPL, Commercial` license[s].
*
* @package maslosoft/manganel
* @license AGPL, Commercial
*
* @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;
}
}
API documentation generated by ApiGen