FrontWidget::enabled() - Code Metrics - Inspection of "Apply app::factory method. Fix widgets, add checks" - phpffcms/ffcms - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 9d7fc3...820a38 )

by Mihail

created 2016-08-06 11:26 UTC

FrontWidget::enabled() A

↳ Parent: FrontWidget

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	1

Metric	Value
cc	3
eloc	9
c	1
b	1
f	1
nc	3
nop	1
dl	0
loc	18
rs	9.4285

<?php
namespace Extend\Core\Arch;

use Ffcms\Core\App;
use Ffcms\Core\Arch\Widget as NativeWidget;
use Apps\ActiveRecord\App as AppRecord;
use Ffcms\Core\Helper\Type\Str;

/**
 * Class FrontWidget. Special controller type for front widgets.
 * @package Extend\Core\Arch
 */
class FrontWidget extends NativeWidget
{
    public static $name;

    /**
     * Display widget compiled data.
     * @param array|null $params
     * @return null|string
     * @throws \Exception
     */
    public static function widget(array $params = null)
    {
        if (!self::enabled()) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
            return null;
        }

        // call parent method
        return parent::widget($params);
    }

    /**
     * Check if widget is enabled
     * @param string|null $name
     * @return bool
     */
    public static function enabled($name = null)

    {
        // get widget class-namespace callback and single class name
        self::$class = get_called_class();
        self::$name = Str::lastIn(self::$class, '\\', true);

        $wData = AppRecord::getItem('widget', self::$name);

        // widget is not founded, deny run
        if ($wData === null) {
            if (App::$Debug !== null) {
                App::$Debug->addMessage(__('Widget with name %name%[%class%] is not found', ['name' => self::$name, 'class' => self::$class]));
            }
            return null;
        }

        // if widget is disabled - lets return nothing
        return !(bool)$wData->disabled;
    }

}

1			<?php
2			namespace Extend\Core\Arch;
3
4			use Ffcms\Core\App;
5			use Ffcms\Core\Arch\Widget as NativeWidget;
6			use Apps\ActiveRecord\App as AppRecord;
7			use Ffcms\Core\Helper\Type\Str;
8
9			/**
10			* Class FrontWidget. Special controller type for front widgets.
11			* @package Extend\Core\Arch
12			*/
13			class FrontWidget extends NativeWidget
14			{
15			public static $name;
16
17			/**
18			* Display widget compiled data.
19			* @param array\|null $params
20			* @return null\|string
21			* @throws \Exception
22			*/
23			public static function widget(array $params = null)
24			{
25			if (!self::enabled()) {
			0 ignored issues – show Bug Best Practice introduced 2016-08-06 11:36 UTC by Report Bug Copy Issue Report The expression `self::enabled()` of type `null\|boolean` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
26			return null;
27			}
28
29			// call parent method
30			return parent::widget($params);
31			}
32
33			/**
34			* Check if widget is enabled
35			* @param string\|null $name
36			* @return bool
37			*/
38			public static function enabled($name = null)
			0 ignored issues – show Unused Code introduced 2016-08-06 11:36 UTC by Report Bug Copy Issue Report The parameter `$name` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
39			{
40			// get widget class-namespace callback and single class name
41			self::$class = get_called_class();
42			self::$name = Str::lastIn(self::$class, '\\', true);
43
44			$wData = AppRecord::getItem('widget', self::$name);
			0 ignored issues – show Security Bug introduced 2016-08-06 11:36 UTC by Report Bug Copy Issue Report It seems like `self::$name` can also be of type `false`; however, `Apps\ActiveRecord\App::getItem()` does only seem to accept `string\|array`, did you maybe forget to handle an error condition? Loading history...
45			// widget is not founded, deny run
46			if ($wData === null) {
47			if (App::$Debug !== null) {
48			App::$Debug->addMessage(__('Widget with name %name%[%class%] is not found', ['name' => self::$name, 'class' => self::$class]));
49			}
50			return null;
51			}
52
53			// if widget is disabled - lets return nothing
54			return !(bool)$wData->disabled;
55			}
56
57			}

phpffcms / ffcms

Push — master ( 9d7fc3...820a38 )

FrontWidget::enabled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like