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 93 94 95 96 97 <?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;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Mangan\Abstracts\AbstractFinder;
use Maslosoft\Mangan\Adapters\Finder\MongoAdapter;
use Maslosoft\Mangan\Exceptions\ManganException;
use Maslosoft\Mangan\Helpers\FinderEvents;
use Maslosoft\Mangan\Interfaces\EntityManagerInterface;
use Maslosoft\Mangan\Interfaces\FinderInterface;
use Maslosoft\Mangan\Meta\ManganMeta;
use Maslosoft\Mangan\Traits\Finder\FinderHelpers;
use Maslosoft\Mangan\Transformers\RawArray;
/**
* Basic Finder implementation
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
class Finder extends AbstractFinder
{
use FinderHelpers;
/**
* Constructor
*
* @param object $model Model instance
* @param EntityManagerInterface $em
* @param Mangan $mangan
*/
public function __construct($model, $em = null, $mangan = null)
{
if (null === $mangan)
{
$mangan = Mangan::fromModel($model);
}
$this->setModel($model);
$this->setScopeManager(new ScopeManager($model));
$this->setAdapter(new MongoAdapter($model, $mangan, $em));
$this->setProfiler($mangan->getProfiler());
$this->setFinderEvents(new FinderEvents);
$this->withCursor($mangan->useCursor);
}
/**
* Create model related finder.
* This will create customized finder if defined in model with Finder annotation.
* If no custom finder is defined this will return default Finder.
*
* @param AnnotatedInterface $model
* @param EntityManagerInterface $em
* @param Mangan $mangan
* @return FinderInterface
*/
public static function create(AnnotatedInterface $model, $em = null, Mangan $mangan = null)
{
$finderClass = ManganMeta::create($model)->type()->finder ?: static::class;
return new $finderClass($model, $em, $mangan);
}
protected function createModel($data)
{
if (!empty($data['$err']))
{
throw new ManganException(sprintf("There is an error in query: %s", $data['$err']));
}
// By default create instances of same
// type as provided model
$model = $this->getModel();
// For non homogeneous collections class
// need to be taken from data, not defined
// by model
if(ManganMeta::create($model)->type()->homogenous === false)
{
$model = null;
}
return RawArray::toModel($data, $model);
}
}
API documentation generated by ApiGen