Maslosoft Mangan 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 <?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\Annotations;
use Maslosoft\Mangan\Decorators\Property\SecretDecorator;
use Maslosoft\Mangan\Meta\ManganPropertyAnnotation;
use Maslosoft\Mangan\Meta\SecretMeta;
/**
* Secret Annotation
*
* Use this annotation to create "write-only" field, with possible callback when saving.
* When this annotation is active, only non empty values will be stored in database.
*
* Optional callback can be used to transform value before save, ie hash function:
*
* ```php
* @Secret('sha1')
* ```
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class SecretAnnotation extends ManganPropertyAnnotation
{
public $value;
public function init()
{
$data = [];
if ($this->value)
{
$data['callback'] = $this->value;
$this->getEntity()->decorators[] = SecretDecorator::class;
}
$this->getEntity()->secret = new SecretMeta($data);
}
}
API documentation generated by ApiGen