ProductDoc - Code Metrics - Inspection of "SilverStripe 4 upgrade" - dynamic/silverstripe-product-catalog - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#24)

by Jason

created 2017-07-13 00:42 UTC

ProductDoc A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	4

Test Coverage

Coverage

88.46%

Importance

Changes

Metric	Value
wmc	3
lcom	0
cbo	4
dl	0
loc	90
ccs	23
cts	26
cp	0.8846
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	getCMSFields()	0	28	1
A	onAfterWrite()	0	8	2

<?php

namespace Dynamic\ProductCatalog\Docs;

use SilverStripe\AssetAdmin\Forms\UploadField;
use SilverStripe\Assets\File;
use SilverStripe\Assets\Image;
use SilverStripe\Forms\TextField;
use SilverStripe\ORM\DataObject;

class ProductDoc extends DataObject
{
    /**
     * @var array
     */
    private static $db = array(
        'Name' => 'Varchar(255)',
        'Title' => 'Varchar(255)',
        'Content' => 'HTMLText',
        'FileLink' => 'Varchar(255)',
    );

    /**
     * @var array
     */
    private static $has_one = array(
        'Image' => Image::class,
        'Download' => File::class,
    );

    /**
     * @var string
     */
    private static $table_name = 'ProductDoc';


    /**
     * @var array
     */
    private static $summary_fields = array(
        'Name' => 'Name',
        'Title' => 'Title',
    );

    /**
     * @var array
     */
    private static $searchable_fields = array(
        'Name',
        'Title',
    );

    /**
     * @var string
     */
    private static $default_sort = 'Title';


    /**
     * @return \SilverStripe\Forms\FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $file = UploadField::create('Download')
            //->setFolderName('Uploads/FileDownloads')
            //->setConfig('allowedMaxFileNumber', 1)

            //->setAllowedFileCategories('doc')
            //->setAllowedMaxFileNumber(1)
        ;

        $fields->addFieldsToTab('Root.Download', array(
            $file,
            TextField::create('FileLink')
                ->setDescription('URL of external file. will display on page if no Download is specified above.')
                ->setAttribute('placeholder', 'http://'),
        ));

        $fields->insertBefore(
            UploadField::create('Image')
                //->setFolderName('Uploads/ProductDocs/Images')
                ->setDescription('Preview image of file')
            ,
            'Content'
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        );

        return $fields;
    }

    /**
     * if SetClass dropdown is set, create a new instance of the new class.
     */
    public function onAfterWrite()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        parent::onAfterWrite();
        if (isset($_REQUEST['SetClass'])) {
            $object = $this->newClassInstance($_REQUEST['SetClass']);
            $object->write();
        }
    }
}

1		<?php
2
3		namespace Dynamic\ProductCatalog\Docs;
4
5		use SilverStripe\AssetAdmin\Forms\UploadField;
6		use SilverStripe\Assets\File;
7		use SilverStripe\Assets\Image;
8		use SilverStripe\Forms\TextField;
9		use SilverStripe\ORM\DataObject;
10
11		class ProductDoc extends DataObject
12		{
13		/**
14		* @var array
15		*/
16		private static $db = array(
17		'Name' => 'Varchar(255)',
18		'Title' => 'Varchar(255)',
19		'Content' => 'HTMLText',
20		'FileLink' => 'Varchar(255)',
21		);
22
23		/**
24		* @var array
25		*/
26		private static $has_one = array(
27		'Image' => Image::class,
28		'Download' => File::class,
29		);
30
31		/**
32		* @var string
33		*/
34		private static $table_name = 'ProductDoc';
		0 ignored issues – show Unused Code introduced 2017-07-13 00:52 UTC by Report Bug Copy Issue Report The property `$table_name` 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...
35
36		/**
37		* @var array
38		*/
39		private static $summary_fields = array(
40		'Name' => 'Name',
41		'Title' => 'Title',
42		);
43
44		/**
45		* @var array
46		*/
47	6	private static $searchable_fields = array(
48		'Name',
49	6	'Title',
50		);
51	6
52	6	/**
53	6	* @var string
54	6	*/
55	6	private static $default_sort = 'Title';
		0 ignored issues – show Unused Code introduced 2017-02-19 05:05 UTC by Report Bug Copy Issue Report The property `$default_sort` 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...
56
57	6	/**
58	6	* @return \SilverStripe\Forms\FieldList
59	6	*/
60	6	public function getCMSFields()
61	6	{
62	6	$fields = parent::getCMSFields();
63
64	6	$file = UploadField::create('Download')
65	6	//->setFolderName('Uploads/FileDownloads')
66	6	//->setConfig('allowedMaxFileNumber', 1)
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-12 21:22 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
67	6	//->setAllowedFileCategories('doc')
68		//->setAllowedMaxFileNumber(1)
69	6	;
70
71	6	$fields->addFieldsToTab('Root.Download', array(
72		$file,
73		TextField::create('FileLink')
74		->setDescription('URL of external file. will display on page if no Download is specified above.')
75		->setAttribute('placeholder', 'http://'),
76		));
77	45
78		$fields->insertBefore(
79	45	UploadField::create('Image')
80	45	//->setFolderName('Uploads/ProductDocs/Images')
81		->setDescription('Preview image of file')
82		,
83		'Content'
		0 ignored issues – show Documentation introduced 2017-07-12 21:22 UTC by Report Bug Copy Issue Report `'Content'` is of type `string`, but the function expects a `object<SilverStripe\Forms\FormField>`. 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...
84	45	);
85
86		return $fields;
87		}
88
89		/**
90		* if SetClass dropdown is set, create a new instance of the new class.
91		*/
92		public function onAfterWrite()
		0 ignored issues – show Coding Style introduced 2017-02-19 05:05 UTC by Report Bug Copy Issue Report `onAfterWrite` uses the super-global variable `$_REQUEST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
93		{
94		parent::onAfterWrite();
95		if (isset($_REQUEST['SetClass'])) {
96		$object = $this->newClassInstance($_REQUEST['SetClass']);
97		$object->write();
98		}
99		}
100		}

dynamic / silverstripe-product-catalog

Pull Request — master (#24)

ProductDoc A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Duplication Side-by-Side

Filter issues like