ImageStyle - Code Metrics - Inspection of "MAJOR: adding ability to add folder at once" - sunnysideup/silverstripe-imagewithstyle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 00e697...ce1abf )

by Nicolaas

created 2018-05-14 11:18 UTC

ImageStyle C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	408
Duplicated Lines	13.24 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

Metric	Value
wmc	56
lcom	1
cbo	6
dl	54
loc	408
rs	6.5957
c	0
b	0
f	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	get_default_style()	0	16	3
A	i18n_singular_name()	0	4	1
A	i18n_plural_name()	0	4	1
A	canCreate()	0	4	1
A	canEdit()	0	5	1
A	canDelete()	0	8	2
C	validate()	45	45	11
A	onBeforeWrite()	0	9	2
A	onAfterWrite()	0	5	1
C	requireDefaultRecords()	0	37	11
A	getExportFields()	0	5	1
A	CMSEditLink()	0	6	1
A	CMSAddLink()	0	6	1
C	getCMSFields()	9	50	8
B	HasStyleVariable()	0	11	6
A	HasOptionsAsArray()	0	6	2
A	OptionsAsArray()	0	13	3

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 ImageStyle 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 ImageStyle, and based on these observations, apply Extract Interface, too.

<?php



class ImageStyle extends DataObject
namespace YourVendor;

class YourClass { }
{

    private static $default_style = 'unstyled-image';

    public static function get_default_style()

    {
        $defaultStyle = ImageStyle::get()->filter(
            [
                'ClassNameForCSS' => Config::inst()->get('ImageStyle', 'default_style')
            ]
        )->first();
        if(! $defaultStyle) {
            $defaultStyle = ImageStyle::get()->first();
            if(! $defaultStyle) {
                user_error('Could not find a default Style.');
            }
        }

        return $defaultStyle;
    }

    /**
     * see _config folder for details ...
     * @var array
     */
    private static $record_defaults = [];


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

    private static $singular_name = 'Image Style';


    public function i18n_singular_name()
    {
        return _t('ImageStyle.SINGULAR_NAME', 'Image Style');
    }

    private static $plural_name = 'Image Styles';


    public function i18n_plural_name()
    {
        return _t('ImageStyle.PLURAL_NAME', 'Image Styles');
    }


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

    private static $db = [

        'Title' => 'Varchar',
        'ClassNameForCSS' => 'Varchar',
        'Description' => 'Text',
        'Var1Name' => 'Varchar',
        'Var1Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
        'Var1Options' => 'Varchar(200)',
        'Var1Description' => 'Varchar(200)',

        'Var2Name' => 'Varchar',
        'Var2Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
        'Var2Options' => 'Varchar(200)',
        'Var2Description' => 'Varchar(200)',

        'Var3Name' => 'Varchar',
        'Var3Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
        'Var3Options' => 'Varchar(200)',
        'Var3Description' => 'Varchar(200)',

        'Var4Name' => 'Varchar',
        'Var4Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
        'Var4Options' => 'Varchar(200)',
        'Var4Description' => 'Varchar(200)',

        'Var5Name' => 'Varchar',
        'Var5Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
        'Var5Options' => 'Varchar(200)',
        'Var5Description' => 'Varchar(200)',

    ];

    private static $has_many = [

        'ImagesWithStyle' => 'ImageWithStyle'
    ];


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

    private static $indexes = [

        'Title' => true
    ];

    private static $default_sort = [

        'Title' => 'ASC'
    ];

    private static $required_fields = [
        'Title',
        'ClassNameForCSS'
    ];

    private static $searchable_fields = [

        'Title' => 'PartialMatchFilter',
        'Description' => 'PartialMatchFilter',
        'ClassNameForCSS' => 'PartialMatchFilter'
    ];


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

