BaseElement - Code Metrics - Inspection of "(Fixes: #21) Tidy up rendering flow to make templa..." - dnadesign/silverstripe-elemental - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2006ba...483d1e )

by Will

created 2016-02-22 21:24 UTC

BaseElement A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	198
Duplicated Lines	11.62 %

Coupling/Cohesion

Components	2
Dependencies	13

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
wmc	30
c	1
b	1
f	0
lcom	2
cbo	13
dl	23
loc	198
rs	10

14 Methods

Rating	Name	Duplication	Size	Complexity
C	getCMSFields()	0	47	8
A	isEndofLine()	0	10	2
A	onBeforeWrite()	0	14	4
A	i18n_singular_name()	0	4	1
A	getElementType()	0	4	1
A	getTitle()	12	12	3
A	getCMSTitle()	11	11	3
A	canView()	0	4	1
A	canEdit()	0	4	1
A	canDelete()	0	4	1
A	canCreate()	0	4	1
A	ControllerTop()	0	4	1
A	getPage()	0	10	2
A	forTemplate()	0	3	1

How to fix Duplicated Code

<?php

/**
 * @package elemental
 */
class BaseElement extends Widget
namespace YourVendor;

class YourClass { }
{

    private static $db = array(

        'ExtraClass' => 'Varchar(255)',
        'HideTitle' => 'Boolean'
    );

    private static $has_one = array(

        'List' => 'ElementList' // optional.
    );

    /**
     * @var string
    */
    private static $title = "Base Element";


    /**
     * @var array
     */
    private static $summary_fields = array(

        'ID',
        'Title',
        'ElementType'
    );

    /**
    * @var string
    */
    private static $description = "Base class for elements";


    /**
    * @var boolean
    */
    protected $enable_title_in_template = false;


    public function getCMSFields()

    {
        $fields = $this->scaffoldFormFields(array(
            'includeRelations' => ($this->ID > 0),
            'tabbed' => true,
            'ajaxSafe' => true
        ));

        $fields->insertAfter(new ReadonlyField('Type'), 'Title');
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $fields->removeByName('ListID');
        $fields->removeByName('ParentID');
        $fields->removeByName('Sort');
        $fields->removeByName('ExtraClass');

        if (!$this->enable_title_in_template) {
            $fields->removeByName('HideTitle');
            $title = $fields->fieldByName('Root.Main.Title');
            if ($title) {
                $title->setRightTitle('For reference only. Does not appear in the template.');
            }
        }

        $fields->addFieldToTab('Root.Settings', new TextField('ExtraClass', 'Extra CSS Classes to add'));

        if (!is_a($this, 'ElementList')) {
            $lists = ElementList::get()->filter('ParentID', $this->ParentID);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

            if ($lists->exists()) {
                $fields->addFieldToTab('Root.Main',
                    $move = new DropdownField('MoveToListID', 'Move this to another list', $lists->map('ID', 'CMSTitle'), '')
                );

                $move->setEmptyString('Select a list..');
                $move->setHasEmptyDefault(true);
            }
        }

        $this->extend('updateCMSFields', $fields);

        if ($this->IsInDB()) {
            if ($this->isEndofLine('BaseElement') && $this->hasExtension('VersionViewerDataObject')) {
                $fields = $this->addVersionViewer($fields, $this);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            }
        }

        return $fields;
    }

    /**
     * Version viewer must only be added at if this is the final getCMSFields for a class.
     * in order to avoid having to rename all fields from eg Root.Main to Root.Current.Main
     * To do this we test if getCMSFields is from the current class
     */
    public function isEndofLine($className)
    {
        $methodFromClass = ClassInfo::has_method_from(
            $this->ClassName, 'getCMSFields', $className
        );

        if($methodFromClass) {
            return true;
        }
    }


    public function onBeforeWrite()
    {
        parent::onBeforeWrite();

        if (!$this->Sort) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $parentID = ($this->ParentID) ? $this->ParentID : 0;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

            $this->Sort = DB::query("SELECT MAX(\"Sort\") + 1 FROM \"Widget\" WHERE \"ParentID\" = $parentID")->value();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        if ($this->MoveToListID) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->ListID = $this->MoveToListID;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
    }

    public function i18n_singular_name()
    {
        return _t(__CLASS__, $this->config()->title);
    }

    public function getElementType()
    {
        return $this->i18n_singular_name();
    }

    public function getTitle()

    {
        if ($title = $this->getField('Title')) {
            return $title;
        } else {
            if (!$this->isInDb()) {
                return;
            }

            return $this->config()->title;
        }
    }

    public function getCMSTitle()

    {
        if ($title = $this->getField('Title')) {
            return $this->config()->title . ': ' . $title;
        } else {
            if (!$this->isInDb()) {
                return;
            }
            return $this->config()->title;
        }
    }

    public function canView($member = null)
    {
        return Permission::check('CMS_ACCESS_CMSMain', 'any', $member);
    }

    public function canEdit($member = null)
    {
        return Permission::check('CMS_ACCESS_CMSMain', 'any', $member);
    }

    public function canDelete($member = null)
    {
        return Permission::check('CMS_ACCESS_CMSMain', 'any', $member);
    }

    public function canCreate($member = null)
    {
        return Permission::check('CMS_ACCESS_CMSMain', 'any', $member);
    }

    public function ControllerTop()

    {
        return Controller::curr();
    }

    public function getPage()
    {
        $area = $this->Parent();


        if ($area instanceof ElementalArea) {
            return $area->getOwnerPage();
        }

        return null;
    }

    /**
     * Override the {@link Widget::forTemplate()} method so that holders are not rendered twice. The controller should
     * render with widget inside the
     *
     * @return HTML

     */
    public function forTemplate($holder = true) {
        return $this->renderWith($this->class);
    }
}


1			<?php
2
3			/**
4			* @package elemental
5			*/
6			class BaseElement extends Widget
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-17 03:25 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
7			{
8
9			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2016-02-17 03:25 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 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$db` 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...
10			'ExtraClass' => 'Varchar(255)',
11			'HideTitle' => 'Boolean'
12			);
13
14			private static $has_one = array(
			0 ignored issues – show Comprehensibility introduced 2016-02-17 03:25 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 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$has_one` 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...
15			'List' => 'ElementList' // optional.
16			);
17
18			/**
19			* @var string
20			*/
21			private static $title = "Base Element";
			0 ignored issues – show Comprehensibility introduced 2016-02-17 03:25 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 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$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...
22
23			/**
24			* @var array
25			*/
26			private static $summary_fields = array(
			0 ignored issues – show Comprehensibility introduced 2016-02-17 03:25 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 2016-02-17 03:25 UTC by Report Bug Copy Issue Report The property `$summary_fields` 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...
27			'ID',
28			'Title',
29			'ElementType'
30			);
31
32			/**
33			* @var string
34			*/
35			private static $description = "Base class for elements";

dnadesign / silverstripe-elemental

Push — master ( 2006ba...483d1e )

BaseElement A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like