CatalogProduct::fieldLabels() - Code Metrics - Inspection of "SilverStripe 4.0 stable updates" - dynamic/silverstripe-product-catalog - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#30)

by Jason
created 2017-12-01 03:39 UTC
CatalogProduct::fieldLabels() A

↳ Parent: CatalogProduct
Complexity

Conditions	1
Paths	1
Size

Total Lines	8
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	4
nc	1
nop	1
dl	0
loc	8
rs	9.4285
c	1
b	0
f	0
<?php

namespace Dynamic\ProductCatalog\ORM;

use Dynamic\ProductCatalog\Docs\CareCleaningDoc;
use Dynamic\ProductCatalog\Docs\OperationManual;
use Dynamic\ProductCatalog\Docs\SpecSheet;
use Dynamic\ProductCatalog\Docs\Warranty;
use Dynamic\ProductCatalog\Page\CatalogCategory;
use Dynamic\ViewableDataObject\VDOInterfaces\ViewableDataObjectInterface;
use SilverStripe\Assets\Image;
use SilverStripe\Dev\Debug;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\GridField\GridFieldAddNewButton;
use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
use SilverStripe\Forms\HTMLEditor\HTMLEditorField;
use SilverStripe\Forms\TextField;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;
use Symbiote\GridFieldExtensions\GridFieldAddExistingSearchButton;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;

class CatalogProduct extends DataObject implements PermissionProvider, ViewableDataObjectInterface
{
    /**
     * @var string
     */
    private static $singular_name = 'Product';


    /**
     * @var string
     */
    private static $plural_name = 'Products';


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

