RegisteredCommand.php

<?php

declare(strict_types=1);

/*
 * This file is a part of the DiscordPHP project.
 *
 * Copyright (c) 2015-present David Cole <david.cole1340@gmail.com>
 *
 * This file is subject to the MIT license that is bundled
 * with this source code in the LICENSE.md file.
 */

namespace Discord\Helpers;

use Discord\Discord;
use Discord\Parts\Interactions\Interaction;
use Discord\Parts\Interactions\Request\Option;

/**
 * RegisteredCommand represents a command that has been registered with the
 * Discord servers and has a handler to handle when the command is triggered.
 *
 * https://discord.com/developers/docs/interactions/application-commands
 *
 * @since 7.0.0
 *
 * @author David Cole <david.cole1340@gmail.com>
 */
class RegisteredCommand
{
    /**
     * The Discord client.
     *
     * @var Discord Client.
     */
    protected $discord;

    /**
     * The name of the command.
     *
     * @var string
     */
    private $name;

    /**
     * The callback to be called when the command is triggered.
     *
     * @var callable
     */
    private $callback;

    /**
     * The callback to be called when the auto complete is triggered.
     *
     * @var callable
     */
    private $autocomplete_callback;

    /**
     * Array of sub-commands.
     *
     * @var RegisteredCommand[]
     */
    private $subCommands;

    /**
     * RegisteredCommand represents a command that has been registered with the
     * Discord servers and has a handler to handle when the command is triggered.
     *
     * @param Discord       $discord
     * @param string        $name
     * @param callable|null $callback
     * @param callable|null $autocomplete_callback Callback returning list of auto complete suggestions
     */
    public function __construct(Discord $discord, string $name, ?callable $callback = null, ?callable $autocomplete_callback = null)
    {
        $this->discord = $discord;
        $this->name = $name;
        $this->callback = $callback;
        $this->autocomplete_callback = $autocomplete_callback;
    }

    /**
     * Executes the command. Will search for a sub-command if given, otherwise
     * executes the callback, if given.
     *
     * @param ExCollectionInterface<Option>|Option[] $options
     * @param Interaction                            $interaction
     *
     * @return bool Whether the command successfully executed.
     */
    public function execute($options, Interaction $interaction): bool
    {
        $params = Collection::for(Option::class, 'name');

        foreach ($options as $option) {
            if (isset($this->subCommands[$option->name])) {
                if ($this->subCommands[$option->name]->execute($option->options ?? [], $interaction)) {
                    return true;
                }
            }
            $params->pushItem($this->discord->getFactory()->part(Option::class, (array) $option, true));
        }

        if (isset($this->callback)) {
            ($this->callback)($interaction, $params);

            return true;
        }

        return false;
    }

    /**
     * Executes the command. Will search for a sub-command if given, otherwise
     * executes the callback, if given.
     *
     * @param ApplicationCommand|ApplicationCommandAutocomplete $interaction
     *
     * @return bool Whether the command successfully executed.
     */
    public function suggest(Interaction $interaction): bool
    {
        if (is_callable($this->autocomplete_callback)) {
            $choice = ($this->autocomplete_callback)($interaction);
            if (is_array($choice)) {
                $interaction->autoCompleteResult($choice);
            }

            return true;
        }

        return false;
    }

    /**
     * Sets the callback for the command.
     *
     * @param callable $callback
     */
    public function setCallback(callable $callback): void
    {
        $this->callback = $callback;
    }

    /**
     * Sets the callback for the auto complete suggestion.
     *
     * @param callable $autocomplete_callback
     */
    public function setAutoCompleteCallback(callable $autocomplete_callback): void
    {
        $this->autocomplete_callback = $autocomplete_callback;
    }

    /**
     * Tries to get a sub-command if exists.
     *
     * @param string $name
     *
     * @return RegisteredCommand|null
     */
    public function getSubCommand(string $name): ?RegisteredCommand
    {
        return $this->subCommands[$name] ?? null;
    }

    /**
     * Adds a sub-command to the command.
     *
     * @param string[]|string $names
     * @param callable|null   $callback
     * @param callable|null   $autocomplete_callback
     *
     * @throws \LogicException
     *
     * @return static
     */
    public function addSubCommand(array|string $names, ?callable $callback = null, ?callable $autocomplete_callback = null): RegisteredCommand
    {
        if (is_string($names)) {
            $names = [$names];
        }

        foreach($names as $subCommand){

            if (isset($this->subCommands[$subCommand])) {
                throw new \LogicException("The command `{$subCommand}` already exists.");
            }

            $this->subCommands[$subCommand] = new static($this->discord, $subCommand, $callback, $autocomplete_callback);
        }

        return $this;
    }

    /**
     * Get command name.
     *
     * @return string
     */
    public function getName(): string
    {
        return $this->name;
    }

    /**
     * Get sub commands.
     *
     * @return RegisteredCommand[]|null
     */
    public function getSubCommands(): ?array
    {
        return $this->subCommands;
    }
}