    private static $field_labels = [

        'Title' => 'Style',

        'Var1Name' => 'Variable 1 Label',
        'Var1Type' => 'Variable 1 Type',
        'Var1Options' => 'Variable 1 Options',
        'Var1Description' => 'Variable 1 Description',

        'Var2Name' => 'Variable 2 Label',
        'Var2Type' => 'Variable 2 Type',
        'Var2Options' => 'Variable 1 Options',
        'Var2Description' => 'Variable 1 Description',

        'Var3Name' => 'Variable 3 Label',
        'Var3Type' => 'Variable 3 Type',
        'Var3Options' => 'Variable 1 Options',
        'Var4Description' => 'Variable 1 Description',

        'Var4Name' => 'Variable 4 Label',
        'Var4Type' => 'Variable 4 Type',
        'Var4Options' => 'Variable 4 Options',
        'Var4Description' => 'Variable 4 Description',

        'Var5Name' => 'Variable 5 Label',
        'Var5Type' => 'Variable 5 Type',
        'Var5Options' => 'Variable 5 Options',
        'Var5Description' => 'Variable 5 Description',
    ];

    private static $field_labels_right = [];

    private static $summary_fields = [

        'Title' => 'Style',
        'ImagesWithStyle.Count' => 'Usage Count'
    ];


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


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

    public function canCreate($member = null)
    {
        return false;
    }

    public function canEdit($member = null)
    {
        //we block edits in CMS
        return parent::canEdit($member);
    }

    public function canDelete($member = null)
    {
        if ($this->ImagesWithStyle()->count() === 0) {
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 parent::canDelete($member);
        }

        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 (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(
                            'ImageStyle.'.$field.'_REQUIRED',
                            $myName.' is required'
                        ),
                        'REQUIRED_ImageStyle_'.$field
                    );
                }
                if (isset($indexes[$field]) && isset($indexes[$field]['type']) && $indexes[$field]['type'] === 'unique') {
                    $id = (empty($this->ID) ? 0 : $this->ID);
                    $count = ImageStyle::get()
                        ->filter(array($field => $value))
                        ->exclude(array('ID' => $id))
                        ->count();
                    if ($count > 0) {
                        $myName = $fieldLabels['$field'];
                        $result->error(
                            _t(
                                'ImageStyle.'.$field.'_UNIQUE',
                                $myName.' needs to be unique'
                            ),
                            'UNIQUE_ImageStyle_'.$field
                        );
                    }
                }
            }
        }

        return $result;
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        $this->ClassNameForCSS = preg_replace('/\W+/', '-', strtolower(strip_tags($this->ClassNameForCSS)));

        if (! $this->ClassNameForCSS) {

            $this->ClassNameForCSS = 'image-with-style-'.$this->ID;

        }
        //...
    }

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

    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        //...
        $defaults = $this->Config()->record_defaults;
        $currentOnes = array_flip(ImageStyle::get()->column('ID'));
        $imageNames = Config::inst()->get('PerfectCMSImageDataExtension', 'perfect_cms_images_image_definitions');
        foreach ($defaults as $defaultValues) {
            foreach ($defaultValues as $field => $value) {
                if (is_array($value)) {
                    $defaultValues[$field] = serialize($value);
                }
            }
            $obj = ImageStyle::get()->filter(['Title' => $defaultValues['Title']])->first();
            if (!$obj) {
                $obj = ImageStyle::create($defaultValues);
            } else {
                foreach ($obj->db() as $field => $type) {
                    $obj->$field = null;
                }
                foreach ($defaultValues as $field => $value) {
                    $obj->$field = $value;
                }
            }
            unset($currentOnes[$obj->ID]);
            $obj->write();
            if (! isset($imageNames[$obj->ClassNameForCSS])) {

                user_error('You need to define a perfect CMS image with the following name: '.$obj->ClassNameForCSS);

            }
        }
        foreach ($currentOnes as $id) {
            $obj = ImageStyle::get()->byID($id);
            if ($obj && $obj->canDelete()) {
                $obj->delete();
            }
        }
    }


    #######################
    ### 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);
            }
        }

        // move variables to their own tab
        for ($i = 1; $i < 6; $i++) {
            if ($this->HasStyleVariable('Var'.$i)) {
                $fieldsToAdd = [
                    $fields->dataFieldByName('Var'.$i.'Name'),
                    $fields->dataFieldByName('Var'.$i.'Type'),
                    $fields->dataFieldByName('Var'.$i.'Options'),
                    $fields->dataFieldByName('Var'.$i.'Description')
                ];
                $fields->addFieldsToTab(
                    'Root.Variable '.$i,
                    $fieldsToAdd
                );
            } else {
                $fields->removeByName('Var'.$i.'Name');
                $fields->removeByName('Var'.$i.'Type');
                $fields->removeByName('Var'.$i.'Options');
                $fields->removeByName('Var'.$i.'Description');
            }
        }
        $fields->removeByName('ImagesWithStyle');

        //make everything readonly
        foreach ($fields->saveableFields() as $field) {
            $fieldName = $field->getName();
            $oldField = $fields->dataFieldByName($fieldName);
            if ($oldField) {
                $newField = $oldField->performReadonlyTransformation();
                $fields->replaceField($fieldName, $newField);
            }
        }

        return $fields;
    }


    public function HasStyleVariable($varName)
    {
        $name = $varName.'Name';
        $type = $varName.'Type';
        $hasBase = $this->$name && $this->$type ? true : false;
        if ($this->$type === 'Options') {
            return $hasBase && is_array($this->OptionsAsArray($varName)) ? true : false;
        } else {
            return $hasBase;
        }
    }
    public function HasOptionsAsArray($varName)
    {
        $options = $this->OptionsAsArray($varName);

        return count($options) ? true : false;
    }

    public function OptionsAsArray($varName) : array
    {
        $options = $varName.'Options';
        $array = [];
        if ($this->$options) {
            $array = @unserialize($this->$options);
        }
        if (is_array($array)) {
            return $array;
        }

        return [];
    }
}


