iranianpep/botonomous

<?php

namespace Botonomous\plugin\help;

use Botonomous\Command;
use Botonomous\plugin\AbstractPlugin;
use Botonomous\utility\FormattingUtility;

/**
 * Class Help.
 */
class Help extends AbstractPlugin
{
    /**
     * @throws \Exception
     *
     * @return string
     */
    public function index(): string
    {
        $allCommands = $this->getSlackbot()->getCommands();

        $response = '';
        if (!empty($allCommands)) {
            $formattingUtility = (new FormattingUtility());

            foreach ($allCommands as $commandName => $commandObject) {
                if (!$commandObject instanceof Command) {
                    continue;
                }

                $response .= "/{$commandName} - ".$commandObject->getDescription().$formattingUtility->newLine();
            }
        }

        return $response;
    }
}