Application::isModuleDependent() - Code Metrics - Inspection of "added param search" - samsoncms/cms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#29)

by Dima

created 2016-03-02 12:26 UTC

Application::isModuleDependent() A

↳ Parent: Application

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	2	Features	0

Metric	Value
c	2
b	2
f	0
dl	0
loc	4
rs	10
cc	2
eloc	2
nc	2
nop	1

<?php
namespace samsoncms\cms;

use samson\core\CompressableExternalModule;
use samsonphp\event\Event;
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 bool Flag that currently we are woring in SamsonCMS */
    protected $isCMS = false;

    public function init(array $params = array())
    {
        //trace('cmsInit');
        // 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'));

        //[PHPCOMPRESSOR(remove,start)]

        $moduleList   = $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 (!$this->isModuleDependent($module) && $id != 'core' && !$this->ifModuleRelated($module)) {
                unset($moduleList[$id]);
            }
        }

        // Generate resources for new module
        $this->system->module('resourcer')->generateResources($moduleList, $this->path() . 'app/view/index.php');
        //[PHPCOMPRESSOR(remove,end)]


        // Call parent initialization
        return parent::init($params);
    }

    /**
     * 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 isCMS()
    {
        return $this->isCMS;
    }

    public function activeModuleHandler($module)
    {
        // Define if routed module is related to SamsonCMS
        if($this->isCMS = $this->ifModuleRelated($module)){
            // TODO: This should be removed - Reparse url
            url()->parse();

            // Switch template to SamsonCMS
            $this->system->template($this->path() . 'app/view/index.php', 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) {
            array_unshift($urlParams, $this->baseUrl);
        }
    }

    public function parseUrl(&$urlObj, &$urlArgs)
    {
        if ($this->isCMS) {
            array_shift($urlArgs);
        }
    }

    /**
     * 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 sizeof(preg_grep('/samsoncms\\\\/i', array_merge(array(get_class($module)), class_parents($module))));
    }

    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'] : '');
    }
}


Pull Request — master (#29)

Application::isModuleDependent() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2			namespace samsoncms\cms;
3
4			use samson\core\CompressableExternalModule;
5			use samsonphp\event\Event;
6			use samsonphp\router\Module;
7
8			/**
9			* SamsonCMS external compressible application for integrating
10			* @author Vitaly Iegorov <[email protected]>
11			*/
12			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...
13			{
14			const EVENT_IS_CMS = 'samsonsms.is.cms';
15
16			/** @var string Module identifier */
17			public $id = 'cms';
18
19			public $baseUrl = 'cms';
20
21			/** @var bool Flag that currently we are woring in SamsonCMS */
22			protected $isCMS = false;
23
24			public function init(array $params = array())
25			{
26			//trace('cmsInit');
27			// Old applications main page rendering
28			Event::subscribe('template.main.rendered', array($this, 'oldMainRenderer'));
29			// Old applications menu rendering
30			Event::subscribe('template.menu.rendered', array($this, 'oldMenuRenderer'));
31
32			Event::subscribe('samson.url.build', array($this, 'buildUrl'));
33
34			Event::subscribe('samson.url.args.created', array($this, 'parseUrl'));
35
36			Event::subscribe(Module::EVENT_ROUTE_FOUND, array($this, 'activeModuleHandler'));
37
38			Event::subscribe('samsonphp.router.create.module.routes', array($this, 'updateCMSPrefix'));
39
40			//[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...
41			$moduleList = $this->system->module_stack;
			0 ignored issues – show Bug introduced 2016-01-24 16:11 UTC by Report Bug Copy Issue Report Accessing `module_stack` on the interface `samsonframework\core\SystemInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
42			foreach ($this->system->module_stack as $id => $module) {
			0 ignored issues – show Bug introduced 2016-01-24 16:11 UTC by Report Bug Copy Issue Report Accessing `module_stack` on the interface `samsonframework\core\SystemInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
43			if (!$this->isModuleDependent($module) && $id != 'core' && !$this->ifModuleRelated($module)) {
44			unset($moduleList[$id]);
45			}
46			}
47
48			// Generate resources for new module
49			$this->system->module('resourcer')->generateResources($moduleList, $this->path() . 'app/view/index.php');
50			//[PHPCOMPRESSOR(remove,end)]
			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...
51
52			// Call parent initialization
53			return parent::init($params);
54			}
55
56			/**
57			* If module is dependent from current module through composer.json.
58			*
59			* @param $module Module for checking
60			* @return bool True if module dependent
61			*/
62			protected function isModuleDependent($module)
63			{
64			return isset($module->composerParameters['composerName']) && in_array($module->composerParameters['composerName'], $this->composerParameters['required']);
65			}
66
67			public function isCMS()
68			{
69			return $this->isCMS;
70			}
71
72			public function activeModuleHandler($module)
73			{
74			// Define if routed module is related to SamsonCMS
75			if($this->isCMS = $this->ifModuleRelated($module)){
76			// TODO: This should be removed - Reparse url
77			url()->parse();
78
79			// Switch template to SamsonCMS
80			$this->system->template($this->path() . 'app/view/index.php', true);
81
82			Event::fire(self::EVENT_IS_CMS, array(&$this));
83			}
84			}
85
86			/**
87			* Callback for adding SamsonCMS related modules prefix to routes.
88			*
89			* @param $module
90			* @param $prefix
91			*/
92			public function updateCMSPrefix($module, &$prefix)
93			{
94			if (($module->id != $this->id) && $this->ifModuleRelated($module)) {
95			$prefix = '/' . $this->baseUrl . $prefix;
96			}
97			}
98
99			public function buildUrl(&$urlObj, &$httpHost, &$urlParams)
100			{
101			if ($this->isCMS) {
102			array_unshift($urlParams, $this->baseUrl);
103			}
104			}
105
106			public function parseUrl(&$urlObj, &$urlArgs)
107			{
108			if ($this->isCMS) {
109			array_shift($urlArgs);
110			}
111			}
112
113			/**
114			* Check if passed module is related to SamsonCMS.
115			* Also method stores data to flag variable.
116			*
117			* @param $module
118			*
119			* @return bool True if module related to SamsonCMS
120			*/
121			public function ifModuleRelated($module)
122			{
123			// Analyze if module class or one of its parents has samsoncms\ namespace pattern
124			return sizeof(preg_grep('/samsoncms\\\\/i', array_merge(array(get_class($module)), class_parents($module))));
125			}
126
127			public function __base()
128			{
129			$templateModule = $this->system->module('template');
130
131			// Switch system to SamsonCMS template module
132			$this->system->active($templateModule);
133
134			// Call template handler
135			$templateModule->__handler();
136			}
137
138			public function oldMainRenderer(&$html)
139			{
140			// Render application main page block
141			foreach (\samsoncms\Application::loaded() as $app) {
			0 ignored issues – show Deprecated Code introduced 2015-12-11 14:25 UTC by Report Bug Copy Issue Report The method `samsoncms\Application::loaded()` has been deprecated. This method has been deprecated. Loading history...
142			// Show only visible apps
143			if ($app->hide == false /&& $app->findView('sub_menu')/) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-15 11:20 UTC by Report Bug Copy Issue Report `75%` 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...
144			$html .= $app->main();
			0 ignored issues – show Deprecated Code introduced 2016-01-24 16:11 UTC by Report Bug Copy Issue Report The method `samsoncms\Application::main()` has been deprecated with message: Subscribe to samsoncms/template event This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
145			}
146			}
147			}
148
149			/**
150			* @deprecated All application should draw menu block via events
151			*/
152			public function oldMenuRenderer(&$html, &$subMenu)
			0 ignored issues – show Coding Style introduced 2016-02-26 08:45 UTC by Report Bug Copy Issue Report `oldMenuRenderer` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // 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); } } Loading history...
