SimpleStyleguideController::getStyleguideData() - Code Metrics - Inspection of "Updating config" - benmanu/silverstripe-simple-styleguide - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 715678...f5ebff )

by Ben

created 2018-02-03 03:00 UTC

SimpleStyleguideController::getStyleguideData() A

↳ Parent: SimpleStyleguideController

Complexity

Conditions	1
Paths	1

Size

Total Lines	19
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	12
nc	1
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;

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


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


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

        'index',
    ];

    private static $url_segment = '_styleguide';


    /**
     * Runs the permissiion checks, and setup of the controller view.
     */
    public function index()

    {
        if (!Director::isDev() && !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('simple-styleguide/css/styleguide.css');
        Requirements::javascript('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
27			/**
28			* @package simple-styleguide
29			*/
30			class SimpleStyleguideController extends Controller
31			{
32			/**
33			* @config
34			* @var array
35			*/
36			private static $color_swatches = [];
			0 ignored issues – show Unused Code introduced 2017-05-20 04:18 UTC by Report Bug Copy Issue Report The property `$color_swatches` 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...
37
38			/**
39			* @config
40			* @var string
41			*/
42			private static $placeholder_image_url = '/simple-styleguide/images/placeholder.png';
			0 ignored issues – show Unused Code introduced 2018-02-03 03:01 UTC by Report Bug Copy Issue Report The property `$placeholder_image_url` 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...
43
44			/**
45			* @var array
46			*/
47			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... Unused Code introduced 2017-05-20 04:18 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...
48			'index',
49			];
50
51			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... Unused Code introduced 2018-02-03 03:01 UTC by Report Bug Copy Issue Report The property `$url_segment` 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...
52
53			/**
54			* Runs the permissiion checks, and setup of the controller view.
55			*/
56			public function index()
			0 ignored issues – show Documentation introduced 2018-02-03 03:01 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
57			{
58			if (!Director::isDev() && !Permission::check('ADMIN')) {
59			return Security::permissionFailure();
60			}
61
62			// If the subsite module is installed then set the theme based on the current subsite
63			if (class_exists('Subsite') && Subsite::currentSubsite()) {
64			Config::inst()->update('SSViewer', 'theme', Subsite::currentSubsite()->Theme);
65			}
66
67			$page = SiteTree::get()->first();
68			$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...
69			$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...
70
71			// requirements
72			Requirements::css('simple-styleguide/css/styleguide.css');
73			Requirements::javascript('simple-styleguide/js/styleguide.js');
74
75			return $controller
76			->customise($this->getStyleGuideData())
77			->renderWith(['SimpleStyleguideController', 'Page']);
78			}
79
80			/**
81			* Provides access to any custom function on the controller for use on the template output.
82			* @return ArrayData
83			*/
84			public function getStyleguideData()
85			{
86			$data = new ArrayData([
87			'Title' => 'Styleguide',
88			'Message' => DBField::create_field(
89			'HTMLText',
90			'<p>This controller is only accessible to developers and admin users.</p>'
91			),
92			'TestForm' => $this->getTestForm(),
93			'Content' => $this->getContent(),
94			'ColorSwatches' => $this->getColorSwatches(),
95			'PlaceholderImageURL' => $this->getPlaceholderImageURL(),
96			]);
97
98			// extensions for adding/overriding template data.
99			$this->extend('updateStyleguideData', $data);
100
101			return $data;
102			}
103
104			/**
105			* Return a form with fields to match rendering through controller/template output.
106			* @return Form
107			*/
108			public function getTestForm()
109			{
110			$fields = FieldList::create(
111			TextField::create('SimpleText', 'Simple Text Field'),
112			TextField::create('SimpleTextGood', 'Simple Text Field (good)'),
113			TextField::create('SimpleTextWarning', 'Simple Text Field (warning)'),
114			TextField::create('SimpleTextBad', 'Simple Text Field (bad)'),
115			NumericField::create('Number', 'Number Field'),
116			EmailField::create('Email', "Email Field"),
117			DropdownField::create('Dropdown', 'Normal dropdown', [
118			'1' => 'One option',
119			'2' => 'Two option',
120			]),
121			CheckboxField::create('Checkbox', 'Checkbox'),
122			CheckboxSetField::create('CheckboxSet', 'Checkbox set', [
123			'1' => 'One option',
124			'2' => 'Two option',
125			'3' => 'Three option',
126			]),
127			OptionsetField::create('Option', 'Option', [
128			'1' => 'One option',
129			]),
130			OptionsetField::create('OptionSet', 'Option set', [
131			'1' => 'One option',
132			'2' => 'Two option',
133			'3' => 'Three option',
134			]),
135			TextField::create('Text', 'Text')
136			->setDescription('This is a description')
137			);
138
139			$actions = FieldList::create(
140			FormAction::create('doForm', 'Submit')
141			);
142
143			$required = new RequiredFields(
144			'SimpleText',
145			'Email',
146			'Checkbox',
147			'Dropdown'
148			);
149
150			$form = new Form($this, 'TestForm', $fields, $actions, $required);
151			$form->setMessage('This is a form wide message. See the alerts component for site wide messages.', 'warning');
152
153			$this->extend('updateForm', $form);
154
155			return $form;
156			}
157
158			/**
159			* Emulate an HTMLEditorField output useful for testing shortcodes and output extensions etc.
160			* @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...
161			*/
162			public function getContent()
163			{
164			$content = '';
165
166			// add file link to html content
167			$file = File::get()->filter('ClassName', 'File')->first();
168			if ($file) {
169			$content .= '<p>This is an internal <a href="[file_link,id=' . $file->ID . ']">link to a file</a> inside content</p>';
170			}
171
172			// add external link to html content
173			$content .= '<p>This is an external <a href="http://google.com">link to google</a> inside content.</p>';
174
175			$this->extend('updateContent', $content);
176
177			return DBField::create_field('HTMLText', $content);
178			}
179
180			/**
181			* @return ArrayList
182			*/
183			public function getColorSwatches()
184			{
185			$list = ArrayList::create();
186			$colors = $this->config()->color_swatches;
187
188			if ($colors) {
189			foreach ($colors as $color) {
190			$list->push(ArrayData::create($color));
191			}
192			}
193
194			$this->extend('updateColorSwatches', $list);
195
196			return $list;
197			}
198
199			/**
200			* @return string
201			*/
202			public function getPlaceholderImageURL()
203			{
204			$url = $this->config()->placeholder_image_url;
205
206			$this->extend('updatePlaceholderImageURL', $url);
207
208			return $url;
209			}
210			}
211

benmanu / silverstripe-simple-styleguide

Push — master ( 715678...f5ebff )

SimpleStyleguideController::getStyleguideData() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like