SimpleStyleguideController::index() - Code Metrics - Inspection of "Add `requires_dev` config" - benmanu/silverstripe-simple-styleguide - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#12)

unknown

created 2019-07-11 08:46 UTC

SimpleStyleguideController::index() B

↳ Parent: SimpleStyleguideController

Complexity

Conditions	6
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	27
rs	8.8657
c	0
b	0
f	0
cc	6
nc	4
nop	0

<?php

namespace BenManu\SimpleStyleguide;

use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\Security\Permission;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\CMS\Controllers\ModelAsController;
use SilverStripe\View\Requirements;
use SilverStripe\View\ArrayData;
use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\TextField;
use SilverStripe\Forms\NumericField;
use SilverStripe\Forms\EmailField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\CheckboxSetField;
use SilverStripe\Forms\OptionsetField;
use SilverStripe\Forms\FormAction;
use SilverStripe\Forms\RequiredFields;
use SilverStripe\Forms\Form;
use SilverStripe\Assets\File;
use SilverStripe\Security\Security;

/**
 * @package simple-styleguide
 */
class SimpleStyleguideController extends Controller
{
    /**
     * @config
     * @var array
     */
    private static $color_swatches = [];

    /**
     * @config
     * @var string
     */
    private static $placeholder_image_url = '/resources/vendor/benmanu/silverstripe-simple-styleguide/images/placeholder.png';

    /**
     * @config
     * @var string
     */
    private static $requires_dev = true;

    /**
     * @var array
     */
    private static $allowed_actions = [

        'index',
    ];

    private static $url_segment = '_styleguide';


    /**
     * Runs the permission checks, and setup of the controller view.
     */
    public function index()
    {
        if ($this->config()->requires_dev && true /*!Director::isDev()*/) {
            return Security::permissionFailure();
        }

        if (!Permission::check('ADMIN')) {
            return Security::permissionFailure();
        }

        // If the subsite module is installed then set the theme based on the current subsite
        if (class_exists('Subsite') && Subsite::currentSubsite()) {
            Config::inst()->update('SSViewer', 'theme', Subsite::currentSubsite()->Theme);
        }

        $page = SiteTree::get()->first();
        $controller = ModelAsController::controller_for($page);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $controller->init();


        // requirements
        Requirements::css('benmanu/silverstripe-simple-styleguide: css/styleguide.css');
        Requirements::javascript('benmanu/silverstripe-simple-styleguide: js/styleguide.js');

        return $controller
            ->customise($this->getStyleGuideData())
            ->renderWith(['SimpleStyleguideController', 'Page']);
    }

    /**
     * Provides access to any custom function on the controller for use on the template output.
     * @return ArrayData
     */
    public function getStyleguideData()
    {
        $data = new ArrayData([
            'Title' => 'Styleguide',
            'Message' => DBField::create_field(
                'HTMLText',
                '<p>This controller is only accessible to developers and admin users.</p>'
            ),
            'TestForm' => $this->getTestForm(),
            'Content' => $this->getContent(),
            'ColorSwatches' => $this->getColorSwatches(),
            'PlaceholderImageURL' => $this->getPlaceholderImageURL(),
        ]);

        // extensions for adding/overriding template data.
        $this->extend('updateStyleguideData', $data);

        return $data;
    }

    /**
     * Return a form with fields to match rendering through controller/template output.
     * @return Form
     */
    public function getTestForm()
    {
        $fields = FieldList::create(
            TextField::create('SimpleText', 'Simple Text Field'),
            TextField::create('SimpleTextGood', 'Simple Text Field (good)'),
            TextField::create('SimpleTextWarning', 'Simple Text Field (warning)'),
            TextField::create('SimpleTextBad', 'Simple Text Field (bad)'),
            NumericField::create('Number', 'Number Field'),
            EmailField::create('Email', "Email Field"),
            DropdownField::create('Dropdown', 'Normal dropdown', [
                '1' => 'One option',
                '2' => 'Two option',
            ]),
            CheckboxField::create('Checkbox', 'Checkbox'),
            CheckboxSetField::create('CheckboxSet', 'Checkbox set', [
                '1' => 'One option',
                '2' => 'Two option',
                '3' => 'Three option',
            ]),
            OptionsetField::create('Option', 'Option', [
                '1' => 'One option',
            ]),
            OptionsetField::create('OptionSet', 'Option set', [
                '1' => 'One option',
                '2' => 'Two option',
                '3' => 'Three option',
            ]),
            TextField::create('Text', 'Text')
                ->setDescription('This is a description')
        );

        $actions = FieldList::create(
            FormAction::create('doForm', 'Submit')
        );

        $required = new RequiredFields(
            'SimpleText',
            'Email',
            'Checkbox',
            'Dropdown'
        );

        $form = new Form($this, 'TestForm', $fields, $actions, $required);
        $form->setMessage('This is a form wide message. See the alerts component for site wide messages.', 'warning');

        $this->extend('updateForm', $form);

        return $form;
    }

