ImagesWithStyleSelection

Complexity

Total Complexity

24

Size/Duplication

Total Lines	238
Duplicated Lines	22.69 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	i18n_singular_name()	0	4	1
A	i18n_plural_name()	0	4	1
C	validate()	45	45	11
A	onBeforeWrite()	0	5	1
A	onAfterWrite()	0	5	1
A	requireDefaultRecords()	0	5	1
A	getExportFields()	0	5	1
A	CMSEditLink()	0	6	1
A	CMSAddLink()	0	6	1
B	getCMSFields()	9	32	5

<?php



class ImagesWithStyleSelection extends DataObject

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{


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

    private static $singular_name = 'Selection of Images';

Consider using a different property name as you override a private property of the parent class.

The property $singular_name is not used and could be removed.

    function i18n_singular_name()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return _t('ImagesWithStyleSelection.SINGULAR_NAME', 'Selection of Images');
    }

    private static $plural_name = 'Selections of Images';

Consider using a different property name as you override a private property of the parent class.

The property $plural_name is not used and could be removed.

    function i18n_plural_name()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return _t('ImagesWithStyleSelection.PLURAL_NAME', 'Selections of Images');
    }


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

    private static $db = [

Consider using a different property name as you override a private property of the parent class.

The property $db is not used and could be removed.

        'Title' => 'Varchar',
        'Description' => 'Text'
    ];

    private static $many_many = [

Consider using a different property name as you override a private property of the parent class.

The property $many_many is not used and could be removed.

        'StyledImages' => 'ImageWithStyle'
    ];

    private static $many_many_extraFields = [

Consider using a different property name as you override a private property of the parent class.

The property $many_many_extraFields is not used and could be removed.

        'StyledImages' => [
            'SortOrder' => 'Int',
        ]
    ];



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

    private static $indexes = [

Consider using a different property name as you override a private property of the parent class.

The property $indexes is not used and could be removed.

        'Created' => true,
        'Title' => 'unique("Title")'
    ];

    private static $defaults = [

Consider using a different property name as you override a private property of the parent class.

The property $defaults is not used and could be removed.

        'Title' => ''
    ];

    private static $default_sort = [

Consider using a different property name as you override a private property of the parent class.

The property $default_sort is not used and could be removed.

        'Created' => 'DESC'
    ];

    private static $required_fields = [

The property $required_fields is not used and could be removed.

        'Title'
    ];

    private static $searchable_fields = [

Consider using a different property name as you override a private property of the parent class.

The property $searchable_fields is not used and could be removed.

        'Title' => 'PartialMatchFilter'
    ];


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

    private static $field_labels = [

Consider using a different property name as you override a private property of the parent class.

The property $field_labels is not used and could be removed.

        'StyledImages' => 'Images to be included'
    ];

    private static $field_labels_right = [

The property $field_labels_right is not used and could be removed.

        'StyledImages' => 'Select as many as you like and sort them in the right order'
    ];

    private static $summary_fields = [

Consider using a different property name as you override a private property of the parent class.

The property $summary_fields is not used and could be removed.

        'Title' => 'Name',
        'StyledImages.Count' => 'Number of Images'
    ];


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


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



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




    public function validate()

This method seems to be duplicated in your project.

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

        return $result;
    }

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

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

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


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

    public function getExportFields()

The return type could not be reliably inferred; please add a @return annotation.

    {
        //..
        return parent::getExportFields();

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?

    }



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


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

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

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

        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) {

This code seems to be duplicated across your project.

           $formField = $fields->DataFieldByName($field);
           if(! $formField) {
            $formField = $fields->DataFieldByName($field.'ID');
           }
           if($formField) {
               $formField->setDescription($desc);
           }
        }
        //...
        if($this->exists()) {
            $config = GridFieldConfig_RelationEditor::create();
            $config->addComponent(new GridFieldSortableRows('SortOrder'));
            $fields->removeByName('StyledImages');
            $fields->addFieldToTab(
                    'Root.Images',
                    GridField::create(
                        'StyledImages',
                        'Images',
                        $this->StyledImages(),

The method StyledImages does not exist on object<ImagesWithStyleSelection>? Since you implemented __call, maybe consider adding a @method annotation.

                        $config
                    )
                );
        }
        return $fields;
    }


}