ImageWithStyle - Code Metrics - Inspection of "FIXES" - sunnysideup/silverstripe-imagewithstyle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 34e737...1a9402 )

by Nicolaas

created 2018-05-14 04:18 UTC

ImageWithStyle B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	385
Duplicated Lines	2.34 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes

Metric	Value
wmc	53
lcom	1
cbo	11
dl	9
loc	385
c	0
b	0
f	0
rs	7.4757

16 Methods

Rating	Name	Duplication	Size	Complexity
A	i18n_singular_name()	0	4	1
A	i18n_plural_name()	0	4	1
A	canDelete()	0	4	1
C	validate()	0	48	13
A	onBeforeWrite()	0	5	1
A	onAfterWrite()	0	10	3
A	requireDefaultRecords()	0	5	1
A	getExportFields()	0	5	1
A	CMSEditLink()	0	6	1
A	CMSAddLink()	0	6	1
C	getCMSFields()	9	72	12
A	ImageElement()	0	4	1
B	getImageElement()	0	19	5
B	buildStyles()	0	22	5
A	hasRealStyle()	0	9	2
A	convertVarTypeToCSS()	0	15	4

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ImageWithStyle often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ImageWithStyle, and based on these observations, apply Extract Interface, too.

<?php



class ImageWithStyle extends DataObject
namespace YourVendor;

class YourClass { }
{

    #######################
    ### Names Section
    #######################

    private static $singular_name = 'Image With Style';


    function i18n_singular_name()

    {
        return _t('ImageWithStyle.SINGULAR_NAME', 'Image With Style');
    }

    private static $plural_name = 'Images With Style';


    function i18n_plural_name()

    {
        return _t('ImageWithStyle.PLURAL_NAME', 'Images With Style');
    }


    #######################
    ### Model Section
    #######################

    private static $db = [

        'Title' => 'Varchar',
        'Description' => 'Text',
        'Var1' => 'Varchar',
        'Var2' => 'Varchar',
        'Var3' => 'Varchar',
        'Var4' => 'Varchar',
        'Var5' => 'Varchar'
    ];

    private static $has_one = [

        'Image' => 'Image',
        'Style' => 'ImageStyle'
    ];

    private static $belongs_many_many = [

        'Selections' => 'ImagesWithStyleSelection'
    ];


    #######################
    ### Further DB Field Details
    #######################

    private static $indexes = [

        'Created' => true
    ];

    private static $default_sort = [

        'Created' => 'DESC'
    ];

    private static $required_fields = [

        'Title',
        'StyleID'
    ];

    private static $searchable_fields = [

        'Title' => 'PartialMatchFilter'
    ];


    #######################
    ### Field Names and Presentation Section
    #######################

    private static $field_labels = [

        'Style' => 'Display Style',
        'Title' => 'Image Title',
        'Selections' => 'Lists'
    ];

    private static $field_labels_right = [

        'Pages' => 'On what pages is this image visible'
    ];

    private static $summary_fields = [

        'Title' => 'Title',
        'Style.Title' => 'Style',
        'Image.CMSThumbnail' => 'Image'
    ];


    private static $casting = [

        'ImageElement' => 'HTMLText'
    ];

    private static $unique_vars = ['Var1', 'Var2', 'Var3', 'Var4', 'Var5'];



    #######################
    ### Casting Section
    #######################


    #######################
    ### can Section
    #######################

    function canDelete($member = null)

    {
        return false;
    }



    #######################
    ### write Section
    #######################