    /**
     * Emulate an HTMLEditorField output useful for testing shortcodes and output extensions etc.
     * @return HTMLText

     */
    public function getContent()
    {
        $content = '';

        // add file link to html content
        $file = File::get()->filter('ClassName', 'File')->first();
        if ($file) {
            $content .= '<p>This is an internal <a href="[file_link,id=' . $file->ID . ']">link to a file</a> inside content</p>';
        }

        // add external link to html content
        $content .= '<p>This is an external <a href="http://google.com">link to google</a> inside content.</p>';

        $this->extend('updateContent', $content);

        return DBField::create_field('HTMLText', $content);
    }

    /**
     * @return ArrayList
     */
    public function getColorSwatches()
    {
        $list = ArrayList::create();
        $colors = $this->config()->color_swatches;

        if ($colors) {
            foreach ($colors as $color) {
                $list->push(ArrayData::create($color));
            }
        }

        $this->extend('updateColorSwatches', $list);

        return $list;
    }

    /**
     * @return string
     */
    public function getPlaceholderImageURL()
    {
        $url = $this->config()->placeholder_image_url;

        $this->extend('updatePlaceholderImageURL', $url);

        return $url;
    }
}


1			<?php
2
3			namespace BenManu\SimpleStyleguide;
4
5			use SilverStripe\Control\Controller;
6			use SilverStripe\Control\Director;
7			use SilverStripe\Security\Permission;
8			use SilverStripe\CMS\Model\SiteTree;
9			use SilverStripe\CMS\Controllers\ModelAsController;
10			use SilverStripe\View\Requirements;
11			use SilverStripe\View\ArrayData;
12			use SilverStripe\ORM\FieldType\DBField;
13			use SilverStripe\ORM\ArrayList;
14			use SilverStripe\Forms\FieldList;
15			use SilverStripe\Forms\TextField;
16			use SilverStripe\Forms\NumericField;
17			use SilverStripe\Forms\EmailField;
18			use SilverStripe\Forms\DropdownField;
19			use SilverStripe\Forms\CheckboxField;
20			use SilverStripe\Forms\CheckboxSetField;
21			use SilverStripe\Forms\OptionsetField;
22			use SilverStripe\Forms\FormAction;
23			use SilverStripe\Forms\RequiredFields;
24			use SilverStripe\Forms\Form;
25			use SilverStripe\Assets\File;
26			use SilverStripe\Security\Security;
27
28			/**
29			* @package simple-styleguide
30			*/
31			class SimpleStyleguideController extends Controller
32			{
33			/**
34			* @config
35			* @var array
36			*/
37			private static $color_swatches = [];
38
39			/**
40			* @config
41			* @var string
42			*/
43			private static $placeholder_image_url = '/resources/vendor/benmanu/silverstripe-simple-styleguide/images/placeholder.png';
44
45			/**
46			* @config
47			* @var string
48			*/
49			private static $requires_dev = true;
50
51			/**
52			* @var array
53			*/
54			private static $allowed_actions = [
			0 ignored issues – show Comprehensibility introduced 2017-05-20 04:18 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
55			'index',
56			];
57
58			private static $url_segment = '_styleguide';
			0 ignored issues – show Comprehensibility introduced 2018-02-03 03:01 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
59
60			/**
61			* Runs the permission checks, and setup of the controller view.
62			*/
63			public function index()
64			{
65			if ($this->config()->requires_dev && true /!Director::isDev()/) {
66			return Security::permissionFailure();
67			}
68
69			if (!Permission::check('ADMIN')) {
70			return Security::permissionFailure();
71			}
72
73			// If the subsite module is installed then set the theme based on the current subsite
74			if (class_exists('Subsite') && Subsite::currentSubsite()) {
75			Config::inst()->update('SSViewer', 'theme', Subsite::currentSubsite()->Theme);
76			}
77
78			$page = SiteTree::get()->first();
79			$controller = ModelAsController::controller_for($page);
			0 ignored issues – show Documentation introduced 2018-02-03 03:01 UTC by Report Bug Copy Issue Report `$page` is of type `object<SilverStripe\ORM\DataObject>\|null`, but the function expects a `object<SilverStripe\CMS\Model\SiteTree>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
80			$controller->init();
			0 ignored issues – show Bug introduced 2018-02-03 03:01 UTC by Report Bug Copy Issue Report The method `init()` cannot be called from this context as it is declared protected in class `SilverStripe\CMS\Controllers\ContentController`. This check looks for access to methods that are not accessible from the current context. If you need to make a method accessible to another context you can raise its visibility level in the defining class. Loading history...
81
82			// requirements
83			Requirements::css('benmanu/silverstripe-simple-styleguide: css/styleguide.css');
84			Requirements::javascript('benmanu/silverstripe-simple-styleguide: js/styleguide.js');
85
86			return $controller
87			->customise($this->getStyleGuideData())
88			->renderWith(['SimpleStyleguideController', 'Page']);
89			}
90
91			/**
92			* Provides access to any custom function on the controller for use on the template output.
93			* @return ArrayData
94			*/
95			public function getStyleguideData()
96			{
97			$data = new ArrayData([
98			'Title' => 'Styleguide',
99			'Message' => DBField::create_field(
100			'HTMLText',
101			'<p>This controller is only accessible to developers and admin users.</p>'
102			),
103			'TestForm' => $this->getTestForm(),
104			'Content' => $this->getContent(),
105			'ColorSwatches' => $this->getColorSwatches(),
106			'PlaceholderImageURL' => $this->getPlaceholderImageURL(),
107			]);
108
109			// extensions for adding/overriding template data.
110			$this->extend('updateStyleguideData', $data);
111
112			return $data;
113			}
114
115			/**
116			* Return a form with fields to match rendering through controller/template output.
117			* @return Form
118			*/
119			public function getTestForm()
120			{
121			$fields = FieldList::create(
122			TextField::create('SimpleText', 'Simple Text Field'),
123			TextField::create('SimpleTextGood', 'Simple Text Field (good)'),
124			TextField::create('SimpleTextWarning', 'Simple Text Field (warning)'),
125			TextField::create('SimpleTextBad', 'Simple Text Field (bad)'),
126			NumericField::create('Number', 'Number Field'),
127			EmailField::create('Email', "Email Field"),
128			DropdownField::create('Dropdown', 'Normal dropdown', [
129			'1' => 'One option',
130			'2' => 'Two option',
131			]),
132			CheckboxField::create('Checkbox', 'Checkbox'),
133			CheckboxSetField::create('CheckboxSet', 'Checkbox set', [
134			'1' => 'One option',
135			'2' => 'Two option',
136			'3' => 'Three option',
137			]),
138			OptionsetField::create('Option', 'Option', [
139			'1' => 'One option',
140			]),
141			OptionsetField::create('OptionSet', 'Option set', [
142			'1' => 'One option',
143			'2' => 'Two option',
144			'3' => 'Three option',
145			]),
146			TextField::create('Text', 'Text')
147			->setDescription('This is a description')
148			);
149
150			$actions = FieldList::create(
151			FormAction::create('doForm', 'Submit')
152			);
153
154			$required = new RequiredFields(
155			'SimpleText',
156			'Email',
157			'Checkbox',
158			'Dropdown'
159			);
160
161			$form = new Form($this, 'TestForm', $fields, $actions, $required);
162			$form->setMessage('This is a form wide message. See the alerts component for site wide messages.', 'warning');
163
164			$this->extend('updateForm', $form);
165
166			return $form;
167			}
168
169			/**
170			* Emulate an HTMLEditorField output useful for testing shortcodes and output extensions etc.
171			* @return HTMLText
			0 ignored issues – show Documentation introduced 2018-02-03 03:01 UTC by Report Bug Copy Issue Report Should the return type not be `DBField`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
172			*/
173			public function getContent()
174			{
175			$content = '';
176
177			// add file link to html content
178			$file = File::get()->filter('ClassName', 'File')->first();
179			if ($file) {
180			$content .= '<p>This is an internal <a href="[file_link,id=' . $file->ID . ']">link to a file</a> inside content</p>';
181			}
182
183			// add external link to html content
184			$content .= '<p>This is an external <a href="http://google.com">link to google</a> inside content.</p>';
185
186			$this->extend('updateContent', $content);
187
188			return DBField::create_field('HTMLText', $content);
189			}
190
191			/**
192			* @return ArrayList
193			*/
194			public function getColorSwatches()
195			{
196			$list = ArrayList::create();
197			$colors = $this->config()->color_swatches;
198
199			if ($colors) {
200			foreach ($colors as $color) {
201			$list->push(ArrayData::create($color));
202			}
203			}
204
205			$this->extend('updateColorSwatches', $list);
206
207			return $list;
208			}
209
210			/**
211			* @return string
212			*/
213			public function getPlaceholderImageURL()
214			{
215			$url = $this->config()->placeholder_image_url;
216
217			$this->extend('updatePlaceholderImageURL', $url);
218
219			return $url;
220			}
221			}
222

benmanu / silverstripe-simple-styleguide

Pull Request — master (#12)

SimpleStyleguideController::index() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like