turnaev / monitor-bundle

src/Check/CheckPluginFinder.php

<?php

/**
 * This file is part of the `tvi/monitor-bundle` project.
 *
 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Tvi\MonitorBundle\Check;

use Symfony\Component\Finder\Finder;

/**

Missing short description in doc comment

 * @author Vladimir Turnaev <turnaev@gmail.com>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class CheckPluginFinder
{
    protected $searchExps = [__DIR__.'/**', __DIR__.'/**/**'];

    public function __construct(array $exps = null)

Missing doc comment for function __construct()

    {
        if ($exps) {
            $this->addSearchExps($exps);
        }
    }

    public function addCheckPluginFinderPath(CheckPluginFinderPath $checkPluginFinderPath)

Missing doc comment for function addCheckPluginFinderPath()

The type Tvi\MonitorBundle\Check\CheckPluginFinderPath was not found. Maybe you did not declare it correctly or list all dependencies?

    {
        foreach ($checkPluginFinderPath->getPathes() as $path) {
            $this->addSearchExps($path);
        }
    }

    public function addSearchExps($exps)

Missing doc comment for function addSearchExps()

    {
        $exps = \is_string($exps) ? [$exps] : $exps;

        $this->searchExps = array_merge($this->searchExps, $exps);
        $this->searchExps = array_unique($this->searchExps);
    }

    /**

Missing short description in doc comment

     * @return string[]
     */
    public function find()
    {
        $fs = Finder::create();
        $res = [];
        foreach ($this->searchExps as $searchExp) {
            try {
                $files = $fs->in($searchExp)->name('Plugin.php')->files();

                foreach ($files as $f) {
                    /* @var \SplFileInfo $f */

                    $code = $f->getContents();

The method getContents() does not exist on SplFileInfo. It seems like you code against a sub-type of SplFileInfo such as Symfony\Component\Finder\SplFileInfo or Symfony\Component\Finder\Tests\Iterator\MockSplFileInfo.

                    $class = $this->getConfigClass($code);

                    if (is_subclass_of($class, CheckPluginInterface::class)) {
                        $res[] = $class;
                    }
                }

            } catch (\InvalidArgumentException $e) {}

Consider adding a comment why this CATCH block is empty.

Closing brace must be on a line by itself

        };

        return array_unique($res);
    }

    private function getConfigClass($contents)

Private method name "CheckPluginFinder::getConfigClass" must be prefixed with an underscore

Missing doc comment for function getConfigClass()

    {
        $namespace = [];
        $class = [];

        $tokens = token_get_all($contents);

        do {
            $token = current($tokens);

            if (isset($token[0]) && T_NAMESPACE === $token[0]) {
                next($tokens);
                do {
                    $token = current($tokens);
                    if (';' === $token) {
                        break 1;
                    }
                    $namespace[] = $token[1];
                } while (next($tokens));

                $namespace = trim(implode('', $namespace));
            }

            if (isset($token[0]) && T_CLASS === $token[0]) {
                next($tokens);
                do {
                    $token = current($tokens);

                    if (T_STRING === $token[0]) {
                        $class[] = $token[1];
                        break 1;
                    }
                } while (next($tokens));

                $class = trim(implode('', $class));

                break;
            }
        } while (next($tokens));

        return (string) $namespace.'\\'.(string) $class;
    }
}