HooksRegistrationService.php

Go to the documentation of this file.

<?php

abstract class Elgg_HooksRegistrationService {

    private $handlers = array();

    protected $logger;

    public function setLogger(Elgg_Logger $logger = null) {
        $this->logger = $logger;
        return $this;
    }

    public function registerHandler($name, $type, $callback, $priority = 500) {
        if (empty($name) || empty($type) || !is_callable($callback, true)) {
            return false;
        }

        if (!isset($this->handlers[$name])) {
            $this->handlers[$name] = array();
        }

        if (!isset($this->handlers[$name][$type])) {
            $this->handlers[$name][$type] = array();
        }

        // Priority cannot be lower than 0
        $priority = max((int) $priority, 0);

        while (isset($this->handlers[$name][$type][$priority])) {
            $priority++;
        }

        $this->handlers[$name][$type][$priority] = $callback;
        ksort($this->handlers[$name][$type]);

        return true;
    }

    public function unregisterHandler($name, $type, $callback) {
        if (isset($this->handlers[$name]) && isset($this->handlers[$name][$type])) {
            foreach ($this->handlers[$name][$type] as $key => $name_callback) {
                if ($name_callback == $callback) {
                    unset($this->handlers[$name][$type][$key]);
                    return true;
                }
            }
        }

        return false;
    }

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

    public function hasHandler($name, $type) {
        return isset($this->handlers[$name][$type]);
    }

    protected function getOrderedHandlers($name, $type) {
        $handlers = array();

        if (isset($this->handlers[$name][$type])) {
            if ($name != 'all' && $type != 'all') {
                $handlers = array_merge($handlers, array_values($this->handlers[$name][$type]));
            }
        }
        if (isset($this->handlers['all'][$type])) {
            if ($type != 'all') {
                $handlers = array_merge($handlers, array_values($this->handlers['all'][$type]));
            }
        }
        if (isset($this->handlers[$name]['all'])) {
            if ($name != 'all') {
                $handlers = array_merge($handlers, array_values($this->handlers[$name]['all']));
            }
        }
        if (isset($this->handlers['all']['all'])) {
            $handlers = array_merge($handlers, array_values($this->handlers['all']['all']));
        }

        return $handlers;
    }

    protected function describeCallable($callable) {
        if (is_string($callable)) {
            return $callable;
        }
        if (is_array($callable) && array_keys($callable) === array(0, 1) && is_string($callable[1])) {
            if (is_string($callable[0])) {
                return "{$callable[0]}::{$callable[1]}";
            }
            return "(" . get_class($callable[0]) . ")->{$callable[1]}";
        }
        if ($callable instanceof Closure) {
            $ref = new ReflectionFunction($callable);
            $file = $ref->getFileName();
            $line = $ref->getStartLine();
            return "(Closure {$file}:{$line})";
        }
        if (is_object($callable)) {
            return "(" . get_class($callable) . ")->__invoke()";
        }
        return "(unknown)";
    }
}