ImagesWithStyleSelection::getCMSFields() - Code Metrics - Inspection of "MINOR: nicer way to add right titles" - sunnysideup/silverstripe-imagewithstyle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2729b4...e67fa1 )

by Nicolaas

created 2018-05-22 04:15 UTC

ImagesWithStyleSelection::getCMSFields() B

↳ Parent: ImagesWithStyleSelection

Complexity

Conditions	5
Paths	10

Size

Total Lines	44
Code Lines	30

Duplication

Lines	9
Ratio	20.45 %

Importance

Changes

Metric	Value
dl	9
loc	44
rs	8.439
c	0
b	0
f	0
cc	5
eloc	30
nc	10
nop	0

<?php



class ImagesWithStyleSelection extends DataObject
namespace YourVendor;

class YourClass { }
{


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

    private static $singular_name = 'Selection of Images';


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

    private static $plural_name = 'Selections of Images';


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


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

    private static $db = [

        'Title' => 'Varchar(255)', // this needs to be lengthy to avoid the same names ...
        'Description' => 'Text'
    ];

    private static $has_one = [

        'PlaceToStoreImages' => 'Folder'
    ];

    private static $many_many = [

        'StyledImages' => 'ImageWithStyle'
    ];

    private static $many_many_extraFields = [

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



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

    private static $indexes = [

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

    private static $defaults = [

        'Title' => ''
    ];

    private static $default_sort = [

        'Created' => 'DESC'
    ];

    private static $required_fields = [

        'Title'
    ];

    private static $searchable_fields = [

        'Title' => 'PartialMatchFilter'
    ];


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

    private static $field_labels = [

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

    private static $field_labels_right = [

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

    private static $summary_fields = [

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


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


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



    #######################
    ### 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(
                            '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();
        if ($this->exists() && $this->PlaceToStoreImagesID) {
<?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.");
        }
    }

}
            $allImages = Image::get()->filter(['ParentID' => $this->PlaceToStoreImagesID])->column('ID');
<?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.");
        }
    }

}
            $existingImages = $this->RawImages()->column('ID');
            $difference = array_diff($allImages, $existingImages);
            $list = $this->StyledImages();
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 (count($difference)) {
                foreach ($difference as $imageID) {
                    $image = Image::get()->byID($imageID);
                    if ($image) {
                        $styledImage = ImageWithStyle::create();
                        $styledImage->Title = $image->Name;
<?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.");
        }
    }

}
                        $styledImage->ImageID = $imageID;
<?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.");
        }
    }

}
                        $styledImage->StyleID = ImageStyle::get_default_style()->ID;
<?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.");
        }
    }

}
                        $styledImage->write();
                        $list->add($styledImage);
                    }
                }
            }
        }
        //...
    }

    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("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();
        $fields->removeByName('PlaceToStoreImages');
        $fields->addFieldToTab(
            'Root.Main',
            $treeField = TreeDropdownField::create(
                'PlaceToStoreImagesID',
                'Image Folder',
                'Folder'
            )->setRightTitle('Optional - set folder ... all images in this folder will automatically be added.')
        );
        
        //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);
            }
        }
        //...

        $this->addLinksToFolderOnAFieldAsRightTitle($treeField);

        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(),
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 { }
                        $config
                    )
                );
        }
        return $fields;
    }

    public function addLinksToFolderOnAFieldAsRightTitle($folderField)
    {
        if ($this->PlaceToStoreImagesID) {
<?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.");
        }
    }

}
            $folder = $this->PlaceToStoreImages();
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 ($folder && $folder->exists()) {
                $rightFieldTitle = $folderField->RightTitle();
                $rightFieldTitle .= '
                    <br  /><a href="/admin/assets/add/?ID='.$folder->ID.'" target="_blank">add images directly</a> to the <a href="/admin/assets/show/'.$folder->ID.'/" target="_blank">folder</a></a>
                    <br /><strong>To receive the latest updates uploaded to your folder, you will need to click save below!</strong>';
                $folderField->setRightTitle($rightFieldTitle);
            }
        }
    }

    /**
     * @return Int
     */
    public function ImageCount()
    {
        return $this->StyledImages()->count();
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 DataList
     */
    public function RawImages()
    {
        $array = [];
        if ($this->StyledImages()->count()) {
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 { }
            foreach ($this->StyledImages()->column('ImageID') as $id) {
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 ($id) {
                    $array[$id] = $id;
                }
            }
        }

        return Image::get()->filter(['ID' => $array]);
    }

    /**
     * force the list to use a certain folder ...
     * @param  string $folderName
     * @return ImagesWithStyleSelection
     */
    public function createFolder($folderName)
    {
        $folder = Folder::find_or_make($folderName);
        $this->PlaceToStoreImagesID = $folder->ID;
<?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->write();

        return $this;
    }
}


1			<?php
2
3
4
5			class ImagesWithStyleSelection 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			#######################
10			### Names Section
11			#######################
12
13			private static $singular_name = 'Selection of Images';
			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...
14
15			public function i18n_singular_name()
16			{
17			return _t('ImagesWithStyleSelection.SINGULAR_NAME', 'Selection of Images');
18			}
19
20			private static $plural_name = 'Selections of Images';
			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...
21
22			public function i18n_plural_name()
23			{
24			return _t('ImagesWithStyleSelection.PLURAL_NAME', 'Selections of Images');
25			}
26
27
28			#######################
29			### Model Section
30			#######################
31
32			private static $db = [
			0 ignored issues – show Comprehensibility introduced 2018-05-15 05:13 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-15 05:13 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...
33			'Title' => 'Varchar(255)', // this needs to be lengthy to avoid the same names ...
34			'Description' => 'Text'
35			];
36

sunnysideup / silverstripe-imagewithstyle

Push — master ( 2729b4...e67fa1 )

ImagesWithStyleSelection::getCMSFields() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like