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 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 <?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 Exception;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\EmbeDi\EmbeDi;
use Maslosoft\Mangan\Exceptions\ManganException;
use Maslosoft\Mangan\Helpers\ConnectionStorage;
use Maslosoft\Mangan\Interfaces\EventHandlersInterface;
use Maslosoft\Mangan\Interfaces\Exception\ExceptionCodeInterface;
use Maslosoft\Mangan\Interfaces\ManganAwareInterface;
use Maslosoft\Mangan\Interfaces\ProfilerInterface;
use Maslosoft\Mangan\Meta\ManganMeta;
use Maslosoft\Mangan\Profillers\NullProfiler;
use Maslosoft\Mangan\Signals\ConfigInit;
use Maslosoft\Mangan\Traits\Defaults\MongoClientOptions;
use Maslosoft\Signals\Signal;
use MongoClient;
use MongoDB;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
/**
* MongoDB
*
* This is merge work of tyohan, Alexander Makarov and mine
* @author Ianaré Sévi
* @author Dariusz Górecki <darek.krk@gmail.com>
* @author Invenzzia Group, open-source division of CleverIT company http://www.invenzzia.org
* @copyright 2011 CleverIT http://www.cleverit.com.pl
* @property LoggerInterface $logger Logger
* @property-read string $version Current version
* @since v1.0
*/
class Mangan implements LoggerAwareInterface
{
const DefaultConnectionId = 'mongodb';
use MongoClientOptions;
/**
* Correct syntax is:
* mongodb://[username:password@]host1[:port1][,host2[:port2:],...]
* @example mongodb://localhost:27017
* @var string host:port
* @since v1.0
*/
public $connectionString = 'mongodb://localhost:27017';
/**
* Default annotations values configuration. This should contain
* array with keys same as annotation class name, and key-value
* pairs corresponing to annotation properties.
*
* Example:
* ```
* $annotationsDefaults = [
* I18NAnnotation::class => [
* 'allowAny' => true,
* 'allowDefault' => true
* ]
* ];
* ```
*
*/
public $annotationsDefaults = [];
/**
* Configuration of decorators for transformers
* Array key is decorator class name or interface, values are decorator class names.
* @var string[][]
*/
public $decorators = [];
/**
* Configuration for finalizers.
* @see https://github.com/Maslosoft/Mangan/issues/36
* @var string[][]
*/
public $finalizers = [];
/**
* Configuration of property filters for transformers
* Array key is decorator class name or interface, values are filter class names.
* @var string[][]
*/
public $filters = [];
/**
* Mapping for validators. Key is validator proxy class name, value is concrete validator implementation
* @var string[]
*/
public $validators = [];
/**
* Sanitizers remapping for common scenarios.
* @var string[][]
*/
public $sanitizersMap = [];
/**
* Event handlers to attach on initialization.
*
* This should be list of class names implementing `EventHandlersInterface`
* or optionally list of arrays with configuration for `EventHandlersInterface`
* derived classes.
*
* @see EventHandlersInterface
* @var mixed[]
*/
public $eventHandlers = [];
/**
* Connection ID
* @var string
*/
public $connectionId = 'mongodb';
/**
* @var string $dbName name of the Mongo database to use
* @since v1.0
*/
public $dbName = null;
/**
* If set to TRUE all internal DB operations will use SAFE flag with data modification requests.
*
* When SAFE flag is set to TRUE driver will wait for the response from DB, and throw an exception
* if something went wrong, is set to false, driver will only send operation to DB but will not wait
* for response from DB.
*
* MongoDB default value for this flag is: FALSE.
*
* @var boolean $safeFlag state of SAFE flag (global scope)
*/
public $safeFlag = false;
/**
* If set to TRUE findAll* methods of models, will return {@see Cursor} instead of
* raw array of models.
*
* Generally you should want to have this set to TRUE as cursor use lazy-loading/instantiating of
* models, this is set to FALSE, by default to keep backwards compatibility.
*
* Note: {@see Cursor} does not implement ArrayAccess interface and cannot be used like an array,
* because offset access to cursor is highly ineffective and pointless.
*
* @var boolean $useCursor state of Use Cursor flag (global scope)
*/
public $useCursor = false;
/**
* Queries profiling.
* Defaults to false. This should be mainly enabled and used during development
* to find out the bottleneck of mongo queries.
* @var boolean whether to enable profiling the mongo queries being executed.
*/
public $enableProfiling = false;
/**
* Connection storage
* @var ConnectionStorage
*/
private $cs = null;
/**
* Embedi instance
* @var EmbeDi
*/
private $di = null;
/**
* Logger
* @var LoggerInterface
*/
private $_logger = null;
/**
* Profiller
* @var ProfilerInterface
*/
private $_profiler = null;
/**
* Version number holder
* @var string
*/
private static $_version = null;
/**
* Instances of mangan
* @var Mangan[]
*/
private static $mn = [];
/**
* Hash map of class name to id. This is to reduce overhead of Mangan::fromModel()
* @var string[]
*/
private static $classToId = [];
/**
* Create new mangan instance.
*
* **NOTE: While it's ok to use constructor to create Mangan, it is recommended to use
* Mangan::fly() to create/get instance, as creating new instance has some overhead.**
*
* @param string $connectionId
*/
public function __construct($connectionId = self::DefaultConnectionId)
{
$this->di = EmbeDi::fly($connectionId);
// Load built-in config
$config = ConfigManager::getDefault();
// Gather additional config options via signals
(new Signal)->emit(new ConfigInit($config, $connectionId));
// Apply built-in configuration, as other configurations might not exists
$this->di->apply($config, $this);
if (empty($connectionId))
{
$connectionId = self::DefaultConnectionId;
}
$this->connectionId = $connectionId;
// Apply any configurations loaded
$this->di->configure($this);
$this->cs = new ConnectionStorage($this, $connectionId);
if (empty(self::$mn[$connectionId]))
{
self::$mn[$connectionId] = $this;
}
// Initialize event handlers once
static $once = true;
if ($once)
{
foreach ($this->eventHandlers as $config)
{
$eh = $this->di->apply($config);
assert($eh instanceof EventHandlersInterface);
$eh->setupHandlers();
}
$once = false;
}
}
public function __get($name)
{
return $this->{'get' . ucfirst($name)}();
}
public function __set($name, $value)
{
$this->{'set' . ucfirst($name)}($value);
}
/**
* Get mangan version
* @return string
*/
public function getVersion()
{
if (null === self::$_version)
{
self::$_version = require __DIR__ . '/version.php';
}
return self::$_version;
}
/**
* Set PSR compliant logger
* @param LoggerInterface $logger
* @return Mangan
*/
public function setLogger(LoggerInterface $logger)
{
$this->_logger = $logger;
return $this;
}
/**
* Get PSR compliant logger
* @return LoggerInterface
*/
public function getLogger()
{
if (null === $this->_logger)
{
$this->_logger = new NullLogger;
}
return $this->_logger;
}
/**
* Get profiler instance. This is guaranted, if not configured will return NullProfiller.
* @see NullProfiler
* @return ProfilerInterface
*/
public function getProfiler()
{
if (null === $this->_profiler)
{
$this->_profiler = new NullProfiler;
}
if ($this->_profiler instanceof ManganAwareInterface)
{
$this->_profiler->setMangan($this);
}
return $this->_profiler;
}
/**
* Set profiler instance
* @param ProfilerInterface $profiller
* @return Mangan
*/
public function setProfiler(ProfilerInterface $profiller)
{
$this->_profiler = $profiller;
return $this;
}
/**
* Get dependency injector.
* @return EmbeDi
*/
public function getDi()
{
return $this->di;
}
/**
* Get flyweight instance of Mangan component.
* Only one instance will be created for each `$connectionId`.
*
* @new
* @param string $connectionId
* @return Mangan
*/
public static function fly($connectionId = self::DefaultConnectionId)
{
if (empty($connectionId))
{
$connectionId = self::DefaultConnectionId;
}
if (empty(self::$mn[$connectionId]))
{
self::$mn[$connectionId] = new static($connectionId);
}
return self::$mn[$connectionId];
}
/**
* Get instance of Mangan configured for particular model
* @param AnnotatedInterface|string $model
* @return static
*/
public static function fromModel($model)
{
if(is_object($model))
{
$key = get_class($model);
}
else
{
$key = $model;
}
if (isset(self::$classToId[$key]))
{
$connectionId = self::$classToId[$key];
}
else
{
$connectionId = ManganMeta::create($model)->type()->connectionId;
self::$classToId[$key] = $connectionId;
}
return self::fly($connectionId);
}
public function init()
{
$this->di->store($this);
}
/**
* Connect to DB if connection is already connected this method return connection status.
*
* @return bool Returns true if connected
* @throws ManganException
*/
public function connect()
{
if (!$this->getConnection()->connected)
{
return $this->getConnection()->connect();
}
return $this->getConnection()->connected;
}
/**
* Returns Mongo connection instance if not exists will create new
*
* @return MongoClient
* @throws ManganException
* @since v1.0
*/
public function getConnection()
{
if ($this->cs->mongoClient === null)
{
if (!$this->connectionString)
{
throw new ManganException('Mangan.connectionString cannot be empty.');
}
$options = [];
foreach ($this->_getOptionNames() as $name)
{
if (isset($this->$name))
{
$options[$name] = $this->$name;
}
}
$this->cs->mongoClient = new MongoClient($this->connectionString, $options);
return $this->cs->mongoClient;
}
else
{
return $this->cs->mongoClient;
}
}
/**
* Set the connection by supplying `MongoClient` instance.
*
* Use this to set connection from external source.
* In most scenarios this does not need to be called.
*
* @param MongoClient $connection
*/
public function setConnection(MongoClient $connection)
{
$this->cs->mongoClient = $connection;
}
/**
* Get MongoDB instance
*
* @return MongoDB Mongo DB instance
* @throws ManganException
*/
public function getDbInstance()
{
if ($this->cs->mongoDB === null)
{
if (!$this->dbName)
{
throw new ManganException(sprintf("Database name (`dbName`) is required for connectionId: `%s`", $this->connectionId), ExceptionCodeInterface::RequireDbName);
}
try
{
$db = $this->getConnection()->selectDB($this->dbName);
}
catch (Exception $e)
{
throw new ManganException(sprintf('Could not select db name: `%s`, for connectionId: `%s` - %s', $this->dbName, $this->connectionId, $e->getMessage()), ExceptionCodeInterface::CouldNotSelect, $e);
}
return $this->cs->mongoDB = $db;
}
else
{
return $this->cs->mongoDB;
}
}
/**
* Set MongoDB instance by supplying database name.
*
* Use this to select db from external source.
* In most scenarios this does not need to be called.
*
* @param string $name
* @throws ManganException
*/
public function setDbInstance($name)
{
$this->cs->mongoDB = $this->getConnection()->selectDb($name);
}
/**
* Closes the currently active Mongo connection.
* It does nothing if the connection is already closed.
*/
protected function close()
{
if ($this->cs->mongoClient !== null)
{
$this->cs->mongoClient->close();
$this->cs->mongoClient = null;
$this->cs->mongoDB = null;
}
}
/**
* Change working database
* @param $name
*/
public function selectDb($name)
{
$this->setDbInstance($name);
}
/**
* Drop current database
*/
public function dropDb()
{
$this->getDbInstance()->drop();
}
}
API documentation generated by ApiGen