PluginHooksService.php

Go to the documentation of this file.

<?php
namespace Elgg;
use Elgg\Debug\Inspector;

class PluginHooksService extends \Elgg\HooksRegistrationService {

    public function trigger($hook, $type, $params = null, $returnvalue = null) {
        $hooks = $this->getOrderedHandlers($hook, $type);

        foreach ($hooks as $callback) {
            if (!is_callable($callback)) {
                if ($this->logger) {
                    $inspector = new Inspector();
                    $this->logger->warn("handler for plugin hook [$hook, $type] is not callable: "
                            . $inspector->describeCallable($callback));
                }
                continue;
            }

            $exit_warning = function() use ($hook, $type, $callback) {
                $inspector = new Inspector();
                elgg_deprecated_notice(
                    "'$hook', '$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 {$inspector->describeCallable($callback)}",
                    '2.3'
                );
            };
            
            if (in_array($hook, ['forward', 'action', 'route'])) {
                _elgg_services()->events->registerHandler('shutdown', 'system', $exit_warning);
            }

            $args = array($hook, $type, $returnvalue, $params);
            $temp_return_value = call_user_func_array($callback, $args);
            if (!is_null($temp_return_value)) {
                $returnvalue = $temp_return_value;
            }

            if (in_array($hook, ['forward', 'action', 'route'])) {
                _elgg_services()->events->unregisterHandler('shutdown', 'system', $exit_warning);
            }
        }
        
        return $returnvalue;
    }

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

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