eXpansion\Framework\Core\Services\ChatCommands

Complexity

Total Complexity

15

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

79.55%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	registerPlugin()	0	13	3
A	deletePlugin()	0	11	3
A	getChatCommand()	0	4	1
A	getChatCommands()	0	15	2
A	findChatCommand()	0	14	3
A	addCommand()	0	11	2

<?php

namespace eXpansion\Framework\Core\Services;

use eXpansion\Framework\Core\DataProviders\Listener\ChatCommandInterface as ChatCommandPluginInterface;
use eXpansion\Framework\Core\Exceptions\ChatCommand\CommandExistException;
use eXpansion\Framework\Core\Model\ChatCommand\ChatCommandInterface;

/**
 * Class ChatCommands store all currently active chat commands.
 *
 * @package eXpansion\Framework\Core\Services;
 * @author oliver de Cramer <oliverde8@gmail.com>
 */
class ChatCommands
{
    /** @var ChatCommandInterface[] */
    protected $commands = array();

    /** @var ChatCommandInterface[] */
    protected $commandPlugin;

    /** @var int  */
    protected $depth = 3;

    /**
     * ChatCommands constructor.
     * @param int $depth
     */
    public function __construct($depth)
    {
        $this->depth = $depth;
    }


    /**
     * Register chat commands of a plugin.
     *
     * @param string $pluginId
     * @param ChatCommandPluginInterface $pluginService
     *
     * @throws CommandExistException
     */
    public function registerPlugin($pluginId, ChatCommandPluginInterface $pluginService)
    {
        $commands = $pluginService->getChatCommands();

        foreach ($commands as $command)
        {
            $this->addCommand($pluginId, $command->getCommand(), $command);

            foreach ($command->getAliases() as $alias) {
                $this->addCommand($pluginId, $alias, $command);
            }
        }
    }

    /**
     * Remove all chat commands registered for a plugin.
     *
     * @param $pluginId
     */
    public function deletePlugin($pluginId)
    {
        if (!isset($this->commandPlugin[$pluginId])) {
            return;
        }

        foreach ($this->commandPlugin[$pluginId] as $cmdTxt => $command) {

The expression $this->commandPlugin[$pluginId] of type object<eXpansion\Framework\Core\Model\ChatCommand\ChatCommandInterface> is not traversable.

            unset($this->commands[$cmdTxt]);
        }
        unset($this->commandPlugin[$pluginId]);
    }

    /**
     * Get a chat command.
     *
     * @param string[] $cmdAndArgs
     * @return array
     */
    public function getChatCommand($cmdAndArgs)
    {
        return $this->findChatCommand($cmdAndArgs, $this->depth);
    }

    /**
     * Get list of all chat commands;
     *
     * return array
     */
    public function getChatCommands()
    {
        $chatCommands = [];
        foreach ($this->commands as $chatCommand => $data)
        {
            $chatCommands[] = [
                'command' => $chatCommand,
                'description' => $data->getDescription(),
                'help' => $data->getHelp(),
                'aliases' => $data->getAliases()
            ];
        }

        return $chatCommands;
    }

    /**
     * @param string[] $cmdAndArgs
     * @param integer $depth
     *
     * @return mixed
     */
    protected function findChatCommand($cmdAndArgs, $depth)
    {
        if ($depth == 0) {
            return [null, []];
        }

        $parameters = array_splice($cmdAndArgs, $depth - 1, 100);
        $cmdAndArgs = array_splice($cmdAndArgs, 0, $depth);
        $command = implode(' ', $cmdAndArgs);

        return isset($this->commands[$command])
            ? [$this->commands[$command], $parameters]
            : $this->findChatCommand($cmdAndArgs, $depth - 1);
    }

    /**
     *
     * @param string $pluginId
     * @param string $cmdTxt
     * @param ChatCommandInterface $command
     *
     * @throws CommandExistException
     */
    protected function addCommand($pluginId, $cmdTxt, ChatCommandInterface $command)
    {
        if (isset($this->commands[$cmdTxt])) {
            throw new CommandExistException(
                "$pluginId tries to register command '$cmdTxt' already registered"
            );
        }

        $this->commands[$cmdTxt] = $command;
        $this->commandPlugin[$pluginId][$cmdTxt] = $command;
    }
}