bluetree-service / symfony-console-style

src/Style.php

<?php

declare(strict_types=1);

namespace BlueConsole;

use Symfony\Component\Console\Style\SymfonyStyle;

class Style extends SymfonyStyle
{
    use AdditionalStyles;

    public const DAY_SECONDS = 86400;

    /**
     * @param bool $newLine
     * @return Style
     * @throws \Exception
     */
    public function timer(bool $newLine = true): self
    {
        $this->write($this->getTimer());

        if ($newLine) {
            $this->newLine();
        }

        return $this;
    }

    /**
     * @param string $section
     * @param string $message
     * @param string $style
     * @return $this
     * @throws \Exception
     * @throws \InvalidArgumentException
     */
    public function formatSection(string $section, string $message, string $style = 'info'): self
    {
        $timer = $this->getTimer(true);

        $this->writeln(
            $timer . $this->formatter->formatSection(
                $section,
                $message,
                $style
            )
        );

        return $this;
    }

    /**
     * @param string|array $messages
     * @param string $style
     * @param bool $large
     * @return $this
     * @throws \Exception
     * @throws \InvalidArgumentException
     * @noinspection MissingParameterTypeDeclarationInspection
     */
    public function formatBlock($messages, string $style, bool $large = false): self
    {
        $timer = $this->getTimer(true);

        if (!\is_array($messages)) {
            $messages = [$messages];
        }

        foreach ($messages as $message) {
            $this->writeln(
                $timer . $this->formatter->formatBlock(
                    $message,
                    $style,
                    $large
                )
            );
        }

        return $this;
    }

    /**
     * @param array $message
     * @return $this
     * @throws \Exception
     * @throws \InvalidArgumentException
     */
    public function errorLine(array $message): self
    {
        return $this->formatBlock($message, 'error');
    }

    /**
     * @param $message
     * @return $this
     * @throws \InvalidArgumentException
     * @throws \Exception
     */
    public function okMessage(string $message): self
    {
        return $this->renderBlock('  <info>OK</info>  ', $message);
    }

    /**
     * @param $message
     * @return $this
     * @throws \InvalidArgumentException
     * @throws \Exception
     */
    public function errorMessage(string $message): self
    {
        return $this->renderBlock(' <fg=red>FAIL</> ', $message);
    }

    /**
     * @param string $message
     * @return $this
     * @throws \InvalidArgumentException
     * @throws \Exception
     */
    public function warningMessage(string $message): self
    {
        return $this->renderBlock(' <comment>WARN</comment> ', $message);
    }

    /**
     * @param string $message
     * @return $this
     * @throws \InvalidArgumentException
     * @throws \Exception
     */
    public function infoMessage(string $message): self
    {
        return $this->renderBlock(' <fg=blue>INFO</> ', $message);
    }

    /**
     * @param string $block
     * @param string $message
     * @return Style
     * @throws \Exception
     */
    public function renderBlock(string $block, string $message): self
    {
        $timer = $this->getTimer(true);
        $alignment = $this->align(8, $this->align);

        $this->write("{$timer}[$block]");
        $this->write($alignment);
        $this->writeln($message);

        return $this;
    }

    /**
     * @param string $message
     * @return $this
     * @throws \InvalidArgumentException
     * @throws \Exception
     */
    public function note($message): self
    {
        return $this->genericBlock($message, 'blue', 'note');
    }

    /**
     * @param string $message
     * @return $this
     * @throws \InvalidArgumentException
     * @throws \Exception
     */
    public function caution($message): self
    {
        return $this->genericBlock($message, 'magenta', 'caution');
    }

    /**
     * @param string $message
     * @return $this
     * @throws \InvalidArgumentException
     * @throws \Exception
     */
    public function success($message): self
    {
        return $this->genericBlock($message, 'green', 'success');
    }

    /**
     * @param string $message
     * @return $this
     * @throws \InvalidArgumentException
     * @throws \Exception
     */
    public function warning($message): self
    {
        return $this->genericBlock($message, 'yellow', 'warning');
    }

    /**
     * @param string $message
     * @return $this
     * @throws \InvalidArgumentException
     * @throws \Exception
     */
    public function error($message): self
    {
        return $this->genericBlock($message, 'red', 'error');
    }

    /**
     * @param string $message
     * @param string $background
     * @param string|null $type
     * @param int $length
     * @return $this
     * @throws \InvalidArgumentException
     * @throws \Exception
     */
    public function genericBlock(string $message, string $background, ?string $type, int $length = 100): self
    {
        if (\trim($type) === '') {

It seems like $type can also be of type null; however, parameter $string of trim() does only seem to accept string, maybe add an additional type check?

            return $this;
        }

        $type = \strtoupper($type);

It seems like $type can also be of type null; however, parameter $string of strtoupper() does only seem to accept string, maybe add an additional type check?

        $alignment = $this->align(0, $length);
        $alignmentMessage = $this->align($message, $length - (\mb_strlen($type) + 5));

        $timer = $this->getTimer(true);
        $timer ? $this->writeln($timer) : null;

        $this->writeln("<bg=$background>$alignment</>");
        $this->writeln("<fg=white;bg=$background>  [$type] $message$alignmentMessage</>");
        $this->writeln("<bg=$background>$alignment</>");
        $this->newLine();

        return $this;
    }

    public function floatingProgressBar(): void
    {
        
    }

    public function longRunCommand(string $command): void

The parameter $command is not used and could be removed.

    {
        //[ ***  ]
    }

    /**
     * @todo add multi line block
     */

    /*
        http://symfony.com/doc/current/components/console/helpers/formatterhelper.html
        https://symfony.com/doc/current/console/style.html
    */
}