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 <?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\Annotations;
use Maslosoft\Manganel\Manganel;
use Maslosoft\Manganel\Meta\ManganelTypeAnnotation;
/**
* Search Index Annotation
*
* This annotation must be set to index document. Might be with empty value.
* Use this to set Manganel configuration ID. This does **not** set index name,
* use `Manganel`'s property `name` to set index name.
*
* Most simple example:
* ```
* @SearchIndex
* ```
*
* @Target('class')
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class SearchIndexAnnotation extends ManganelTypeAnnotation
{
const Ns = __NAMESPACE__;
/**
* Index ID. This points to Manganel configuration instance.
* @var string
*/
public $value = null;
public function init()
{
if (null === $this->value)
{
$this->value = Manganel::DefaultIndexId;
}
$this->getEntity()->indexId = $this->value;
}
}
API documentation generated by ApiGen