CleanerManager::cleanProviders() - Code Metrics - Inspection of "support configurable destroy controller to avoid c..." - hhxsv5/laravel-s - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 845957...e458ee )

by Biao
created 2019-06-27 07:01 UTC
CleanerManager::cleanProviders() B

↳ Parent: CleanerManager
Complexity

Conditions	8
Paths	18
Size

Total Lines	28
Code Lines	19
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	8
eloc	19
nc	18
nop	1
dl	0
loc	28
rs	8.4444
c	0
b	0
f	0
<?php

namespace Hhxsv5\LaravelS\Illuminate;

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

class CleanerManager
{
    /**
     * @var Container
     */
    protected $app;

    /**
     * All cleaners
     * @var CleanerInterface[]
     */
    protected $cleaners = [
        ConfigCleaner::class,
        CookieCleaner::class,
        RequestCleaner::class,
    ];

    /**
     * Service providers to be cleaned up
     * @var array
     */
    protected $providers = [];

    /**
     * White list of controllers to be destroyed
     * @var array
     */
    protected $whiteListControllers = [];

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

    /**
     * CleanerManager constructor.
     *
     * @param Container $app
     * @param array $config
     */
    public function __construct(Container $app, array $config)
    {
        $this->app = $app;
        $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
     */
    protected function registerCleaners(array $cleaners)
    {
        $this->cleaners = array_unique(array_merge($cleaners, $this->cleaners));
        foreach ($this->cleaners as $cleaner) {
            $this->app->singleton($cleaner, function () use ($cleaner) {
                if (!isset(class_implements($cleaner)[CleanerInterface::class])) {
                    throw new \InvalidArgumentException(sprintf(
                            '%s must implement the interface %s',
                            $cleaner,
                            CleanerInterface::class
                        )
                    );
                }
                return new $cleaner();
            });
        }
    }

    /**
     * Clean app after request finished.
     *
     * @param Container $snapshotApp
     */
    public function clean($snapshotApp)
    {
        foreach ($this->cleaners as $cleanerCls) {
            /**@var CleanerInterface $cleaner */
            $cleaner = $this->app->make($cleanerCls);
            $cleaner = $this->app->make(/** @scrutinizer ignore-type */ $cleanerCls);
            $cleaner->clean($this->app, $snapshotApp);
        }
    }


    /**
     * Register providers for cleaning.
     *
     * @param array providers
filter:
    dependency_paths: ["lib/*"]
     */
    protected function registerCleanProviders(array $providers = [])
    {
        $this->providers = $providers;
    }

    /**
     * Clean Providers.
     *
     * @param ReflectionApp $reflectionApp
     * @throws \ReflectionException
     */
    public function cleanProviders(ReflectionApp $reflectionApp)
    {
        $loadedProviders = $reflectionApp->loadedProviders();

        foreach ($this->providers as $provider) {
            if (class_exists($provider, false)) {
                if ($this->isLumen()) {
                    unset($loadedProviders[get_class(new $provider($this->app))]);
                }

                switch ($reflectionApp->registerMethodParameterCount()) {
                    case 1:
                        $this->app->register($provider);
                                    register($provider);
                        break;
                    case 2:
                        $this->app->register($provider, true);
                        break;
                    case 3:
                        $this->app->register($provider, [], true);
                        break;
                    default:
                        throw new \RuntimeException('The number of parameters of the register method is unknown.');
                }
            }
        }

        if ($this->isLumen()) {
            $reflectionApp->setLoadedProviders($loadedProviders);
        }
    }

    /**
     * Register white list of controllers for cleaning.
     *
     * @param array providers
     */
    protected function registerCleanControllerWhiteList(array $controllers = [])
    {
        $controllers = array_unique($controllers);
        $this->whiteListControllers = array_combine($controllers, $controllers);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Clean controllers.
     */
    public function cleanControllers()
    {
        if ($this->isLumen()) {
            return;
        }

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

        /**@var \Illuminate\Routing\Route $route */
        $route = $this->app['router']->current();
        if (!$route) {

            return;
        }

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

    /**
     * Determine if is lumen.
     *
     * @return bool
     */
    protected function isLumen()
    {
        return $this->config['is_lumen'];
    }
}

hhxsv5 / laravel-s

Push — master ( 845957...e458ee )

CleanerManager::cleanProviders() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
