Purchasable::updateFieldLabels() - Code Metrics - Inspection of "REFACTOR remove VCS for Groupable Gridfield (#105)" - dynamic/silverstripe-foxy - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 71a588...6672d2 )

by Nic
created 2020-07-18 19:55 UTC
Purchasable::updateFieldLabels() A

↳ Parent: Purchasable
Complexity

Conditions	1
Paths	1
Size

Total Lines	11
Code Lines	9
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	9
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	11
rs	9.9666
<?php

namespace Dynamic\Foxy\Extension;

use Dynamic\Foxy\Model\FoxyCategory;
use Dynamic\Foxy\Model\ProductOption;
use Dynamic\Foxy\Model\Variation;
use Dynamic\Foxy\Model\VariationType;
use micschk\GroupableGridfield\GridFieldGroupable;
use SilverStripe\Forms\CheckboxField;
use SilverStripe\Forms\CurrencyField;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
use SilverStripe\Forms\GridField\GridFieldPageCount;
use SilverStripe\Forms\GridField\GridFieldPaginator;
use SilverStripe\Forms\GridField\GridFieldSortableHeader;
use SilverStripe\Forms\NumericField;
use SilverStripe\Forms\RequiredFields;
use SilverStripe\Forms\TextField;
use SilverStripe\ORM\DataExtension;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\HasManyList;
use SilverStripe\ORM\ManyManyList;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\Security\Security;
use Symbiote\GridFieldExtensions\GridFieldAddExistingSearchButton;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
use Symbiote\GridFieldExtensions\GridFieldTitleHeader;

/**
 * Class Purchasable
 * @package Dynamic\Foxy\Extension
 *
 * @property double Price
 * @property string Code
 * @property string ReceiptTitle
 * @property bool Available
 * @property int $QuantityMax
 *
 * @property int FoxyCategoryID
 * @method FoxyCategory FoxyCategory()
 *
 * @method HasManyList Variations()
 * @method ManyManyList Options()
 *
 * @property-read DataObject|Purchasable $owner
 */
class Purchasable extends DataExtension implements PermissionProvider
{
    /**
     * @var
     */
    private $has_variations;

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

