hhxsv5 / laravel-s

src/Illuminate/CleanerManager.php

<?php

Missing file doc comment

namespace Hhxsv5\LaravelS\Illuminate;

use Hhxsv5\LaravelS\Illuminate\Cleaners\BaseCleaner;
use Hhxsv5\LaravelS\Illuminate\Cleaners\CleanerInterface;
use Hhxsv5\LaravelS\Illuminate\Cleaners\ConfigCleaner;
use Hhxsv5\LaravelS\Illuminate\Cleaners\ContainerCleaner;
use Hhxsv5\LaravelS\Illuminate\Cleaners\CookieCleaner;
use Hhxsv5\LaravelS\Illuminate\Cleaners\RequestCleaner;
use Illuminate\Container\Container;

The type Illuminate\Container\Container was not found. Maybe you did not declare it correctly or list all dependencies?

class CleanerManager

Missing doc comment for class CleanerManager

{
    /**

Missing short description in doc comment

     * @var Container
     */
    protected $currentApp;
    /**

Missing short description in doc comment

     * @var Container
     */
    protected $snapshotApp;

    /**@var ReflectionApp */

Missing short description in doc comment

The close comment tag must be the only content on the line

The open comment tag must be the only content on the line

    protected $reflectionApp;

    /**
     * All cleaners
     * @var CleanerInterface[]

There must be exactly one blank line before the tags in a doc comment

     */
    protected $cleaners = [
        ContainerCleaner::class,
        ConfigCleaner::class,
        CookieCleaner::class,
        RequestCleaner::class,
    ];

    /**
     * Service providers to be cleaned up
     * @var array

There must be exactly one blank line before the tags in a doc comment

     */
    protected $providers = [];

    /**
     * White list of controllers to be destroyed
     * @var array

There must be exactly one blank line before the tags in a doc comment

     */
    protected $whiteListControllers = [];

    /**

Missing short description in doc comment

     * @var array
     */
    protected $config = [];

    /**
     * CleanerManager constructor.
     *
     * @param Container $currentApp

Missing parameter comment

     * @param Container $snapshotApp

Missing parameter comment

     * @param array $config

Expected 5 spaces after parameter type; 1 found

Missing parameter comment

     */
    public function __construct(Container $currentApp, Container $snapshotApp, array $config)
    {
        $this->currentApp = $currentApp;
        $this->snapshotApp = $snapshotApp;
        $this->reflectionApp = new ReflectionApp($this->currentApp);
        $this->config = $config;
        $this->registerCleaners(isset($this->config['cleaners']) ? $this->config['cleaners'] : []);
        $this->registerCleanProviders(isset($config['register_providers']) ? $config['register_providers'] : []);
        $this->registerCleanControllerWhiteList(isset($this->config['destroy_controllers']['excluded_list']) ? $this->config['destroy_controllers']['excluded_list'] : []);
    }

    /**
     * Register singleton cleaners to application container.
     * @param array $cleaners

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

     */

Missing @return tag in function comment

    protected function registerCleaners(array $cleaners)
    {
        $this->cleaners = array_unique(array_merge($cleaners, $this->cleaners));
        foreach ($this->cleaners as $class) {
            $this->currentApp->singleton($class, function () use ($class) {

The opening parenthesis of a multi-line function call should be the last content on the line.

                $cleaner = new $class($this->currentApp, $this->snapshotApp);
                if (!($cleaner instanceof BaseCleaner)) {
                    throw new \InvalidArgumentException(sprintf(

The opening parenthesis of a multi-line function call should be the last content on the line.

                            '%s must extend the abstract class %s',

This line of the multi-line function call does not seem to be indented correctly. Expected 24 spaces, but found 28.

                            $cleaner,

$cleaner of type object is incompatible with the type double|integer|string expected by parameter $values of sprintf().

This line of the multi-line function call does not seem to be indented correctly. Expected 24 spaces, but found 28.

                            BaseCleaner::class

This line of the multi-line function call does not seem to be indented correctly. Expected 24 spaces, but found 28.

                        )

This line of the multi-line function call does not seem to be indented correctly. Expected 20 spaces, but found 24.

                    );
                }
                return $cleaner;
            });

For multi-line function calls, the closing parenthesis should be on a new line.

        }
    }

    /**
     * Clean app after request finished.
     */

Missing @return tag in function comment

    public function clean()
    {
        foreach ($this->cleaners as $class) {
            /**@var BaseCleaner $cleaner */

Missing short description in doc comment

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

            $cleaner = $this->currentApp->make($class);
            $cleaner->clean();
        }
    }

    /**

Parameter $providers should have a doc-comment as per coding-style.

     * Register providers for cleaning.
     *
     * @param array providers

The type Hhxsv5\LaravelS\Illuminate\providers was not found. Maybe you did not declare it correctly or list all dependencies?

Missing parameter name

     */

Missing @return tag in function comment

    protected function registerCleanProviders(array $providers = [])
    {
        $this->providers = $providers;
    }

    /**
     * Clean Providers.
     */

Missing @return tag in function comment

    public function cleanProviders()
    {
        $loadedProviders = $this->reflectionApp->loadedProviders();

        foreach ($this->providers as $provider) {
            if (class_exists($provider)) {
                if ($this->config['is_lumen']) {
                    unset($loadedProviders[get_class(new $provider($this->currentApp))]);
                }

                switch ($this->reflectionApp->registerMethodParameterCount()) {
                    case 1:

Line indented incorrectly; expected 16 spaces, found 20

                        $this->currentApp->register($provider);
                        break;
                    case 2:

Line indented incorrectly; expected 16 spaces, found 20

                        $this->currentApp->register($provider, true);
                        break;
                    case 3:

Line indented incorrectly; expected 16 spaces, found 20

                        $this->currentApp->register($provider, [], true);
                        break;
                    default:

Line indented incorrectly; expected 16 spaces, found 20

                        throw new \RuntimeException('The number of parameters of the register method is unknown.');
                }
            }
        }

        if ($this->config['is_lumen']) {
            $this->reflectionApp->setLoadedProviders($loadedProviders);
        }
    }

    /**

Parameter $controllers should have a doc-comment as per coding-style.

     * Register white list of controllers for cleaning.
     *
     * @param array providers

Missing parameter name

     */

Missing @return tag in function comment

    protected function registerCleanControllerWhiteList(array $controllers = [])
    {
        $controllers = array_unique($controllers);
        $this->whiteListControllers = array_combine($controllers, $controllers);
    }

    /**
     * Clean controllers.
     */

Missing @return tag in function comment

    public function cleanControllers()
    {
        if ($this->config['is_lumen']) {
            return;
        }

        if (empty($this->config['destroy_controllers']['enable'])) {
            return;
        }

        /**@var \Illuminate\Routing\Route $route */

The open comment tag must be the only content on the line

The close comment tag must be the only content on the line

Missing short description in doc comment

        $route = $this->currentApp['router']->current();
        if (!$route) {

$route is of type Illuminate\Routing\Route, thus it always evaluated to true.

            return;
        }

        if (isset($route->controller)) { // For Laravel 5.4+
            if (empty($this->whiteListControllers) || !isset($this->whiteListControllers[get_class($route->controller)])) {
                unset($route->controller);
            }
        } else {
            $reflection = new \ReflectionClass(get_class($route));
            if ($reflection->hasProperty('controller')) { // Laravel 5.3
                $controller = $reflection->getProperty('controller');
                $controller->setAccessible(true);
                if (empty($this->whiteListControllers) || (($instance = $controller->getValue($route)) && !isset($this->whiteListControllers[get_class($instance)]))) {
                    $controller->setValue($route, null);
                }
            }
        }
    }
}