LFFATE / ccg

app/controllers/HelpTrait.php

<?php

namespace controllers;

use terminal\Terminal;
use filesystem\Filesystem;
use \Config;

trait HelpTrait
{
    function __construct(

It is generally recommended to explicitly declare the visibility for methods.

        Config              $config,
        Terminal            $terminal,
        Filesystem          $filesystem
    )
    {
        $this->config               = $config;

The property config does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->terminal             = $terminal;

The property terminal does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->filesystem           = $filesystem;

The property filesystem does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    public function help($search = '')
    {
        $this->terminal->echo('Usage: php ccg.php [generator] [command] [options]');

        $docs = $this->getHelp();

        array_walk($docs, function(array $doc) use ($search) {

            if ($search && strpos($doc['name'], $search) === false) {
                return;
            }

            $this->terminal->echo(str_repeat(PHP_EOL, 2));

            $docLines           = preg_split('/\r\n|\r|\n/', $doc['help']);
            $descriptionLines   = $docLines;

            unset($descriptionLines[0]);

            $this->terminal->success($docLines[0]);
            $this->terminal->echo(implode(PHP_EOL, $descriptionLines));

It seems like $descriptionLines can also be of type false; however, parameter $pieces of implode() does only seem to accept array, maybe add an additional type check?

        });
    }

    public function getHelp()
    {
        $ref = new \ReflectionClass($this);
        $methods = $ref->getMethods();

        $docs = array_map(function(\ReflectionMethod $method) {
            $helpCommentPurified = '';
            $helpComment = self::_extractCommentForHelp($method->getDocComment() ?: '');

It seems like $method->getDocComment() ?: '' can also be of type true; however, parameter $comment of controllers\HelpTrait::_extractCommentForHelp() does only seem to accept string, maybe add an additional type check?

            if (!empty($helpComment)) {
                $helpCommentPurified = self::_purifyCommentForHelp($helpComment[1]);
            }

            return [
                'name' => $method->getName(),
                'help' => $helpCommentPurified,
            ];
        }, $methods);

        $docsFiltered = array_values(
            array_filter($docs, function($doc) {
                return (bool) $doc['help'];
            })
        );

        return $docsFiltered;
    }

    /**
     * @todo test
     */
    private static function _extractCommentForHelp(string $comment): array
    {
        preg_match('/\/\*{2}\s+\*\shelp:\s+(.*)/usmi', $comment, $matches);

        return $matches;
    }

    /**
     * @todo test
     */
    private static function _purifyCommentForHelp(string $comment): string
    {
        $clearedComment = trim(preg_replace('/(\*\s)|(\*\/)/sm', '', $comment));
        $indentedComment = implode(
            PHP_EOL . str_repeat(' ', 8),
            preg_split('/\r\n|\r|\n/', $clearedComment)

It seems like preg_split('/\r\n|\r|\n/', $clearedComment) can also be of type false; however, parameter $pieces of implode() does only seem to accept array, maybe add an additional type check?

        );

        return $indentedComment;
    }
}