PluginHooksService.php

Go to the documentation of this file.

<?php
namespace Elgg;

use Elgg\HooksRegistrationService\Hook as HrsHook;

class PluginHooksService extends HooksRegistrationService {

    private $events;

    public function __construct(EventsService $events) {
        $this->events = $events;
    }

    public function trigger($name, $type, $params = null, $value = null, array $options = []) {

        // check for deprecation
        $this->checkDeprecation($name, $type, $options);
        
        // 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.
        $hook = 'hook';
        /* @var Hook|string $hook */

        $handlers = $this->events->getHandlersService();

        foreach ($this->getOrderedHandlers($name, $type) as $handler) {
            $exit_warning = null;

            if (in_array($name, ['forward', 'action', 'route'])) {
                // assume the handler is going to exit the request...
                $exit_warning = function () use ($name, $type, $handler, $handlers) {
                    $this->logDeprecatedMessage(
                        "'{$name}', '{$type}' plugin hook should not be used to serve a response. Instead return an "
                        . "appropriate ResponseBuilder instance from an action or page handler. Do not terminate "
                        . "code execution with exit() or die() in {$handlers->describeCallable($handler)}",
                        '2.3'
                    );
                };
                $this->events->registerHandler('shutdown', 'system', $exit_warning);
            }

            list($success, $return, $hook) = $handlers->call($handler, $hook, [$name, $type, $value, $params]);

            if ($exit_warning) {
                // an exit did not occur, so no need for the warning...
                $this->events->unregisterHandler('shutdown', 'system', $exit_warning);
            }

            if (!$success) {
                continue;
            }
            if ($return !== null) {
                $value = $return;
                if ($hook instanceof HrsHook) {
                    $hook->setValue($return);
                }
            }
        }

        return $value;
    }
    
    public function triggerDeprecated($name, $type, $params = null, $value = null, $message = null, $version = null) {
        $options = [
            self::OPTION_DEPRECATION_MESSAGE => $message,
            self::OPTION_DEPRECATION_VERSION => $version,
        ];
        
        return $this->trigger($name, $type, $params, $value, $options);
    }

    public function registerHandler($name, $type, $callback, $priority = 500) {
        if (($name == 'view' || $name == 'view_vars') && $type !== 'all') {
            $type = ViewsService::canonicalizeViewName($type);
        }

        return parent::registerHandler($name, $type, $callback, $priority);
    }
    
    public function unregisterHandler($name, $type, $callback) {
        if (($name == 'view' || $name == 'view_vars') && $type != 'all') {
            $type = ViewsService::canonicalizeViewName($type);
        }
        
        return parent::unregisterHandler($name, $type, $callback);
    }
}