CommentAdmin::getEditForm() - Code Metrics - Inspection of "FIX Update CommentAdmin test to create a mock sess..." - silverstripe/silverstripe-comments - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 82c4a1...4bf0a8 )

by Robbie

created 2017-12-18 20:36 UTC

CommentAdmin::getEditForm() B

↳ Parent: CommentAdmin

Complexity

Conditions	5
Paths	6

Size

Total Lines	94
Code Lines	62

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	94
rs	8.2204
c	0
b	0
f	0
cc	5
eloc	62
nc	6
nop	2

How to fix Long Method

<?php

namespace SilverStripe\Comments\Admin;

use SilverStripe\Admin\LeftAndMain;
use SilverStripe\Comments\Admin\CommentsGridField;
use SilverStripe\Comments\Model\Comment;
use SilverStripe\Forms\Tab;
use SilverStripe\Forms\TabSet;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\Security\Security;
use SilverStripe\View\SSViewer;

/**
 * Comment administration system within the CMS
 *
 * @package comments
 */
class CommentAdmin extends LeftAndMain implements PermissionProvider
{
    private static $url_segment = 'comments';


    private static $url_rule = '/$Action';


    private static $menu_title = 'Comments';


    private static $menu_icon_class = 'font-icon-comment';


    private static $allowed_actions = array(

        'approvedmarked',
        'deleteall',
        'deletemarked',
        'hammarked',
        'showtable',
        'spammarked',
        'EditForm',
        'unmoderated'
    );

    private static $required_permission_codes = 'CMS_ACCESS_CommentAdmin';


    public function providePermissions()
    {
        return array(
            "CMS_ACCESS_CommentAdmin" => array(
                'name' => _t(__CLASS__ . '.ADMIN_PERMISSION', "Access to 'Comments' section"),
                'category' => _t('SilverStripe\\Security\\Permission.CMS_ACCESS_CATEGORY', 'CMS Access')
            )
        );
    }

    /**
     * @return Form
     */
    public function getEditForm($id = null, $fields = null)
    {
        if (!$id) {
            $id = $this->currentPageID();
        }

        $form = parent::getEditForm($id);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $record = $this->getRecord($id);

        if ($record && !$record->canView()) {
            return Security::permissionFailure($this);
        }

        $newComments = Comment::get()->filter('Moderated', 0);

        $newGrid = new CommentsGridField(
            'NewComments',
            '',
            $newComments,
            CommentsGridFieldConfig::create()
        );

        $approvedComments = Comment::get()->filter('Moderated', 1)->filter('IsSpam', 0);

        $approvedGrid = new CommentsGridField(
            'ApprovedComments',
            '',
            $approvedComments,
            CommentsGridFieldConfig::create()
        );

        $spamComments = Comment::get()->filter('Moderated', 1)->filter('IsSpam', 1);

        $spamGrid = new CommentsGridField(
            'SpamComments',
            '',
            $spamComments,
            CommentsGridFieldConfig::create()
        );

        $fields = FieldList::create(
            $root = TabSet::create(
                'Root',
                Tab::create(
                    'NewComments',
                    _t(
                        __CLASS__.'.NewComments',
                        'New ({count})',
                        ['count' => count($newComments)]
                    ),
                    $newGrid
                ),
                Tab::create(
                    'ApprovedComments',
                    _t(
                        __CLASS__.'.ApprovedComments',
                        'Approved ({count})',
                        ['count' => count($approvedComments)]
                    ),
                    $approvedGrid
                ),
                Tab::create(
                    'SpamComments',
                    _t(
                        __CLASS__.'.SpamComments',
                        'Spam ({count})',
                        ['count' => count($spamComments)]
                    ),
                    $spamGrid
                )
            )
        );

        $actions = FieldList::create();

        $form = Form::create(
            $this,
            'EditForm',
            $fields,
            $actions
        );

        $form->addExtraClass('cms-edit-form');
        $form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));


        if ($form->Fields()->hasTabset()) {
             $form->Fields()->findOrMakeTab('Root')->setTemplate('SilverStripe\\Forms\\CMSTabSet');
            $form->addExtraClass('center ss-tabset cms-tabset ' . $this->BaseCSSClasses());
        }

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

        return $form;
    }
}


