Zikula\Bundle\HookBundle\Collector\HookCollector

Complexity

Total Complexity

27

Size/Duplication

Total Lines	180
Duplicated Lines	3.33 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	addProvider()	0	9	2
A	getProvider()	0	4	2
A	hasProvider()	0	4	1
A	getProviders()	0	4	1
A	getProviderAreas()	0	4	1
A	getProviderAreasByOwner()	0	4	2
A	addSubscriber()	0	8	2
A	getSubscriber()	0	4	2
A	hasSubscriber()	0	4	1
A	getSubscribers()	0	4	1
A	getSubscriberAreas()	0	4	1
A	getSubscriberAreasByOwner()	0	4	2
A	isCapable()	3	13	3
A	getOwnersCapableOf()	3	10	2
A	containsSelfAllowedProvider()	0	12	4

<?php

/*
 * This file is part of the Zikula package.
 *
 * Copyright Zikula Foundation - http://zikula.org/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zikula\Bundle\HookBundle\Collector;

use Zikula\Bundle\HookBundle\HookProviderInterface;
use Zikula\Bundle\HookBundle\HookSelfAllowedProviderInterface;
use Zikula\Bundle\HookBundle\HookSubscriberInterface;

class HookCollector implements HookCollectorInterface
{
    /**
     * @var HookProviderInterface[]
     * e.g. [<areaName> => <serviceObject>]
     */
    private $providerHooks = [];

    /**
     * @var array
     * e.g. [<moduleName> => [<areaName> => <serviceObject>, <areaName> => <serviceObject>, ...]]
     */
    private $providersByOwner = [];

    /**
     * @var HookSubscriberInterface[]
     * e.g. [<areaName> => <serviceObject>]
     */
    private $subscriberHooks = [];

    /**
     * @var array
     * e.g. [<moduleName> => [<areaName> => <serviceObject>, <areaName> => <serviceObject>, ...]]
     */
    private $subscribersByOwner = [];

    /**
     * {@inheritdoc}
     */
    public function addProvider($areaName, $serviceId, HookProviderInterface $service)
    {
        if (isset($this->providerHooks[$areaName])) {
            throw new \InvalidArgumentException('Attempting to register a hook provider with a duplicate area name. (' . $areaName . ')');
        }
        $service->setServiceId($serviceId);
        $this->providerHooks[$areaName] = $service;
        $this->providersByOwner[$service->getOwner()][$areaName] = $service;
    }

    /**
     * {@inheritdoc}
     */
    public function getProvider($areaName)
    {
        return isset($this->providerHooks[$areaName]) ? $this->providerHooks[$areaName] : null;
    }

    /**
     * {@inheritdoc}
     */
    public function hasProvider($areaName)
    {
        return isset($this->providerHooks[$areaName]);
    }

    /**
     * {@inheritdoc}
     */
    public function getProviders()
    {
        return $this->providerHooks;
    }

    /**
     * {@inheritdoc}
     */
    public function getProviderAreas()
    {
        return array_keys($this->providerHooks);
    }

    /**
     * {@inheritdoc}
     */
    public function getProviderAreasByOwner($owner)
    {
        return isset($this->providersByOwner[$owner]) ? array_keys($this->providersByOwner[$owner]) : [];
    }

    /**
     * {@inheritdoc}
     */
    public function addSubscriber($areaName, HookSubscriberInterface $service)
    {
        if (isset($this->subscriberHooks[$areaName])) {
            throw new \InvalidArgumentException('Attempting to register a hook subscriber with a duplicate area name. (' . $areaName . ')');
        }
        $this->subscriberHooks[$areaName] = $service;
        $this->subscribersByOwner[$service->getOwner()][$areaName] = $service;
    }

    /**
     * {@inheritdoc}
     */
    public function getSubscriber($areaName)
    {
        return isset($this->subscriberHooks[$areaName]) ? $this->subscriberHooks[$areaName] : null;
    }

    /**
     * {@inheritdoc}
     */
    public function hasSubscriber($areaName)
    {
        return isset($this->subscriberHooks[$areaName]);
    }

    /**
     * {@inheritdoc}
     */
    public function getSubscribers()
    {
        return $this->subscriberHooks;
    }

    /**
     * {@inheritdoc}
     */
    public function getSubscriberAreas()
    {
        return array_keys($this->subscriberHooks);
    }

    /**
     * {@inheritdoc}
     */
    public function getSubscriberAreasByOwner($owner)
    {
        return isset($this->subscribersByOwner[$owner]) ? array_keys($this->subscribersByOwner[$owner]) : [];
    }

    /**
     * {@inheritdoc}
     */
    public function isCapable($moduleName, $type = self::HOOK_SUBSCRIBER)
    {
        if (!in_array($type, [self::HOOK_SUBSCRIBER, self::HOOK_PROVIDER, self::HOOK_SUBSCRIBE_OWN])) {

This code seems to be duplicated across your project.

            throw new \InvalidArgumentException('Only hook_provider, hook_subscriber and subscriber_own are valid values.');
        }
        if (self::HOOK_SUBSCRIBE_OWN == $type) {
            return $this->containsSelfAllowedProvider($moduleName);
        }
        $variable = substr($type, 5) . 'sByOwner';
        $array = $this->$variable;

        return isset($array[$moduleName]);
    }

    /**
     * {@inheritdoc}
     */
    public function getOwnersCapableOf($type = self::HOOK_SUBSCRIBER)
    {
        if (!in_array($type, [self::HOOK_SUBSCRIBER, self::HOOK_PROVIDER])) {

This code seems to be duplicated across your project.

            throw new \InvalidArgumentException('Only hook_provider and hook_subscriber are valid values.');
        }
        $variable = substr($type, 5) . 'sByOwner';
        $array = $this->$variable;

        return array_keys($array);
    }

    /**
     * Does $moduleName contain at least one SelfAllowedProvider?
     * @param $moduleName
     * @return bool
     */
    private function containsSelfAllowedProvider($moduleName)
    {
        if (isset($this->providersByOwner[$moduleName])) {
            foreach ($this->providersByOwner[$moduleName] as $provider) {
                if ($provider instanceof HookSelfAllowedProviderInterface) {
                    return true;
                }
            }
        }

        return false;
    }
}