EventsService.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Elgg\Traits\Debug\Profilable;

class EventsService extends HooksRegistrationService {
    
    use Profilable;

    const OPTION_STOPPABLE = 'stoppable';

    private $handlers;

    public function __construct(HandlersService $handlers) {
        $this->handlers = $handlers;
    }

    public function getHandlersService() {
        return $this->handlers;
    }

    public function registerHandler($name, $type, $callback, $priority = 500) {
        if (in_array($type, ['member', 'friend', 'attached'])
                && in_array($name, ['create', 'update', 'delete'])) {
            $this->getLogger()->error("'{$name}, {$type}' event is no longer triggered. "
                . "Update your event registration to use '{$name}, relationship'");
        }

        return parent::registerHandler($name, $type, $callback, $priority);
    }

    public function trigger($name, $type, $object = null, array $options = []) {
        $options = array_merge([
            self::OPTION_STOPPABLE => true,
        ], $options);

        // check for deprecation
        $this->checkDeprecation($name, $type, $options);

        // get registered handlers
        $handlers = $this->getOrderedHandlers($name, $type);

        // This starts as a string, but if a handler type-hints an object we convert it on-demand inside
        // \Elgg\HandlersService::call and keep it alive during all handler calls. We do this because
        // creating objects for every triggering is expensive.
        $event = 'event';
        /* @var Event|string */

        foreach ($handlers as $handler) {
            $handler_description = false;
            if ($this->hasTimer() && $type === 'system' && $name !== 'shutdown') {
                $handler_description = $this->handlers->describeCallable($handler) . '()';
                $this->beginTimer(["[{$name},{$type}]", $handler_description]);
            }

            list($success, $return, $event) = $this->handlers->call($handler, $event, [$name, $type, $object]);

            if ($handler_description) {
                $this->endTimer(["[{$name},{$type}]", $handler_description]);
            }

            if (!$success) {
                continue;
            }

            if (!empty($options[self::OPTION_STOPPABLE]) && ($return === false)) {
                return false;
            }
        }

        return true;
    }

    public function triggerBefore($event, $object_type, $object = null, array $options = []) {
        return $this->trigger("$event:before", $object_type, $object, $options);
    }

    public function triggerAfter($event, $object_type, $object = null, array $options = []) {
        $options[self::OPTION_STOPPABLE] = false;
        
        return $this->trigger("$event:after", $object_type, $object, $options);
    }

    public function triggerSequence($event, $object_type, $object = null, callable $callable = null, array $options = []) {
        if (!$this->triggerBefore($event, $object_type, $object, $options)) {
            return false;
        }

        $result = $this->trigger($event, $object_type, $object, $options);
        if (!$result) {
            return false;
        }

        if ($callable) {
            $result = call_user_func($callable, $object);
        }

        $this->triggerAfter($event, $object_type, $object, $options);

        return $result;
    }

    public function triggerDeprecated($event, $object_type, $object = null, $message = null, $version = null) {
        $options = [
            self::OPTION_DEPRECATION_MESSAGE => $message,
            self::OPTION_DEPRECATION_VERSION => $version,
        ];
        return $this->trigger($event, $object_type, $object, $options);
    }
    
    public function triggerDeprecatedSequence($event, $object_type, $object = null, callable $callable = null, string $message = null, string $version = null) {
        $options = [
            self::OPTION_DEPRECATION_MESSAGE => $message,
            self::OPTION_DEPRECATION_VERSION => $version,
        ];
        return $this->triggerSequence($event, $object_type, $object, $callable, $options);
    }
}