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 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 87 88 89 90 91 92 <?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\Decorators;
use Maslosoft\Addendum\Utilities\ClassChecker;
use Maslosoft\Mangan\Events\ClassNotFound;
use Maslosoft\Mangan\Events\Event;
use Maslosoft\Mangan\Exceptions\ManganException;
use Maslosoft\Mangan\Finder;
use Maslosoft\Mangan\Helpers\DbRefManager;
use Maslosoft\Mangan\Helpers\NotFoundResolver;
use Maslosoft\Mangan\Interfaces\Decorators\Property\DecoratorInterface;
use Maslosoft\Mangan\Interfaces\Transformators\TransformatorInterface;
use Maslosoft\Mangan\Meta\ManganMeta;
use Maslosoft\Mangan\Model\DbRef;
/**
* DbRefDecorator
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class DbRefDecorator implements DecoratorInterface
{
public function read($model, $name, &$dbValue, $transformatorClass = TransformatorInterface::class)
{
if (!$dbValue)
{
$fieldMeta = ManganMeta::create($model)->field($name);
$model->$name = $fieldMeta->default;
return;
}
// Assume that ref is already provided
if (!empty($dbValue['_class']) && $dbValue['_class'] !== DbRef::class)
{
$model->$name = $transformatorClass::toModel($dbValue);
return;
}
$dbValue['_class'] = DbRef::class;
$dbRef = $transformatorClass::toModel($dbValue);
self::ensureClass($model, $name, $dbRef);
/* @var $dbRef DbRef */
$referenced = new $dbRef->class;
$model->$name = (new Finder($referenced))->findByPk($dbRef->pk);
}
public function write($model, $name, &$dbValue, $transformatorClass = TransformatorInterface::class)
{
if (!$model->$name)
{
return;
}
$dbRef = DbRefManager::extractRef($model, $name);
$referenced = $model->$name;
$fieldMeta = ManganMeta::create($model)->field($name);
if ($fieldMeta->dbRef->updatable)
{
DbRefManager::save($referenced, $dbRef);
}
$dbValue[$name] = $transformatorClass::fromModel($dbRef, false);
}
public static function ensureClass($model, $name, DbRef $dbRef)
{
if (!ClassChecker::exists($dbRef->class))
{
$event = new ClassNotFound($model);
$event->notFound = $dbRef->class;
if (Event::hasHandler($model, NotFoundResolver::EventClassNotFound) && Event::handled($model, NotFoundResolver::EventClassNotFound, $event))
{
$dbRef->class = $event->replacement;
}
else
{
throw new ManganException(sprintf("Referenced model class `%s` not found in model `%s` field `%s`", $dbRef->class, get_class($model), $name));
}
}
}
}
API documentation generated by ApiGen