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 <?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\Events;
use Maslosoft\Addendum\Interfaces\AnnotatedInterface;
use Maslosoft\Addendum\Utilities\ClassChecker;
use Maslosoft\Hi5Edit\Models\Href;
use Maslosoft\Mangan\Interfaces\EntityManagerInterface;
use Maslosoft\Mangan\Interfaces\Events\EventInterface;
use Maslosoft\Mangan\Meta\ManganMeta;
use ReflectionClass;
use UnexpectedValueException;
/**
* This is based on Yii 2 Events
*/
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license http://www.yiiframework.com/license/
*/
/**
* Event is the base class for all event classes.
*
* It encapsulates the parameters associated with an event.
* The [[sender]] property describes who raises the event.
* And the [[handled]] property indicates if the event is handled.
* If an event handler sets [[handled]] to be true, the rest of the
* uninvoked handlers will no longer be called to handle the event.
*
* Additionally, when attaching an event handler, extra data may be passed
* and be available via the [[data]] property when the event handler is invoked.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
class Event implements EventInterface
{
/**
* @var string the event name. This property is set by [[Component::trigger()]] and [[trigger()]].
* Event handlers may use this property to check what event it is handling.
*/
public $name;
/**
* @var object the sender of this event. If not set, this property will be
* set as the object whose "trigger()" method is called.
* This property may also be a `null` when this event is a
* class-level event which is triggered in a static context.
*/
public $sender;
/**
* @var boolean whether the event is handled. Defaults to false.
* When a handler sets this to be true, the event processing will stop and
* ignore the rest of the uninvoked event handlers.
*/
public $handled = false;
/**
* @var mixed the data that is passed to [[Component::on()]] when attaching an event handler.
* Note that this varies according to which event handler is currently executing.
*/
public $data;
/**
* Array of events. This contains all event registered for application.
* @var EventInterface[]
*/
private static $events = [];
/**
* Array containing partial classes for class. This holds traits, interfaces,
* parent classes names for class.
*
* Structure is like below:
* ```
* $partials = [
* '\Vendor\Package\ClassOne' => [
* '\Vendor\Package\TraitOne',
* '\Vendor\Package\TraitTwo',
* '\Vendor\Package\InterfaceX',
* '\Vendor\Package\AbstractSix'
* ],
* '\Vendor\Package\ClassTwo' => [
* '\Vendor\Package\TraitBig',
* '\Vendor\Package\TraitSmall',
* '\Vendor\Package\InterfaceY',
* '\Vendor\Package\AbstractGuy'
* ],
* ];
* ```
*
* @var string[]
*/
private static $partials = [];
/**
* Propagated properties cache. It contains only properties which should
* propagate, others are skipped, thus value is always true.
*
* Structure is like follow:
* ```
* $propagated = [
* '\Vendor\Package\ClassOne' => [
* 'fieldOne' => true,
* 'fieldTwo' => true
* ],
* '\Vendor\Package\ClassTwo' => [
* 'otherFieldOne' => true,
* 'otherFieldTwo' => true
* ],
*
* ];
* ```
* @var bool[]
*/
private static $propagated = [];
/**
* Attaches an event handler to a class-level event.
*
* When a class-level event is triggered, event handlers attached
* to that class and all parent classes will be invoked.
*
* For example, the following code attaches an event handler to document's
* `afterInsert` event:
*
* ~~~
* Event::on($model, EntityManager::EventAfterInsert, function ($event) {
* var_dump(get_class($event->sender) . ' is inserted.');
* });
* ~~~
*
* The handler will be invoked for every successful document insertion.
*
* **NOTE:** Each call will attach new event handler. When placing event
* initialization in class constructors etc. ensure that it is evaluated once,
* or it might trigger same event handler multiple times.
*
* @param AnnotatedInterface|object|string $model the object specifying the class-level event.
* @param string $name the event name.
* @param callable $handler the event handler.
* @param mixed $data the data to be passed to the event handler when the event is triggered.
* When the event handler is invoked, this data can be accessed via [[Event::data]].
* @param boolean $append whether to append new event handler to the end of the existing
* handler list. If false, the new handler will be inserted at the beginning of the existing
* handler list.
* @see off()
*/
public static function on($model, $name, $handler, $data = null, $append = true)
{
$class = self::getName($model);
if ($append || empty(self::$events[$name][$class]))
{
self::$events[$name][$class][] = [$handler, $data];
}
else
{
array_unshift(self::$events[$name][$class], [$handler, $data]);
}
}
/**
* Detaches an event handler from a class-level event.
*
* This method is the opposite of [[on()]].
*
* @param AnnotatedInterface|object|string $model the object specifying the class-level event.
* @param string $name the event name.
* @param callable $handler the event handler to be removed.
* If it is null, all handlers attached to the named event will be removed.
* @return boolean whether a handler is found and detached.
* @see on()
*/
public static function off($model, $name, $handler = null)
{
$class = self::getName($model);
if (empty(self::$events[$name][$class]))
{
return false;
}
if ($handler === null)
{
unset(self::$events[$name][$class]);
return true;
}
else
{
$removed = false;
foreach (self::$events[$name][$class] as $i => $event)
{
if ($event[0] === $handler)
{
unset(self::$events[$name][$class][$i]);
$removed = true;
}
}
if ($removed)
{
self::$events[$name][$class] = array_values(self::$events[$name][$class]);
}
return $removed;
}
}
/**
* Triggers a class-level event.
* This method will cause invocation of event handlers that are attached to the named event
* for the specified class and all its parent classes.
* @param AnnotatedInterface $model the object specifying the class-level event.
* @param string $name the event name.
* @param ModelEvent $event the event parameter. If not set, a default `ModelEvent` object will be created.
* @return bool True if event was triggered.
*/
public static function trigger(AnnotatedInterface $model, $name, &$event = null)
{
$wasTriggered = false;
if (empty(self::$events[$name]))
{
return self::propagate($model, $name, $event);
}
if ($event === null)
{
$event = new ModelEvent();
}
$event->handled = false;
$event->name = $name;
if ($event->sender === null)
{
$event->sender = $model;
}
$event->currentTarget = $model;
$className = self::getName($model);
// Partials holds parts of class, this include interfaces and traits
$allPartials = self::getPartials($className);
// Filter out empty partials
$partials = [];
foreach ($allPartials as $className)
{
if (empty(self::$events[$name][$className]))
{
continue;
}
$partials[] = $className;
}
// Trigger all partial events if applicable
foreach ($partials as $className)
{
foreach (self::$events[$name][$className] as $handler)
{
// Assign source for easier debugging or other uses
$event->source = $className;
$event->data = $handler[1];
call_user_func($handler[0], $event);
$wasTriggered = true;
// Event was handled, return true
if ($event->handled)
{
return true;
}
}
}
// Propagate events to sub objects
return self::propagate($model, $name, $event) || $wasTriggered;
}
/**
* Triggers a class-level event and checks if it's valid.
* If don't have event handler returns true. If event handler is set, return true if `Event::isValid`.
* This method will cause invocation of event handlers that are attached to the named event
* for the specified class and all its parent classes.
* @param AnnotatedInterface $model the object specifying the class-level event.
* @param string $name the event name.
* @param ModelEvent $event the event parameter. If not set, a default [[ModelEvent]] object will be created.
* @return bool True if event was triggered and is valid.
*/
public static function valid(AnnotatedInterface $model, $name, $event = null)
{
if (Event::trigger($model, $name, $event))
{
return $event->isValid;
}
else
{
return true;
}
}
/**
* Triggers a class-level event and checks if it's handled.
* If don't have event handler returns true. If event handler is set, return true if `Event::handled`.
* This method will cause invocation of event handlers that are attached to the named event
* for the specified class and all its parent classes.
* @param AnnotatedInterface $model the object specifying the class-level event.
* @param string $name the event name.
* @param ModelEvent $event the event parameter. If not set, a default [[Event]] object will be created.
* @return bool|null True if handled, false otherways, null if not triggered
*/
public static function handled(AnnotatedInterface $model, $name, $event = null)
{
if (Event::trigger($model, $name, $event))
{
return $event->handled;
}
return true;
}
/**
* Check if model has event handler.
* **IMPORTANT**: It does not check for propagated events
*
* @param AnnotatedInterface|string $class the object specifying the class-level event
* @param string $name the event name.
* @return bool True if has handler
*/
public static function hasHandler($class, $name)
{
// Partials holds parts of class, this include interfaces and traits
$partials = self::getPartials(self::getName($class));
foreach ($partials as $className)
{
if (!empty(self::$events[$name][$className]))
{
return true;
}
}
return false;
}
/**
* Get class name
* @param AnnotatedInterface|object|string $class
* @return string
*/
private static function getName($class)
{
if (is_object($class))
{
$class = get_class($class);
}
else
{
if (!ClassChecker::exists($class))
{
throw new UnexpectedValueException(sprintf("Class `%s` not found", $class));
}
}
return ltrim($class, '\\');
}
/**
* Propagate event
* @param AnnotatedInterface $model
* @param string $name
* @param ModelEvent|null $event
*/
private static function propagate(AnnotatedInterface $model, $name, &$event = null)
{
$wasTriggered = false;
if ($event && !$event->propagate())
{
return false;
}
foreach (self::getPropagatedProperties($model) as $property => $propagate)
{
if (empty($model->$property))
{
// Property is empty, skip
continue;
}
// Trigger for arrays
if (is_array($model->$property))
{
foreach ($model->$property as $object)
{
$wasTriggered = self::trigger($object, $name, $event) || $wasTriggered;
}
continue;
}
$wasTriggered = self::trigger($model->$property, $name, $event) || $wasTriggered;
}
return $wasTriggered;
}
/**
* Get properties which should be propagated.
* NOTE: This is cached, as it might be called numerous times
* @param object $model
* @return bool[]
*/
private static function getPropagatedProperties($model)
{
$key = get_class($model);
if (empty(self::$propagated[$key]))
{
$propagated = [];
foreach (ManganMeta::create($model)->properties('propagateEvents') as $name => $isPropagated)
{
if (!$isPropagated)
{
continue;
}
$propagated[$name] = true;
}
self::$propagated[$key] = $propagated;
}
return self::$propagated[$key];
}
/**
* Get class/interface/trait names from which class is composed.
*
* @param string $className
* @return array
*/
public static function getPartials($className)
{
if (array_key_exists($className, self::$partials))
{
return self::$partials[$className];
}
if(!ClassChecker::exists($className))
{
self::$partials[$className] = [];
return [];
}
$partials = [];
// Iterate over traits
foreach ((new ReflectionClass($className))->getTraitNames() as $trait)
{
$partials[] = $trait;
}
// Iterate over interfaces to get partials
foreach ((new ReflectionClass($className))->getInterfaceNames() as $interface)
{
$partials[] = $interface;
}
// Iterate over parent classes
do
{
$partials[] = $className;
}
while (($className = get_parent_class($className)) !== false);
self::$partials[$className] = $partials;
return $partials;
}
protected static function destroyEvents()
{
self::$events = [];
}
}
API documentation generated by ApiGen