Application::getModuleList() - Code Metrics - Inspection of "Update Application.php" - samsoncms/cms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d33e41...a89c3c )

by Nikita

created 2016-08-16 19:10 UTC

Application::getModuleList() A

↳ Parent: Application

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
rs	9.4285
cc	1
eloc	4
nc	1
nop	1

<?php
namespace samsoncms\cms;

use samson\core\CompressableExternalModule;
use samson\core\SamsonLocale;
use samsonphp\compressor\Compressor;
use samsonphp\event\Event;
use samsonphp\resource\Router;
use samsonphp\router\Module;

/**
 * SamsonCMS external compressible application for integrating
 * @author Vitaly Iegorov <[email protected]>
 */
class Application extends CompressableExternalModule

{
    const EVENT_IS_CMS = 'samsonsms.is.cms';

    /** @var string Module identifier */
    public $id = 'cms';

    public $baseUrl = 'cms';

    /** @var array Collection of SamsonCMS related modules */
    protected $cmsModuleList = [];

    protected $projectModuleList = [];

    /** @var bool Flag that currently we are woring in SamsonCMS */
    protected $isCMS = false;

    protected $template = '';

    //[PHPCOMPRESSOR(remove,start)]


    protected function prepareModuleList()
    {
        // Gather all project specific modules that do not dependent to SamsonCMS
        $parentDependencies = [];
        foreach ($this->system->module_stack as $id => $module) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            // Module dependency at project level composer.json and is not this module
            if (array_key_exists('projectRequireDev', $module->composerParameters) && $module->composerParameters['projectRequireDev'] === true && $id !== $this->id()) {
                $parentDependencies = array_merge($module->composerParameters['required'], [$module->composerParameters['composerName']], $parentDependencies);
            }
        }
        // Remove duplicates
        $parentDependencies = array_unique($parentDependencies);