1			<?php
2
3			namespace SilverStripe\Comments\Admin;
4
5			use SilverStripe\Admin\LeftAndMain;
6			use SilverStripe\Comments\Admin\CommentsGridField;
7			use SilverStripe\Comments\Model\Comment;
8			use SilverStripe\Forms\Tab;
9			use SilverStripe\Forms\TabSet;
10			use SilverStripe\Forms\FieldList;
11			use SilverStripe\Forms\Form;
12			use SilverStripe\Security\PermissionProvider;
13			use SilverStripe\Security\Security;
14			use SilverStripe\View\SSViewer;
15
16			/**
17			* Comment administration system within the CMS
18			*
19			* @package comments
20			*/
21			class CommentAdmin extends LeftAndMain implements PermissionProvider
22			{
23			private static $url_segment = 'comments';
			0 ignored issues – show Unused Code introduced 2015-11-21 06:31 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... Comprehensibility introduced 2017-01-27 00:02 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...
24
25			private static $url_rule = '/$Action';
			0 ignored issues – show Unused Code introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report The property `$url_rule` 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... Comprehensibility introduced 2017-01-27 00:02 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...
26
27			private static $menu_title = 'Comments';
			0 ignored issues – show Unused Code introduced 2015-11-21 06:31 UTC by Report Bug Copy Issue Report The property `$menu_title` 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... Comprehensibility introduced 2017-01-27 00:02 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...
28
29			private static $menu_icon_class = 'font-icon-comment';
			0 ignored issues – show Unused Code introduced 2017-09-18 02:22 UTC by Report Bug Copy Issue Report The property `$menu_icon_class` 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...
30
31			private static $allowed_actions = array(
			0 ignored issues – show Comprehensibility introduced 2015-11-20 23:54 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 2015-11-21 06:31 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...
32			'approvedmarked',
33			'deleteall',
34			'deletemarked',
35			'hammarked',
36			'showtable',
37			'spammarked',
38			'EditForm',
39			'unmoderated'
40			);
41
42			private static $required_permission_codes = 'CMS_ACCESS_CommentAdmin';
			0 ignored issues – show Comprehensibility introduced 2017-09-18 02:22 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-09-18 02:22 UTC by Report Bug Copy Issue Report The property `$required_permission_codes` 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			public function providePermissions()
45			{
46			return array(
47			"CMS_ACCESS_CommentAdmin" => array(
48			'name' => _t(__CLASS__ . '.ADMIN_PERMISSION', "Access to 'Comments' section"),
49			'category' => _t('SilverStripe\\Security\\Permission.CMS_ACCESS_CATEGORY', 'CMS Access')
50			)
51			);
52			}
53
54			/**
55			* @return Form
56			*/
57			public function getEditForm($id = null, $fields = null)
58			{
59			if (!$id) {
60			$id = $this->currentPageID();
61			}
62
63			$form = parent::getEditForm($id);
			0 ignored issues – show Unused Code introduced 2017-01-27 00:02 UTC by Report Bug Copy Issue Report `$form` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
64			$record = $this->getRecord($id);
65
66			if ($record && !$record->canView()) {
67			return Security::permissionFailure($this);
68			}
69
70			$newComments = Comment::get()->filter('Moderated', 0);
71
72			$newGrid = new CommentsGridField(
73			'NewComments',
74			'',
75			$newComments,
76			CommentsGridFieldConfig::create()
77			);
78
79			$approvedComments = Comment::get()->filter('Moderated', 1)->filter('IsSpam', 0);
80
81			$approvedGrid = new CommentsGridField(
82			'ApprovedComments',
83			'',
84			$approvedComments,
85			CommentsGridFieldConfig::create()
86			);
87
88			$spamComments = Comment::get()->filter('Moderated', 1)->filter('IsSpam', 1);
89
90			$spamGrid = new CommentsGridField(
91			'SpamComments',
92			'',
93			$spamComments,
94			CommentsGridFieldConfig::create()
95			);
96
97			$fields = FieldList::create(
98			$root = TabSet::create(
99			'Root',
100			Tab::create(
101			'NewComments',
102			_t(
103			__CLASS__.'.NewComments',
104			'New ({count})',
105			['count' => count($newComments)]
106			),
107			$newGrid
108			),
109			Tab::create(
110			'ApprovedComments',
111			_t(
112			__CLASS__.'.ApprovedComments',
113			'Approved ({count})',
114			['count' => count($approvedComments)]
115			),
116			$approvedGrid
117			),
118			Tab::create(
119			'SpamComments',
120			_t(
121			__CLASS__.'.SpamComments',
122			'Spam ({count})',
123			['count' => count($spamComments)]
124			),
125			$spamGrid
126			)
127			)
128			);
129
130			$actions = FieldList::create();
131
132			$form = Form::create(
133			$this,
134			'EditForm',
135			$fields,
136			$actions
137			);
138
139			$form->addExtraClass('cms-edit-form');
140			$form->setTemplate($this->getTemplatesWithSuffix('_EditForm'));
			0 ignored issues – show Bug introduced 2017-07-04 15:05 UTC by Report Bug Copy Issue Report It seems like `$this->getTemplatesWithSuffix('_EditForm')` targeting `SilverStripe\Admin\LeftA...etTemplatesWithSuffix()` can also be of type `array`; however, `SilverStripe\Forms\Form::setTemplate()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
141
142			if ($form->Fields()->hasTabset()) {
143			$form->Fields()->findOrMakeTab('Root')->setTemplate('SilverStripe\\Forms\\CMSTabSet');
144			$form->addExtraClass('center ss-tabset cms-tabset ' . $this->BaseCSSClasses());
145			}
146
147			$this->extend('updateEditForm', $form);
148
149			return $form;
150			}
151			}
152

silverstripe / silverstripe-comments

Push — master ( 82c4a1...4bf0a8 )

CommentAdmin::getEditForm() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like