namespace Civi\Core;
-use Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher;
+use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\Event;
/**
*
* @see \CRM_Utils_Hook
*/
-class CiviEventDispatcher extends ContainerAwareEventDispatcher {
+class CiviEventDispatcher extends EventDispatcher {
const DEFAULT_HOOK_PRIORITY = -100;
private $autoListeners = [];
/**
+ * A list of dispatch-policies (based on an exact-match to the event name).
+ *
+ * Note: $dispatchPolicyExact and $dispatchPolicyRegex should coexist; e.g.
+ * if one is NULL, then both are NULL. If one is an array, then both are arrays.
+ *
* @var array|null
* Array(string $eventName => string $action)
*/
private $dispatchPolicyExact = NULL;
/**
+ * A list of dispatch-policies (based on an regex-match to the event name).
+ *
+ * Note: $dispatchPolicyExact and $dispatchPolicyRegex should coexist; e.g.
+ * if one is NULL, then both are NULL. If one is an array, then both are arrays.
+ *
* @var array|null
* Array(string $eventRegex => string $action)
*/
return (substr($eventName, 0, 5) === 'hook_') && (strpos($eventName, '::') === FALSE);
}
+ /**
+ * Adds a service as event listener.
+ *
+ * This provides partial backwards compatibility with ContainerAwareEventDispatcher.
+ *
+ * @param string $eventName Event for which the listener is added
+ * @param array $callback The service ID of the listener service & the method
+ * name that has to be called
+ * @param int $priority The higher this value, the earlier an event listener
+ * will be triggered in the chain.
+ * Defaults to 0.
+ *
+ * @throws \InvalidArgumentException
+ */
+ public function addListenerService($eventName, $callback, $priority = 0) {
+ if (!\is_array($callback) || 2 !== \count($callback)) {
+ throw new \InvalidArgumentException('Expected an array("service", "method") argument');
+ }
+
+ $this->addListener($eventName, function($event) use ($callback) {
+ static $svc;
+ if ($svc === NULL) {
+ $svc = \Civi::container()->get($callback[0]);
+ }
+ return call_user_func([$svc, $callback[1]], $event);
+ }, $priority);
+ }
+
/**
* @inheritDoc
*/
}
/**
+ * Attach any pattern-based listeners which may be interested in $eventName.
+ *
* @param string $eventName
* Ex: 'civi.api.resolve' or 'hook_civicrm_dashboard'.
*/
}
/**
- * The dispatch policy allows you to filter certain events.
+ * Set the dispatch policy. This allows you to filter certain events.
* This can be useful during upgrades or debugging.
*
* Enforcement will add systemic overhead, so this should normally be NULL.
// }
/**
+ * Determine whether the dispatch policy applies to a given event.
+ *
* @param string $eventName
+ * Ex: 'civi.api.resolve' or 'hook_civicrm_dashboard'.
* @return string
* Ex: 'run', 'drop', 'fail'
*/