WidgetContentControllerExtension::handleWidget() - Code Metrics - Inspection of "Enhancement: SilverStripe 4 compatibility" - silverstripe/silverstripe-widgets - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#143)

by Robbie

created 2017-01-18 03:14 UTC

WidgetContentControllerExtension::handleWidget() D

↳ Parent: WidgetContentControllerExtension

Complexity

Conditions	9
Paths	20

Size

Total Lines	40
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	40
rs	4.909
c	0
b	0
f	0
cc	9
eloc	21
nc	20
nop	0

<?php

namespace SilverStripe\Widgets\Controllers;

use SilverStripe\Core\Extension;
use SilverStripe\Widgets\Model\WidgetArea;

/**
 * Add this to ContentController to enable widgets
 *
 * @package widgets
 */
class WidgetContentControllerExtension extends Extension
{
    /**
     *
     * @var array
     */
    private static $allowed_actions = array(

        'handleWidget'
    );

    /**
     * Handles widgets attached to a page through one or more {@link WidgetArea}
     * elements.
     *
     * Iterated through each $has_one relation with a {@link WidgetArea} and
     * looks for connected widgets by their database identifier.
     *
     * Assumes URLs in the following format: <URLSegment>/widget/<Widget-ID>.
     *
     * @return RequestHandler
     */
    public function handleWidget()
    {
        $SQL_id = $this->owner->getRequest()->param('ID');
        if (!$SQL_id) {
            return false;
class Author {
    private $name;

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

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        // find WidgetArea relations
        $widgetAreaRelations = array();
        $hasOnes = $this->owner->data()->hasOne();

        if (!$hasOnes) {
            return false;
class Author {
    private $name;

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

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        foreach ($hasOnes as $hasOneName => $hasOneClass) {
            if ($hasOneClass == WidgetArea::class || is_subclass_of($hasOneClass, WidgetArea::class)) {

                $widgetAreaRelations[] = $hasOneName;
            }
        }

        // find widget
        $widget = null;

        foreach ($widgetAreaRelations as $widgetAreaRelation) {
            if ($widget) {
                break;
            }

            $widget = $this->owner->data()->$widgetAreaRelation()->Widgets()
                ->filter('ID', $SQL_id)
                ->First();
        }

        if (!$widget) {
            user_error('No widget found', E_USER_ERROR);
        }

        return $widget->getController();
    }
}


1			<?php
2
3			namespace SilverStripe\Widgets\Controllers;
4
5			use SilverStripe\Core\Extension;
6			use SilverStripe\Widgets\Model\WidgetArea;
7
8			/**
9			* Add this to ContentController to enable widgets
10			*
11			* @package widgets
12			*/
13			class WidgetContentControllerExtension extends Extension
14			{
15			/**
16			*
17			* @var array
18			*/
19			private static $allowed_actions = array(
			0 ignored issues – show Unused Code introduced 2017-01-18 03:15 UTC by Report Bug Copy Issue Report The property `$allowed_actions` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
20			'handleWidget'
21			);
22
23			/**
24			* Handles widgets attached to a page through one or more {@link WidgetArea}
25			* elements.
26			*
27			* Iterated through each $has_one relation with a {@link WidgetArea} and
28			* looks for connected widgets by their database identifier.
29			*
30			* Assumes URLs in the following format: <URLSegment>/widget/<Widget-ID>.
31			*
32			* @return RequestHandler
33			*/
34			public function handleWidget()
35			{
36			$SQL_id = $this->owner->getRequest()->param('ID');
37			if (!$SQL_id) {
38			return false;
			0 ignored issues – show Bug Best Practice introduced 2017-01-18 03:15 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `SilverStripe\Widgets\Con...Extension::handleWidget` of type `SilverStripe\Widgets\Controllers\RequestHandler`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
39			}
40
41			// find WidgetArea relations
42			$widgetAreaRelations = array();
43			$hasOnes = $this->owner->data()->hasOne();
44
45			if (!$hasOnes) {
46			return false;
			0 ignored issues – show Bug Best Practice introduced 2017-01-18 03:15 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `SilverStripe\Widgets\Con...Extension::handleWidget` of type `SilverStripe\Widgets\Controllers\RequestHandler`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
47			}
48
49			foreach ($hasOnes as $hasOneName => $hasOneClass) {
50			if ($hasOneClass == WidgetArea::class \|\| is_subclass_of($hasOneClass, WidgetArea::class)) {
			0 ignored issues – show Bug introduced 2017-01-18 03:15 UTC by Report Bug Copy Issue Report Due to PHP Bug #53727, `is_subclass_of` might return inconsistent results on some PHP versions if `\SilverStripe\Widgets\Model\WidgetArea::class` can be an interface. If so, you could instead use `ReflectionClass::implementsInterface`. Loading history...
51			$widgetAreaRelations[] = $hasOneName;
52			}
53			}
54
55			// find widget
56			$widget = null;
57
58			foreach ($widgetAreaRelations as $widgetAreaRelation) {
59			if ($widget) {
60			break;
61			}
62
63			$widget = $this->owner->data()->$widgetAreaRelation()->Widgets()
64			->filter('ID', $SQL_id)
65			->First();
66			}
67
68			if (!$widget) {
69			user_error('No widget found', E_USER_ERROR);
70			}
71
72			return $widget->getController();
73			}
74			}
75

silverstripe / silverstripe-widgets

Pull Request — master (#143)

WidgetContentControllerExtension::handleWidget() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like