        'Title' => 'Varchar(255)',
        'Content' => 'HTMLText',
        'QuickFeatures' => 'HTMLText',
        'Dimensions' => 'Varchar(255)',
        'SKU' => 'Varchar(50)',
    );

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

        'Categories' => CatalogCategory::class,
        'CareCleaningDocs' => CareCleaningDoc::class,
        'OperationManuals' => OperationManual::class,
        'SpecSheets' => SpecSheet::class,
        'Warranties' => Warranty::class,
    );

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

        'Categories' => array(
            'SortOrder' => 'Int',
        ),
        'CareCleaningDocs' => array(
            'Sort' => 'Int',
        ),
        'OperationManuals' => array(
            'Sort' => 'Int',
        ),
        'SpecSheets' => array(
            'Sort' => 'Int',
        ),
        'Warranties' => array(
            'Sort' => 'Int',
        ),
    );

    /**
     * @var string
     */
    private static $table_name = 'CatalogProdcut';


    /**
     * @var bool
     */
    private static $versioned_gridfield_extensions = true;


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

        'ProductThumbnail' => 'Image',
        'Title' => 'Title',
        'Type' => 'Type',
        'CategoryList' => 'Categories',
    );

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

        'Title' => array(
            'title' => 'Product Name',
        ),
        'Categories.ID' => array(
            'title' => 'Category',
        ),
    );

    /**
     * @var string
     */
    private static $slide_tab_title = 'Images';


    /**
     * @param bool $includerelations
     * @return array|string
     */
    public function fieldLabels($includerelations = true)
    {
        $labels = parent::fieldLabels($includerelations);

        $labels['Title'] = 'Product Name';
        $labels['Categories.ID'] = 'Category';

        return $labels;
    }

    /**
     * @return string
     */
    public function CategoryList()
    {
        $list = '';

        if ($this->Categories()) {
        if ($this->/** @scrutinizer ignore-call */ Categories()) {
            $i = 0;
            foreach ($this->Categories()->sort('SortOrder') as $category) {
                $list .= $category->Title;
                if(++$i !== $this->Categories()->Count()) {
                    $list .= ", ";
                }
            }
        }
        return $list;
    }

    /**
     * @return mixed
     */
    public function getImage()
    {
        if ($this->Slides()->exists()) {
        if ($this->/** @scrutinizer ignore-call */ Slides()->exists()) {
            $slide = $this->Slides()->first();
            if ($slide->ImageID > 0) {
                return $slide->Image();
            }
        }
        return false;
    }

    /**
     * @return mixed
     */
    public function Image()
    {
        return $this->getImage();
    }

    /**
     * @return mixed
     */
    public function ProductThumbnail()
    {
        if ($image = $this->getImage()) {
            if ($thumb = Image::get()->byID($image->ID)) {
                return $thumb->CMSThumbnail();
            }
        }
        return false;
    }

    /**
     * @return \SilverStripe\Forms\FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $remove = [
            'Categories',
            'CareCleaningDocs',
            'OperationManuals',
            'SpecSheets',
            'Warranties',
            'DisabledBlocks',
            'Slides',
        ];

        if (!$this->ID) {
            $remove[] = 'Blocks';
        }

        $fields->removeByName($remove);

        $fields->insertBefore(
            $fields->dataFieldByName('SKU'),
            'Content'
            /** @scrutinizer ignore-type */ 'Content'
        );

        $fields->addFieldsToTab('Root.Info', array(
            TextField::create('Dimensions'),
            TextField::create(/** @scrutinizer ignore-type */ 'Dimensions'),
            HTMLEditorField::create('QuickFeatures')
                ->addExtraClass('stacked'),
        ));

        if ($this->ID) {
            // Categories
            $config = GridFieldConfig_RelationEditor::create();
            $config->addComponent(new GridFieldOrderableRows('SortOrder'));
            $config->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
            $config->addComponent(new GridFieldAddExistingSearchButton());
            $config->removeComponentsByType(GridFieldAddNewButton::class);
            $categories = $this->Categories()->sort('SortOrder');
            $categoryField = GridField::create('Categories', 'Categories', $categories, $config);

            $fields->addFieldsToTab('Root.Categories.Categories', array(
                $categoryField,
            ));

            // Care and Cleaning
            $config = GridFieldConfig_RecordEditor::create();
            $config->addComponent(new GridFieldOrderableRows('Sort'));
            $config->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
            $config->addComponent(new GridFieldAddExistingSearchButton());
            $operation = GridField::create('CareCleaningDocs', 'Care and Cleaning', $this->CareCleaningDocs()->sort('Sort'), $config);
            $operation = GridField::create('CareCleaningDocs', 'Care and Cleaning', $this->/** @scrutinizer ignore-call */ CareCleaningDocs()->sort('Sort'), $config);
            $fields->addFieldsToTab('Root.Files.Care', array(
                $operation,
            ));

            // Operation Manuals
            $config = GridFieldConfig_RecordEditor::create();
            $config->addComponent(new GridFieldOrderableRows('Sort'));
            $config->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
            $config->addComponent(new GridFieldAddExistingSearchButton());
            $operation = GridField::create('OperationManuals', 'Operation Manuals', $this->OperationManuals()->sort('Sort'), $config);
            $operation = GridField::create('OperationManuals', 'Operation Manuals', $this->/** @scrutinizer ignore-call */ OperationManuals()->sort('Sort'), $config);
            $fields->addFieldsToTab('Root.Files.Operation', array(
                $operation,
            ));

            // Spec Sheets
            $config = GridFieldConfig_RecordEditor::create();
            $config->addComponent(new GridFieldOrderableRows('Sort'));
            $config->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
            $config->addComponent(new GridFieldAddExistingSearchButton());
            $specsheets = GridField::create('SpecSheets', 'Spec Sheets', $this->SpecSheets()->sort('Sort'), $config);
            $specsheets = GridField::create('SpecSheets', 'Spec Sheets', $this->/** @scrutinizer ignore-call */ SpecSheets()->sort('Sort'), $config);
            $fields->addFieldsToTab('Root.Files.SpecSheets', array(
                $specsheets,
            ));

            // Warranties
            $config = GridFieldConfig_RecordEditor::create();
            $config->addComponent(new GridFieldOrderableRows('Sort'));
            $config->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
            $config->addComponent(new GridFieldAddExistingSearchButton());
            $warranties = GridField::create('Warranties', 'Warranties', $this->Warranties()->sort('Sort'), $config);
            $warranties = GridField::create('Warranties', 'Warranties', $this->/** @scrutinizer ignore-call */ Warranties()->sort('Sort'), $config);
            $fields->addFieldsToTab('Root.Files.Warranty', array(
                $warranties,
            ));
        }

        return $fields;
    }

    /**
     * @return CatalogCategory
     */
    public function getPrimaryCategory()
    {
        if ($this->Categories()->exists()) {
            $category = $this->Categories()->sort('SortOrder')->first();
        } else {
            $category = CatalogCategory::get()->first();
        }
        return $category;
    }

    /**
     * set ParentPage for ViewableDataobject
     *
     * @return string
     */
    public function getParentPage()
    {
        return $this->getPrimaryCategory();
    }

    /**
     * set ViewAction for ViewableDataobject
     *
     * @return string
     */
    public function getViewAction()
    {
        return 'view';
    }

    /**
     * @return \SilverStripe\ORM\DataList
     */
    public function getAncestors()
    {
        return CatalogCategory::get();
    }

    /**
     * @return array
     */
    public function providePermissions()
    {
        return array(
            'Product_EDIT' => 'Edit a Product',
            'Product_DELETE' => 'Delete a Product',
            'Product_CREATE' => 'Create a Product',
        );
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canEdit($member = null, $context = [])
    public function canEdit($member = null, /** @scrutinizer ignore-unused */ $context = [])
    {
        return Permission::check('Product_EDIT', 'any', $member);
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canDelete($member = null, $context = [])
    public function canDelete($member = null, /** @scrutinizer ignore-unused */ $context = [])
    {
        return Permission::check('Product_DELETE', 'any', $member);
    }

    /**
     * @param null $member

     *
     * @return bool|int
     */
    public function canCreate($member = null, $context = [])
    {
        return Permission::check('Product_CREATE', 'any', $member);
    }

    /**
     * @param null $member

     *
     * @return bool
     */
    public function canView($member = null, $context = [])
    public function canView($member = null, /** @scrutinizer ignore-unused */ $context = [])
    {
        return true;
    }

    /**
     * @return array
     */
    public function allowedChildren()
    {
        return [];
    }
}
dynamic / silverstripe-product-catalog

Pull Request — master (#30)

CatalogProduct::fieldLabels() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