153			{
154			// Iterate loaded samson\cms\application
155			foreach (\samsoncms\Application::loaded() as $app) {
			0 ignored issues – show Deprecated Code introduced 2015-12-11 14:25 UTC by Report Bug Copy Issue Report The method `samsoncms\Application::loaded()` has been deprecated. This method has been deprecated. Loading history...
156			// Show only visible apps
157			if ($app->hide == false) {
158			// Render application menu item
159			$html .= m('template')
			0 ignored issues – show Deprecated Code introduced 2016-01-24 16:11 UTC by Report Bug Copy Issue Report The function `m()` has been deprecated with message: Use $this->system->module() in module context This function 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 function will be removed from the class and what other function to use instead. Loading history...
160			->view('menu/item')
161			->active(url()->module == $app->id() ? 'active' : '')
162			->app($app)
163			->icon($app->icon)
164			->name(isset($app->name{0}) ? $app->name : '')
165			->output();
166			}
167			}
168			$subMenu = '';
169			// Find current SamsonCMS application
170			if (\samsoncms\Application::find(url()->module, $app/@var $app App/)) {
171			// If module has sub_menu view - render it
172			if ($app->findView('sub_menu')) {
173			// Explode url by symbols '/'
174			$url = explode('/', $_SERVER['REQUEST_URI']);
175			// If isset url with params search and param page equal 0
176			if (isset($url[4]) && $url[3] != 'form') {
177			// Default value for search field
178			$paramSearch = urldecode($url[4]);
179			// Set params search
180			$app->set($paramSearch, 'search');
181			}
182
183			$subMenu .= $app->view('sub_menu')->set(t($app->name, true), 'appName')->output();
184			}
185			}
186			}
187
188			/**
189			* @deprecated
190			* @return string Page title
191			*/
192			public function oldGetTitle()
193			{
194			$local = m('local');
			0 ignored issues – show Deprecated Code introduced 2016-01-24 16:11 UTC by Report Bug Copy Issue Report The function `m()` has been deprecated with message: Use $this->system->module() in module context This function 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 function will be removed from the class and what other function to use instead. Loading history...
195			$current = m();
			0 ignored issues – show Deprecated Code introduced 2016-01-24 16:11 UTC by Report Bug Copy Issue Report The function `m()` has been deprecated with message: Use $this->system->module() in module context This function 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 function will be removed from the class and what other function to use instead. Loading history...
196
197			return isset($current['title']) ? $current['title'] :
198			(isset($local['title']) ? $local['title'] : '');
199			}
200			}
201

samsoncms / cms

Pull Request — master (#29)

Application::isModuleDependent() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like