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 <?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\Interfaces\Decorators\Property;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Interfaces\Transformators\TransformatorInterface;
/**
* This should modify fields bahavior
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
interface DecoratorInterface
{
/**
* This will be called when getting value.
* This should return end user value.
* @param AnnotatedInterface $model Document model which will be decorated
* @param string $name Field name
* @param mixed $dbValue
* @param string $transformatorClass Transformator class used
* @return bool Return true if value should be assigned to model
*/
public function read($model, $name, &$dbValue, $transformatorClass = TransformatorInterface::class);
/**
* This will be called when setting value.
* This should return db acceptable value
* @param AnnotatedInterface $model Model which is about to be decorated
* @param string $name Current field name
* @param mixed[] $dbValues Whole model values from database. This is associative array with keys same as model properties (use $name param to access value). This is passed by reference.
* @param string $transformatorClass Transformator class used
* @return bool Return true to store value to database
*/
public function write($model, $name, &$dbValues, $transformatorClass = TransformatorInterface::class);
}
API documentation generated by ApiGen