HooksRegistrationService.php

Go to the documentation of this file.

<?php
namespace Elgg;

abstract class 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])) {
            $matcher = $this->getMatcher($callback);

            foreach ($this->handlers[$name][$type] as $key => $handler) {
                if ($matcher) {
                    if (!$matcher->matches($handler)) {
                        continue;
                    }
                } else {
                    if ($handler != $callback) {
                        continue;
                    }
                }

                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]);
    }

    public 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 getMatcher($spec) {
        if (is_string($spec) && false !== strpos($spec, '::')) {
            list ($type, $method) = explode('::', $spec, 2);
            return new MethodMatcher($type, $method);
        }

        if (!is_array($spec) || empty($spec[0]) || empty($spec[1]) || !is_string($spec[1])) {
            return null;
        }

        if (is_object($spec[0])) {
            $spec[0] = get_class($spec[0]);
        }

        if (!is_string($spec[0])) {
            return null;
        }

        return new MethodMatcher($spec[0], $spec[1]);
    }
}