1		<?php
2
3
4
5		class ImageStyle 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		private static $default_style = 'unstyled-image';
9
10		public static function get_default_style()
		0 ignored issues – show Documentation introduced 2018-05-14 11:19 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
11		{
12		$defaultStyle = ImageStyle::get()->filter(
13		[
14		'ClassNameForCSS' => Config::inst()->get('ImageStyle', 'default_style')
15		]
16		)->first();
17		if(! $defaultStyle) {
18		$defaultStyle = ImageStyle::get()->first();
19		if(! $defaultStyle) {
20		user_error('Could not find a default Style.');
21		}
22		}
23
24		return $defaultStyle;
25		}
26
27		/**
28		* see _config folder for details ...
29		* @var array
30		*/
31		private static $record_defaults = [];
32
33
34		#######################
35		### Names Section
36		#######################
37
38		private static $singular_name = 'Image 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...
39
40		public function i18n_singular_name()
41		{
42		return _t('ImageStyle.SINGULAR_NAME', 'Image Style');
43		}
44
45		private static $plural_name = 'Image Styles';
		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...
46
47		public function i18n_plural_name()
48		{
49		return _t('ImageStyle.PLURAL_NAME', 'Image Styles');
50		}
51
52
53		#######################
54		### Model Section
55		#######################
56
57		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...
58		'Title' => 'Varchar',
59		'ClassNameForCSS' => 'Varchar',
60		'Description' => 'Text',
61		'Var1Name' => 'Varchar',
62		'Var1Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
63		'Var1Options' => 'Varchar(200)',
64		'Var1Description' => 'Varchar(200)',
65
66		'Var2Name' => 'Varchar',
67		'Var2Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
68		'Var2Options' => 'Varchar(200)',
69		'Var2Description' => 'Varchar(200)',
70
71		'Var3Name' => 'Varchar',
72		'Var3Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
73		'Var3Options' => 'Varchar(200)',
74		'Var3Description' => 'Varchar(200)',
75
76		'Var4Name' => 'Varchar',
77		'Var4Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
78		'Var4Options' => 'Varchar(200)',
79		'Var4Description' => 'Varchar(200)',
80
81		'Var5Name' => 'Varchar',
82		'Var5Type' => 'Enum(\'Pixels,Percentage,Options\', \'Pixels\')',
83		'Var5Options' => 'Varchar(200)',
84		'Var5Description' => 'Varchar(200)',
85
86		];
87
88		private static $has_many = [
		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...
89		'ImagesWithStyle' => 'ImageWithStyle'
90		];
91
92
93		#######################
94		### Further DB Field Details
95		#######################
96
97		private static $indexes = [
		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...
98		'Title' => true
99		];
100
101		private static $default_sort = [
		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...
102		'Title' => 'ASC'
103		];
104
105		private static $required_fields = [
106		'Title',
107		'ClassNameForCSS'
108		];
109
110		private static $searchable_fields = [
		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...
111		'Title' => 'PartialMatchFilter',
112		'Description' => 'PartialMatchFilter',
113		'ClassNameForCSS' => 'PartialMatchFilter'
114		];
115
116
117		#######################
118		### Field Names and Presentation Section
119		#######################
120
121		private static $field_labels = [
		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...
122		'Title' => 'Style',
123
124		'Var1Name' => 'Variable 1 Label',
125		'Var1Type' => 'Variable 1 Type',
126		'Var1Options' => 'Variable 1 Options',
127		'Var1Description' => 'Variable 1 Description',
128
129		'Var2Name' => 'Variable 2 Label',
130		'Var2Type' => 'Variable 2 Type',
131		'Var2Options' => 'Variable 1 Options',
132		'Var2Description' => 'Variable 1 Description',
133
134		'Var3Name' => 'Variable 3 Label',
135		'Var3Type' => 'Variable 3 Type',
136		'Var3Options' => 'Variable 1 Options',
137		'Var4Description' => 'Variable 1 Description',
138
139		'Var4Name' => 'Variable 4 Label',
140		'Var4Type' => 'Variable 4 Type',
141		'Var4Options' => 'Variable 4 Options',
142		'Var4Description' => 'Variable 4 Description',
143
144		'Var5Name' => 'Variable 5 Label',
145		'Var5Type' => 'Variable 5 Type',
146		'Var5Options' => 'Variable 5 Options',
147		'Var5Description' => 'Variable 5 Description',
148		];
149
150		private static $field_labels_right = [];
151
152		private static $summary_fields = [
		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...
153		'Title' => 'Style',
154		'ImagesWithStyle.Count' => 'Usage Count'
155		];
156
157
158		#######################
159		### Casting Section
160		#######################
161
162
163		#######################
164		### can Section
165		#######################
166
167		public function canCreate($member = null)
168		{
169		return false;
170		}
171
172		public function canEdit($member = null)
173		{
174		//we block edits in CMS
175		return parent::canEdit($member);
176		}
177
178		public function canDelete($member = null)
179		{
180		if ($this->ImagesWithStyle()->count() === 0) {
		0 ignored issues – show Documentation Bug introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report The method `ImagesWithStyle` does not exist on `object<ImageStyle>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: 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 { } Loading history...
181		return parent::canDelete($member);
182		}
183
184		return false;
185		}
186
187
188
189		#######################
190		### write Section
191		#######################
192
193
194
195
196	View Code Duplication	public function validate()
		0 ignored issues – show Duplication introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
197		{
198		$result = parent::validate();
199		$fieldLabels = $this->FieldLabels();
200		$indexes = $this->Config()->get('indexes');
201		$requiredFields = $this->Config()->get('required_fields');
202		if (is_array($requiredFields)) {
203		foreach ($requiredFields as $field) {
204		$value = $this->$field;
205		if (! $value) {
206		$fieldWithoutID = $field;
207		if (substr($fieldWithoutID, -2) === 'ID') {
208		$fieldWithoutID = substr($fieldWithoutID, 0, -2);
209		}
210		$myName = isset($fieldLabels[$fieldWithoutID]) ? $fieldLabels[$fieldWithoutID] : $fieldWithoutID;
211		$result->error(
212		_t(
213		'ImageStyle.'.$field.'_REQUIRED',
214		$myName.' is required'
215		),
216		'REQUIRED_ImageStyle_'.$field
217		);
218		}
219		if (isset($indexes[$field]) && isset($indexes[$field]['type']) && $indexes[$field]['type'] === 'unique') {
220		$id = (empty($this->ID) ? 0 : $this->ID);
221		$count = ImageStyle::get()
222		->filter(array($field => $value))
223		->exclude(array('ID' => $id))
224		->count();
225		if ($count > 0) {
226		$myName = $fieldLabels['$field'];
227		$result->error(
228		_t(
229		'ImageStyle.'.$field.'_UNIQUE',
230		$myName.' needs to be unique'
231		),
232		'UNIQUE_ImageStyle_'.$field
233		);
234		}
235		}
236		}
237		}
238
239		return $result;
240		}
241
242		public function onBeforeWrite()
243		{
244		parent::onBeforeWrite();
245		$this->ClassNameForCSS = preg_replace('/\W+/', '-', strtolower(strip_tags($this->ClassNameForCSS)));
		0 ignored issues – show Bug introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report The property `ClassNameForCSS` does not seem to exist. Did you mean `ClassName`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
246		if (! $this->ClassNameForCSS) {
		0 ignored issues – show Bug introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report The property `ClassNameForCSS` does not seem to exist. Did you mean `ClassName`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
247		$this->ClassNameForCSS = 'image-with-style-'.$this->ID;
		0 ignored issues – show Bug introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report The property `ClassNameForCSS` does not seem to exist. Did you mean `ClassName`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
248		}
249		//...
250		}
251
252		public function onAfterWrite()
253		{
254		parent::onAfterWrite();
255		//...
256		}
257
258		public function requireDefaultRecords()
259		{
260		parent::requireDefaultRecords();
261		//...
262		$defaults = $this->Config()->record_defaults;
263		$currentOnes = array_flip(ImageStyle::get()->column('ID'));
264		$imageNames = Config::inst()->get('PerfectCMSImageDataExtension', 'perfect_cms_images_image_definitions');
265		foreach ($defaults as $defaultValues) {
266		foreach ($defaultValues as $field => $value) {
267		if (is_array($value)) {
268		$defaultValues[$field] = serialize($value);
269		}
270		}
271		$obj = ImageStyle::get()->filter(['Title' => $defaultValues['Title']])->first();
272		if (!$obj) {
273		$obj = ImageStyle::create($defaultValues);
274		} else {
275		foreach ($obj->db() as $field => $type) {
276		$obj->$field = null;
277		}
278		foreach ($defaultValues as $field => $value) {
279		$obj->$field = $value;
280		}
281		}
282		unset($currentOnes[$obj->ID]);
283		$obj->write();
284		if (! isset($imageNames[$obj->ClassNameForCSS])) {
		0 ignored issues – show Bug introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report The property `ClassNameForCSS` does not seem to exist. Did you mean `ClassName`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
285		user_error('You need to define a perfect CMS image with the following name: '.$obj->ClassNameForCSS);
		0 ignored issues – show Bug introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report The property `ClassNameForCSS` does not seem to exist. Did you mean `ClassName`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
286		}
287		}
288		foreach ($currentOnes as $id) {
289		$obj = ImageStyle::get()->byID($id);
290		if ($obj && $obj->canDelete()) {
291		$obj->delete();
292		}
293		}
294		}
295
296
297		#######################
298		### Import / Export Section
299		#######################
300
301		public function getExportFields()
		0 ignored issues – show Documentation introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
302		{
303		//..
304		return parent::getExportFields();
		0 ignored issues – show Bug introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `DataObject` as the method `getExportFields()` does only exist in the following sub-classes of `DataObject`: `ImageStyle`, `ImageWithStyle`, `ImagesWithStyleSelection`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: 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. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
305		}
306
307
308
309		#######################
310		### CMS Edit Section
311		#######################
312
313
314		public function CMSEditLink()
315		{
316		$controller = singleton("tba");
317
318		return $controller->Link().$this->ClassName."/EditForm/field/".$this->ClassName."/item/".$this->ID."/edit";
319		}
320
321		public function CMSAddLink()
322		{
323		$controller = singleton("tba");
324
325		return $controller->Link().$this->ClassName."/EditForm/field/".$this->ClassName."/item/new";
326		}
327
328
329		public function getCMSFields()
330		{
331		$fields = parent::getCMSFields();
332
333		//do first??
334		$rightFieldDescriptions = $this->Config()->get('field_labels_right');
335	View Code Duplication	foreach ($rightFieldDescriptions as $field => $desc) {
		0 ignored issues – show Duplication introduced 2018-05-14 04:19 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
336		$formField = $fields->DataFieldByName($field);
337		if (! $formField) {
338		$formField = $fields->DataFieldByName($field.'ID');
339		}
340		if ($formField) {
341		$formField->setDescription($desc);
342		}
343		}
344
345		// move variables to their own tab
346		for ($i = 1; $i < 6; $i++) {
347		if ($this->HasStyleVariable('Var'.$i)) {
348		$fieldsToAdd = [
349		$fields->dataFieldByName('Var'.$i.'Name'),
350		$fields->dataFieldByName('Var'.$i.'Type'),
351		$fields->dataFieldByName('Var'.$i.'Options'),
352		$fields->dataFieldByName('Var'.$i.'Description')
353		];
354		$fields->addFieldsToTab(
355		'Root.Variable '.$i,
356		$fieldsToAdd
357		);
358		} else {
359		$fields->removeByName('Var'.$i.'Name');
360		$fields->removeByName('Var'.$i.'Type');
361		$fields->removeByName('Var'.$i.'Options');
362		$fields->removeByName('Var'.$i.'Description');
363		}
364		}
365		$fields->removeByName('ImagesWithStyle');
366
367		//make everything readonly
368		foreach ($fields->saveableFields() as $field) {
369		$fieldName = $field->getName();
370		$oldField = $fields->dataFieldByName($fieldName);
371		if ($oldField) {
372		$newField = $oldField->performReadonlyTransformation();
373		$fields->replaceField($fieldName, $newField);
374		}
375		}
376
377		return $fields;
378		}
379
380
381		public function HasStyleVariable($varName)
382		{
383		$name = $varName.'Name';
384		$type = $varName.'Type';
385		$hasBase = $this->$name && $this->$type ? true : false;
386		if ($this->$type === 'Options') {
387		return $hasBase && is_array($this->OptionsAsArray($varName)) ? true : false;
388		} else {
389		return $hasBase;
390		}
391		}
392		public function HasOptionsAsArray($varName)
393		{
394		$options = $this->OptionsAsArray($varName);
395
396		return count($options) ? true : false;
397		}
398
399		public function OptionsAsArray($varName) : array
400		{
401		$options = $varName.'Options';
402		$array = [];
403		if ($this->$options) {
404		$array = @unserialize($this->$options);
405		}
406		if (is_array($array)) {
407		return $array;
408		}
409
410		return [];
411		}
412		}
413

sunnysideup / silverstripe-imagewithstyle

Push — master ( 00e697...ce1abf )

ImageStyle C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

17 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Duplication Side-by-Side

Filter issues like