SettingsField::__construct() - Code Metrics - silverstripe/silverstripe-documentconverter - Measure and Improve Code Quality continuously with Scrutinizer

SettingsField::__construct() A
last analyzed 2019-12-18 23:58 UTC

↳ Parent: SettingsField

Complexity

Conditions	2
Paths	2

Size

Total Lines	70
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	46
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	70
rs	9.1781

How to fix Long Method

<?php

namespace SilverStripe\DocumentConverter;

use InvalidArgumentException;
use SilverStripe\Assets\Folder;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\CompositeField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\HeaderField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\TreeDropdownField;
use SilverStripe\View\Requirements;

/**
 * Provides a document import capability through the use of an external service.
 * Includes several options fields, which are bundled together with an UploadField
 * into a CompositeField.
 */
class SettingsField extends CompositeField
{
    /**
     * Reference to the inner upload field (ImportField).
     */
    private $innerField = null;

    /**
     * Augments a simple CompositeField with uploader and import options.
     *
     * @param $children FieldSet/array Any additional children.

     */
    public function __construct($children = null)
    {
        if ($children) {
            $class = get_class();
            throw new InvalidArgumentException(
                "${class}::__construct does not accept extra parameters."
            );
        }

        // Add JS specific to this field.
        Requirements::javascript('silverstripe/documentconverter: javascript/DocumentConversionField.js');

        $fields = FieldList::create([
            LiteralField::create(
                'FileWarningHeader',
                '<div class="alert alert-warning">' . _t(
                    __CLASS__ . '.FileWarningHeader',
                    'Warning: import will remove all content and subpages of this page.'
                ) . '</div>',
                4
            ),
            $splitHeader = DropdownField::create(
                'DocumentConversionSettings-SplitHeader',
                _t(
                    __CLASS__ . '.SplitHeader',
                    'Split document into pages'
                ),
                [
                    0 => _t(__CLASS__ . '.No', 'no'),
                    1 => _t(__CLASS__ . '.EachH1', 'for each heading 1'),
                    2 => _t(__CLASS__ . '.EachH2', 'for each heading 2')
                ]
            ),
            $keepSource = CheckboxField::create(
                'DocumentConversionSettings-KeepSource',
                _t(
                    __CLASS__ . '.KeepSource',
                    'Keep the original document. Adds a link to it on TOC, if enabled.'
                )
            ),
            $chosenFolderID = TreeDropdownField::create(
                'DocumentConversionSettings-ChosenFolderID',
                _t(__CLASS__ . '.ChooseFolder', 'Choose a folder to save this file'),
                Folder::class
            ),
            $includeTOC = CheckboxField::create(
                'DocumentConversionSettings-IncludeTOC',
                _t(__CLASS__ . '.IncludeTOC', 'Replace this page with a Table of Contents.')
            ),
            $publishPages = CheckboxField::create(
                'DocumentConversionSettings-PublishPages',
                _t(
                    __CLASS__ . '.publishPages',
                    'Publish modified pages (not recommended unless you are sure about the conversion outcome)'
                )
            ),
            $this->innerField = ImportField::create(
                'ImportedFromFile',
                _t(__CLASS__ . '.ImportedFromFile', 'Import content from a word document')
            )
        ]);

        // Prevent the warning popup that appears when navigating away from the page.
        $splitHeader->addExtraClass('no-change-track');
        $keepSource->addExtraClass('no-change-track');
        $chosenFolderID->addExtraClass('no-change-track');
        $includeTOC->addExtraClass('no-change-track');
        $publishPages->addExtraClass('no-change-track');

        return parent::__construct($fields);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    public function getInnerField()
    {
        return $this->innerField;
    }
}


1			<?php
2
3			namespace SilverStripe\DocumentConverter;
4
5			use InvalidArgumentException;
6			use SilverStripe\Assets\Folder;
7			use SilverStripe\Forms\CheckboxField;
8			use SilverStripe\Forms\CompositeField;
9			use SilverStripe\Forms\DropdownField;
10			use SilverStripe\Forms\FieldList;
11			use SilverStripe\Forms\HeaderField;
12			use SilverStripe\Forms\LiteralField;
13			use SilverStripe\Forms\TreeDropdownField;
14			use SilverStripe\View\Requirements;
15
16			/**
17			* Provides a document import capability through the use of an external service.
18			* Includes several options fields, which are bundled together with an UploadField
19			* into a CompositeField.
20			*/
21			class SettingsField extends CompositeField
22			{
23			/**
24			* Reference to the inner upload field (ImportField).
25			*/
26			private $innerField = null;
27
28			/**
29			* Augments a simple CompositeField with uploader and import options.
30			*
31			* @param $children FieldSet/array Any additional children.
			0 ignored issues – show Documentation Bug introduced 2018-04-05 21:45 UTC by Report Bug Copy Issue Report The doc comment `FieldSet/array` at position `0` could not be parsed: Unknown type name 'FieldSet/array' at position 0 in FieldSet/array. Loading history...
32			*/
33			public function __construct($children = null)
34			{
35			if ($children) {
36			$class = get_class();
37			throw new InvalidArgumentException(
38			"${class}::__construct does not accept extra parameters."
39			);
40			}
41
42			// Add JS specific to this field.
43			Requirements::javascript('silverstripe/documentconverter: javascript/DocumentConversionField.js');
44
45			$fields = FieldList::create([
46			LiteralField::create(
47			'FileWarningHeader',
48			'<div class="alert alert-warning">' . _t(
49			__CLASS__ . '.FileWarningHeader',
50			'Warning: import will remove all content and subpages of this page.'
51			) . '</div>',
52			4
53			),
54			$splitHeader = DropdownField::create(
55			'DocumentConversionSettings-SplitHeader',
56			_t(
57			__CLASS__ . '.SplitHeader',
58			'Split document into pages'
59			),
60			[
61			0 => _t(__CLASS__ . '.No', 'no'),
62			1 => _t(__CLASS__ . '.EachH1', 'for each heading 1'),
63			2 => _t(__CLASS__ . '.EachH2', 'for each heading 2')
64			]
65			),
66			$keepSource = CheckboxField::create(
67			'DocumentConversionSettings-KeepSource',
68			_t(
69			__CLASS__ . '.KeepSource',
70			'Keep the original document. Adds a link to it on TOC, if enabled.'
71			)
72			),
73			$chosenFolderID = TreeDropdownField::create(
74			'DocumentConversionSettings-ChosenFolderID',
75			_t(__CLASS__ . '.ChooseFolder', 'Choose a folder to save this file'),
76			Folder::class
77			),
78			$includeTOC = CheckboxField::create(
79			'DocumentConversionSettings-IncludeTOC',
80			_t(__CLASS__ . '.IncludeTOC', 'Replace this page with a Table of Contents.')
81			),
82			$publishPages = CheckboxField::create(
83			'DocumentConversionSettings-PublishPages',
84			_t(
85			__CLASS__ . '.publishPages',
86			'Publish modified pages (not recommended unless you are sure about the conversion outcome)'
87			)
88			),
89			$this->innerField = ImportField::create(
90			'ImportedFromFile',
91			_t(__CLASS__ . '.ImportedFromFile', 'Import content from a word document')
92			)
93			]);
94
95			// Prevent the warning popup that appears when navigating away from the page.
96			$splitHeader->addExtraClass('no-change-track');
97			$keepSource->addExtraClass('no-change-track');
98			$chosenFolderID->addExtraClass('no-change-track');
99			$includeTOC->addExtraClass('no-change-track');
100			$publishPages->addExtraClass('no-change-track');
101
102			return parent::__construct($fields);
			0 ignored issues – show Bug introduced 2017-12-18 23:45 UTC by Report Bug Copy Issue Report Are you sure the usage of `parent::__construct($fields)` targeting `SilverStripe\Forms\CompositeField::__construct()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
103			}
104
105			public function getInnerField()
106			{
107			return $this->innerField;
108			}
109			}
110

silverstripe / silverstripe-documentconverter

SettingsField::__construct() A last analyzed 2019-12-18 23:58 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

SettingsField::__construct() A
last analyzed 2019-12-18 23:58 UTC