    public function validate()
    {
        $result = parent::validate();
        $fieldLabels = $this->FieldLabels();
        $indexes = $this->Config()->get('indexes');
        $requiredFields = $this->Config()->get('required_fields');
        if($this->exists() && $this->hasRealStyle()) {
            $requiredFields[] = 'ImageID';
        }
        if(is_array($requiredFields)) {
            foreach($requiredFields as $field) {
                $value = $this->$field;
                if(! $value) {
                    $fieldWithoutID = $field;
                    if(substr($fieldWithoutID, -2) === 'ID') {
                        $fieldWithoutID = substr($fieldWithoutID, 0, -2);
                    }
                    $myName = isset($fieldLabels[$fieldWithoutID]) ? $fieldLabels[$fieldWithoutID] : $fieldWithoutID;
                    $result->error(
                        _t(
                            'ImageWithStyle.'.$field.'_REQUIRED',
                            $myName.' is required'
                        ),
                        'REQUIRED_ImageWithStyle_'.$field
                    );
                }
                if (isset($indexes[$field]) && isset($indexes[$field]['type']) && $indexes[$field]['type'] === 'unique') {
                    $id = (empty($this->ID) ? 0 : $this->ID);
                    $count = ImageWithStyle::get()
                        ->filter(array($field => $value))
                        ->exclude(array('ID' => $id))
                        ->count();
                    if($count > 0) {
                        $myName = $fieldLabels['$field'];
                        $result->error(
                            _t(
                                'ImageWithStyle.'.$field.'_UNIQUE',
                                $myName.' needs to be unique'
                            ),
                            'UNIQUE_ImageWithStyle_'.$field
                        );
                    }
                }
            }
        }

        return $result;
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        //...
    }

    public function onAfterWrite()
    {
        parent::onAfterWrite();
        //...
        $image = $this->Image();
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 { }
        if($image && $image->exists()) {
            $image->Title = $this->Title;
<?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.");
        }
    }

}
            $image->write();
        }
    }

    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        //...
    }


    #######################
    ### Import / Export Section
    #######################

    public function getExportFields()

    {
        //..
        return parent::getExportFields();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }



    #######################
    ### CMS Edit Section
    #######################


    public function CMSEditLink()
    {
        $controller = singleton("tba");

        return $controller->Link().$this->ClassName."/EditForm/field/".$this->ClassName."/item/".$this->ID."/edit";
    }

    public function CMSAddLink()
    {
        $controller = singleton("tba");

        return $controller->Link().$this->ClassName."/EditForm/field/".$this->ClassName."/item/new";
    }


    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        //do first??
        $rightFieldDescriptions = $this->Config()->get('field_labels_right');
        foreach($rightFieldDescriptions as $field => $desc) {

           $formField = $fields->DataFieldByName($field);
           if(! $formField) {
            $formField = $fields->DataFieldByName($field.'ID');
           }
           if($formField) {
               $formField->setDescription($desc);
           }
        }
        //...
        if($this->hasRealStyle()) {
            $style = $this->Style();
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 { }
            $varsArray = $this->Config()->get('unique_vars');
            //var_dump($this->Style());

            foreach($varsArray as $varName){
                if($this->Style()->hasStyleVariable($varName)){
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 { }
                    $name = $varName . 'Name';
                    $type = $varName . 'Type';
                    $descriptionField = $varName . 'Description';
                    switch ($this->Style()->$type){
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 { }
                        case 'Pixels':
                        case 'Percentage':
                            $newField = NumericField::create($varName, $style->$name)
                                ->setRightTitle($this->Style()->$descriptionField.' ('.$style->$type.'). Negative number are allowed in some instances.');
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 { }
                            break;
                        case 'Options':
                            $newField = OptionSetField::create($varName, $style->$name, $this->Style()->OptionsAsArray($varName))
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 { }
                                ->setRightTitle($this->Style()->$descriptionField);
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 { }
                            break;
                    }
                    $fields->replaceField(
                        $varName,
                        $newField
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                    );
                } else {
                    $fields->removeByName($varName);
                }
            }
            if($style->ClassNameForCSS) {
                $fields->replaceField(
                    'Image',
                    $uploadField = PerfectCMSImagesUploadField::create('Image', 'Image', null, $style->ClassNameForCSS)
                );
            }
        } else {
            $varsArray = $this->Config()->get('unique_vars');
            foreach($varsArray as $var){
                $fields->removeByName($var);
            }
            $fields->replaceField(
                'Image',
                $uploadField = LiteralField::create('ImageReminder', '<h2>Image Upload</h2><p>Please select a style first (see below) and save this record. After that you can upload an image</p>')
            );
        }

        $fields->replaceField(
            'Selections',
            CheckboxSetField::create(
                'Selections',
                'Included in ...',
                ImagesWithStyleSelection::get()->map()
            )
        );

        return $fields;
    }

    /**
     * @return string (HTML)

     */
    public function ImageElement()
    {
        return $this->getImageElement();
    }


    /**
     * @return string (HTML)

     */
    public function getImageElement()
    {
        $html = '';
        if($this->ImageID && $this->hasRealStyle()){
<?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.");
        }
    }

}
            $image = $this->Image();
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 { }
            if($image && $image->exists()) {
                $style = $this->Style();
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 { }
                $array = [
                    'Styles' => $this->buildStyles(),
                    'ClassNameForCSS' => $style->ClassNameForCSS,
                    'ImageTag' => $image->PerfectCMSImageTag($style->ClassNameForCSS),
                    'Caption' => $this->Description,
<?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.");
        }
    }

}
                    'ImageObject' => $this->Image()
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 ArrayData::create($array)->renderWith('ImageWithStyle');
            }
        }
        return $html;
    }

    /**
     * @return string (HTML)
     */
    public function buildStyles()
    {
        $styles = '';
        if($this->hasRealStyle()) {
            $style = $this->Style();
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 { }
            $stylesArray = [];
            $varsArray = $this->Config()->get('unique_vars');;
// Bad
$a = 5; $b = 6; $c = 7;

// Good
$a = 5;
$b = 6;
$c = 7;
            //var_dump($this->Style());

            foreach($varsArray as $var){
                if($this->$var){
                    $name = $var . 'Name';
                    $type = $var . 'Type';
                    $styleString = $style->$name . ': ' . $this->$var . $this->convertVarTypeToCSS($style->$type) . ';';
                    array_push($stylesArray, $styleString);
                }
            }
            if(! empty($stylesArray)){
                $styles = ' style="'.implode(" ", $stylesArray).'"';
            }
        }
        return $styles;
    }

    protected function hasRealStyle() 

    {
        if($this->StyleID) {
<?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.");
        }
    }

}
            $style = $this->Style();
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 $style->exists();
        }

        return false;
    }

    /**
     * @param string
     * @return string
     */
    protected function convertVarTypeToCSS($type)
    {
        $str = '';
        switch ($type){
            case 'Pixels':
                $str = 'px';
                break;
            case 'Percentage':
                $str = '%';
                break;
            case 'Options':
                break;
        }
        return $str;
    }
}