        'Price' => 'Currency',
        'Code' => 'Varchar(100)',
        'ReceiptTitle' => 'HTMLVarchar(255)',
        'Available' => 'Boolean',
        'QuantityMax' => 'Int',
    ];

    /**
     * @var array
     */
    private static $has_one = [

        'FoxyCategory' => FoxyCategory::class,
    ];

    /**
     * @var string[]
     */
    private static $has_many = [

        'Variations' => Variation::class,
    ];

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

        'Options' => ProductOption::class,
    ];

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

        'Options' => [
            'WeightModifier' => 'Decimal(9,3)',
            'CodeModifier' => 'Text',
            'PriceModifier' => 'Currency',
            'WeightModifierAction' => "Enum('Add,Subtract,Set', null)",
            'CodeModifierAction' => "Enum('Add,Subtract,Set', null)",
            'PriceModifierAction' => "Enum('Add,Subtract,Set', null)",
            'Available' => 'Boolean',
            'Type' => 'Int',
            'OptionModifierKey' => 'Varchar(255)',
            'SortOrder' => 'Int',
        ],
        'OptionTypes' => [
            'SortOrder' => 'Int',
        ],
    ];

    /**
     * @var array
     */
    private static $indexes = [

        'Code' => [
            'type' => 'unique',
            'columns' => ['Code'],
        ],
    ];

    /**
     * @var array
     */
    private static $defaults = [

        'ShowInMenus' => false,
        'Available' => true,
    ];

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

        'Image.CMSThumbnail',
        'Title',
        'Code',
        'Price.Nice',
    ];

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

        'Title',
        'Code',
        'Available',
    ];

    /**
     * @param array $labels
     */
    public function updateFieldLabels(&$labels)
    {
        $labels['Title'] = _t(__CLASS__ . '.TitleLabel', 'Product Name');
        $labels['Code'] = _t(__CLASS__ . '.CodeLabel', 'Code');
        $labels['Price'] = _t(__CLASS__ . '.PriceLabel', 'Price');
        $labels['Price.Nice'] = _t(__CLASS__ . '.PriceLabel', 'Price');
        $labels['Available'] = _t(__CLASS__ . '.AvailableLabel', 'Available for purchase');
        $labels['Available.Nice'] = _t(__CLASS__ . '.AvailableLabelNice', 'Available');
        $labels['Image.CMSThumbnail'] = _t(__CLASS__ . '.ImageLabel', 'Image');
        $labels['ReceiptTitle'] = _t(__CLASS__ . '.ReceiptTitleLabel', 'Product title for receipt');
        $labels['FoxyCategoryID'] = _t(__CLASS__ . '.FoxyCategoryLabel', 'Foxy Category');
    }

    /**
     * @param FieldList $fields
     */
    public function updateCMSFields(FieldList $fields)
    {
        $fields->removeByName([
            'SKU',
        ]);

        $fields->addFieldsToTab(
            'Root.Ecommerce',
            [
                CurrencyField::create('Price')
                    ->setDescription(_t(
                        __CLASS__ . '.PriceDescription',
                        'Base price for this product. Can be modified using Product Options'
                    )),
                TextField::create('Code')
                    ->setDescription(_t(
                        __CLASS__ . '.CodeDescription',
                        'Required, must be unique. Product identifier used by FoxyCart in transactions. All leading and trailing spaces are removed on save.'
                    )),
                DropdownField::create('FoxyCategoryID')
                    ->setTitle($this->owner->fieldLabel('FoxyCategoryID'))
                    ->setTitle($this->owner->/** @scrutinizer ignore-call */ fieldLabel('FoxyCategoryID'))
                    ->setSource(FoxyCategory::get()->map())
                    ->setDescription(_t(
                        __CLASS__ . '.FoxyCategoryDescription',
                        'Required. Must also exist in
                        <a href="https://admin.foxycart.com/admin.php?ThisAction=ManageProductCategories"
                            target="_blank">
                            Foxy Categories
                        </a>.
                        Used to set category specific options like shipping and taxes. Managed in Foxy > Categories'
                    ))
                    ->setEmptyString(''),
                TextField::create('ReceiptTitle')
                    ->setDescription(_t(
                        __CLASS__ . '.ReceiptTitleDescription',
                        'Optional. Alternate title to display on order receipt'
                    )),
            ],
            'Content'
        );

        if ($this->owner->exists()) {
        if ($this->owner->/** @scrutinizer ignore-call */ exists()) {
            $config = GridFieldConfig_RelationEditor::create();
            $config
                ->addComponents([
                    new GridFieldOrderableRows('SortOrder'),
                    new GridFieldAddExistingSearchButton(),
                ])
                ->removeComponentsByType([
                    GridFieldAddExistingAutocompleter::class,
                ]);
            $options = GridField::create(
                'Options',
                'Options',
                $this->owner->Options()->sort('SortOrder'),
                $config
            );

            $fields->addFieldsToTab(
                'Root.Options',
                [
                    $options,
                ]
            );

            $variationsConfig = GridFieldConfig_RelationEditor::create()
                ->removeComponentsByType([
                    GridFieldAddExistingAutocompleter::class,
                    GridFieldPaginator::class,
                    GridFieldPageCount::class,
                    GridFieldSortableHeader::class,
                ])
                ->addComponents([
                    new GridFieldOrderableRows('SortOrder'),
                    new GridFieldTitleHeader(),
                    new GridFieldGroupable(
                        'VariationTypeID',    // The fieldname to set the Group
                        'Variation Type',   // A description of the function of the group
                        'none',         // A title/header for items without a group/unassigned
                        VariationType::get()->sort('SortOrder')->map()->toArray()
                    )
                ]);

            $fields->addFieldToTab(
                'Root.Variations',
                GridField::create(
                    'Variations',
                    'Variations',
                    $this->owner->Variations(),
                    $variationsConfig
                )
            );
        }

        $fields->addFieldsToTab(
            'Root.Inventory',
            [
                NumericField::create('QuantityMax')
                    ->setTitle('Maximum quantity allowed in the cart')
                    ->setDescription('For unlimited enter 0')
                    ->addExtraClass('stacked'),
                CheckboxField::create('Available')
                    ->setDescription(_t(
                        __CLASS__ . '.AvailableDescription',
                        'If unchecked, will remove "Add to Cart" form and instead display "Currently unavailable"'
                    )),
            ]
        );
    }

    /**
     * @return RequiredFields
     */
    public function getCMSValidator()
    {
        return new RequiredFields([
            "Price",
            "Code",
            "FoxyCategoryID",
        ]);
    }

    /**
     * @return $this
     */
    public function setHasVariations()
    {
        $this->has_variations = $this->owner->Variations()->exists();
        return $this;
    }

    /**
     * @return mixed
     */
    public function getHasVariations()
    {
        if (!$this->has_variations) {
            $this->setHasVariations();
        }
        return $this->has_variations;
    }

    /**
     * @return mixed
     */
    public function isAvailable()
    {
        if (!$this->owner->Available) {
            return false;
        }

        if (!$this->getHasVariations()) {
            return true;
        }

        foreach ($this->owner->Variations() as $variation) {
            if ($variation->Available) {
                return true;
            }
        }

        return false;
    }

    /**
     * @return bool
     */
    public function isProduct()
    {
        return true;
    }

    /**
     * @return array
     */
    public function providePermissions()
    {
        return [
            'MANAGE_FOXY_PRODUCTS' => [
                'name' => _t(
                    __CLASS__ . '.PERMISSION_MANAGE_PRODUCTS_DESCRIPTION',
                    'Manage products'
                ),
                'category' => _t(
                    __CLASS__ . '.PERMISSIONS_CATEGORY',
                    'Foxy'
                ),
                'help' => _t(
                    __CLASS__ . '.PERMISSION_MANAGE_PRODUCTS_HELP',
                    'Manage products and related settings'
                ),
                'sort' => 400,
            ],
        ];
    }

    /**
     * @param $member
     * @return bool|int|void
     */
    public function canCreate($member)
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        return Permission::checkMember($member, 'MANAGE_FOXY_PRODUCTS');
    }

    /**
     * @param $member
     * @return bool|int|void|null
     */
    public function canEdit($member)
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        return Permission::checkMember($member, 'MANAGE_FOXY_PRODUCTS');
    }

    /**
     * @param $member
     * @return bool|int|void
     */
    public function canDelete($member)
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        return Permission::checkMember($member, 'MANAGE_FOXY_PRODUCTS');
    }

    /**
     * @param null $member

     * @return bool|int
     */
    public function canUnpublish($member = null)
    {
        if (!$member) {

            $member = Security::getCurrentUser();
        }

        return Permission::checkMember($member, 'MANAGE_FOXY_PRODUCTS');
    }

    /**
     * @param $member
     * @return bool|int
     */
    public function canArchive($member = null)
    {
        if (!$member) {
            $member = Security::getCurrentUser();
        }

        return Permission::checkMember($member, 'MANAGE_FOXY_PRODUCTS');
    }

    /**
     *
     */
    public function onBeforeWrite()
    {
        // trim spaces and replace duplicate spaces
        $trimmed = trim($this->owner->Code);
        $this->owner->Code = preg_replace('/\s+/', ' ', $trimmed);
    }
}

dynamic / silverstripe-foxy

Push — master ( 71a588...6672d2 )

Purchasable::updateFieldLabels() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