        // Gather project-only related modules
        $this->projectModuleList = [];
        $this->cmsModuleList = $this->system->module_stack;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        foreach ($this->system->module_stack as $id => $module) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            if (!array_key_exists('composerName', $module->composerParameters)) {
                $this->projectModuleList[$id] = $module;
            } elseif (array_key_exists('composerName', $module->composerParameters) && in_array($module->composerParameters['composerName'], $parentDependencies)) {
                $this->projectModuleList[$id] = $module;
            }
            if (!$this->isModuleDependent($module) && $id !== 'core' && !$this->ifModuleRelated($module)) {
                unset($this->cmsModuleList[$id]);
            }
        }
    }

    /**
     * Remove unnecessary modules list for SamsonCMS from loaded modules
     * and return left modules.
     *
     * @param array $otherModuleList List of SamsonCMS unneeded modules
     */
    public function filterModuleList(&$otherModuleList = [])
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $this->prepareModuleList();

        $otherModuleList = $this->projectModuleList;

        /**
         * Change modules list between main web-application and SamsonCMS
         */
        // TODO: As this is processed before routing than we just check URL
        if ($this->isCMS() || strpos($_SERVER['REQUEST_URI'], '/'.$this->id.'/') !== false) {
            // Switch module list to SamsonCMS module list
            $otherModuleList = $this->cmsModuleList;
        }
    }


    /** SamsonCMS preparation stage handler */
    public function prepare()
    {
        /**
         * Subscribe for router resource initialization to remove SamsonCMS modules as we will generate
         * SamsonCMS resources manually
         */
        Event::subscribe(Router::EVENT_START_GENERATE_RESOURCES, [$this, 'filterModuleList']);

    }

    /**
     * If module is dependent from current module through composer.json.
     *
     * @param $module Module for checking
     * @return bool True if module dependent
     */
    protected function isModuleDependent($module)
    {
        return isset($module->composerParameters['composerName']) && in_array($module->composerParameters['composerName'], $this->composerParameters['required']);
    }

    public function getModuleList(& $moduleListArray)
    {
        $this->prepareModuleList();
        $moduleListArray[Router::I_MAIN_PROJECT_TEMPLATE] = $this->projectModuleList;
        $moduleListArray[$this->template] = $this->cmsModuleList;
    }

    //[PHPCOMPRESSOR(remove,end)]



    /**
     * Check if passed module is related to SamsonCMS.
     * Also method stores data to flag variable.
     *
     * @param $module
     *
     * @return bool True if module related to SamsonCMS
     */
    public function ifModuleRelated($module)
    {
        // Analyze if module class or one of its parents has samsoncms\ namespace pattern
        return count(preg_grep('/samsoncms\\\\/i', array_merge(array(get_class($module)), class_parents($module))));
    }

    /**
     * SamsonCMS initialization stage handler
     *
     * @param array $params Initialization parameters
     *
     * @return bool Initialization stage result
     */
    public function init(array $params = array())
    {
        // Old applications main page rendering
        Event::subscribe('template.main.rendered', array($this, 'oldMainRenderer'));

        // Old applications menu rendering
        Event::subscribe('template.menu.rendered', array($this, 'oldMenuRenderer'));

        Event::subscribe('samson.url.build', array($this, 'buildUrl'));

        Event::subscribe('samson.url.args.created', array($this, 'parseUrl'));

        Event::subscribe(Module::EVENT_ROUTE_FOUND, array($this, 'activeModuleHandler'));

        Event::subscribe('samsonphp.router.create.module.routes', array($this, 'updateCMSPrefix'));

        Event::subscribe(Compressor::E_CREATE_MODULE_LIST, array($this, 'getModuleList'));

        //url()->parse();

        $this->template = $this->path() . 'app/view/index.php';

        // Generate resources for new module
        //[PHPCOMPRESSOR(remove,start)]

        //$this->system->module('resourcer')->generateResources($this->cmsModuleList, $this->path() . 'app/view/index.php');

        //[PHPCOMPRESSOR(remove,end)]

    }

    public function isCMS()
    {
        return $this->isCMS;
    }

    public function activeModuleHandler($module)
    {
        // Define if routed module is related to SamsonCMS
        if($this->isCMS = $this->ifModuleRelated($module)){
$answer = 42;

$correct = false;

$correct = (bool) $answer;
            // TODO: This should be removed - Reparse url

            url()->parse();

            // Switch template to SamsonCMS
            $this->system->template($this->template, true);

            Event::fire(self::EVENT_IS_CMS, array(&$this));
        }
    }

    /**
     * Callback for adding SamsonCMS related modules prefix to routes.
     *
     * @param $module
     * @param $prefix
     */
    public function updateCMSPrefix($module, &$prefix)
    {
        if (($module->id != $this->id) && $this->ifModuleRelated($module)) {
            $prefix = '/' . $this->baseUrl . $prefix;
        }
    }

    public function buildUrl(&$urlObj, &$httpHost, &$urlParams)
    {
        if ($this->isCMS) {
            if (in_array($urlParams[0], SamsonLocale::get(), true)) {
                array_splice($urlParams, 1, 0, array($this->baseUrl));
                $urlParams = array_values($urlParams);
            } else {
                array_unshift($urlParams, $this->baseUrl);
            }
        }
    }

    public function parseUrl(&$urlObj, &$urlArgs)
    {
        if ($this->isCMS) {
            if (in_array($urlArgs[0], SamsonLocale::get(), true)) {
                unset($urlArgs[1]);
                $urlArgs = array_values($urlArgs);
            } else {
                array_shift($urlArgs);
            }
        }
    }

    public function __base()
    {
        $templateModule = $this->system->module('template');

        // Switch system to SamsonCMS template module
        $this->system->active($templateModule);

        // Call template handler
        $templateModule->__handler();
    }

    public function oldMainRenderer(&$html)
    {
        // Render application main page block
        foreach (\samsoncms\Application::loaded() as $app) {

            // Show only visible apps
            if ($app->hide == false /*&& $app->findView('sub_menu')*/) {

                $html .= $app->main();

            }
        }
    }

    /**
     * @deprecated All application should draw menu block via events
     */
    public function oldMenuRenderer(&$html, &$subMenu)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        // Iterate loaded samson\cms\application
        foreach (\samsoncms\Application::loaded() as $app) {

            // Show only visible apps
            if ($app->hide == false) {
                // Render application menu item
                $html .= m('template')

                    ->view('menu/item')
                    ->active(url()->module == $app->id() ? 'active' : '')
                    ->app($app)
                    ->icon($app->icon)
                    ->name(isset($app->name{0}) ? $app->name : '')
                    ->output();
            }
        }
        $subMenu = '';
        // Find current SamsonCMS application
        if (\samsoncms\Application::find(url()->module, $app/*@var $app App*/)) {
            // If module has sub_menu view - render it
            if ($app->findView('sub_menu')) {
                // Explode url by symbols '/'
                $url = explode('/', $_SERVER['REQUEST_URI']);
                // If isset url with params search and param page equal 0
                if (isset($url[4]) && $url[3] != 'form') {
                    // Default value for search field
                    $paramSearch = urldecode($url[4]);
                    // Set params search
                    $app->set($paramSearch, 'search');
                }
				
                $subMenu .= $app->view('sub_menu')->set(t($app->name, true), 'appName')->output();
            }
        }
    }

    /**
     * @deprecated
     * @return string Page title
     */
    public function oldGetTitle()
    {
        $local   = m('local');

        $current = m();


        return isset($current['title']) ? $current['title'] :
            (isset($local['title']) ? $local['title'] : '');
    }
}


Push — master ( d33e41...a89c3c )

Application::getModuleList() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			namespace samsoncms\cms;
3
4			use samson\core\CompressableExternalModule;
5			use samson\core\SamsonLocale;
6			use samsonphp\compressor\Compressor;
7			use samsonphp\event\Event;
8			use samsonphp\resource\Router;
9			use samsonphp\router\Module;
10
11			/**
12			* SamsonCMS external compressible application for integrating
13			* @author Vitaly Iegorov <[email protected]>
14			*/
15			class Application extends CompressableExternalModule
			0 ignored issues – show Deprecated Code introduced 2016-01-24 16:11 UTC by Report Bug Copy Issue Report The class `samson\core\CompressableExternalModule` has been deprecated with message: Just implement samsonframework\core\CompressInterface This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
16			{
17			const EVENT_IS_CMS = 'samsonsms.is.cms';
18
19			/** @var string Module identifier */
20			public $id = 'cms';
21
22			public $baseUrl = 'cms';
23
24			/** @var array Collection of SamsonCMS related modules */
25			protected $cmsModuleList = [];
26
27			protected $projectModuleList = [];
28
29			/** @var bool Flag that currently we are woring in SamsonCMS */
30			protected $isCMS = false;
31
32			protected $template = '';
33
34			//[PHPCOMPRESSOR(remove,start)]
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-05 17:25 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
35
36			protected function prepareModuleList()
37			{
38			// Gather all project specific modules that do not dependent to SamsonCMS

samsoncms / cms

Push — master ( d33e41...a89c3c )

Application::getModuleList() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like