Push — master ( 34e737...1a9402 )

ImageWithStyle B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

1			<?php
2
3
4
5			class ImageWithStyle extends DataObject
			0 ignored issues – show Coding Style Compatibility introduced 2018-05-14 04:19 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...
6			{
7
8			#######################
9			### Names Section
10			#######################
11
12			private static $singular_name = 'Image With Style';
			0 ignored issues – show Comprehensibility introduced 2018-05-14 04:19 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-05-14 04:19 UTC by Report Bug Copy Issue Report The property `$singular_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...
13
14			function i18n_singular_name()
			0 ignored issues – show Best Practice introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
15			{
16			return _t('ImageWithStyle.SINGULAR_NAME', 'Image With Style');
17			}
18
19			private static $plural_name = 'Images With Style';
			0 ignored issues – show Comprehensibility introduced 2018-05-14 04:19 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-05-14 04:19 UTC by Report Bug Copy Issue Report The property `$plural_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...
20
21			function i18n_plural_name()
			0 ignored issues – show Best Practice introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
22			{
23			return _t('ImageWithStyle.PLURAL_NAME', 'Images With Style');
24			}
25
26
27			#######################
28			### Model Section
29			#######################
30
31			private static $db = [
			0 ignored issues – show Comprehensibility introduced 2018-05-14 04:19 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-05-14 04:19 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...
32			'Title' => 'Varchar',
33			'Description' => 'Text',
34			'Var1' => 'Varchar',

sunnysideup / silverstripe-imagewithstyle

Push — master ( 34e737...1a9402 )

ImageWithStyle B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like