LineItem::Match() - Code Metrics - Inspection of "Ensure line item finds products from current subsi..." - silvercommerce/orders-admin - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 1.3 ( 47b397...4f928d )

by Morven
created 2020-07-13 14:32 UTC
LineItem::Match() B

↳ Parent: LineItem
Complexity

Conditions	7
Paths	6
Size

Total Lines	22
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	7
eloc	12
c	1
b	0
f	0
nc	6
nop	3
dl	0
loc	22
rs	8.8333
<?php

namespace SilverCommerce\OrdersAdmin\Model;

use SilverStripe\i18n\i18n;
use SilverStripe\ORM\DataObject;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\SiteConfig\SiteConfig;
use SilverCommerce\TaxAdmin\Model\TaxRate;
use SilverCommerce\TaxAdmin\Traits\Taxable;
use SilverStripe\Core\Manifest\ModuleLoader;
use SilverStripe\Subsites\State\SubsiteState;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Forms\GridField\GridFieldEditButton;
use SilverStripe\Forms\GridField\GridFieldDataColumns;
use SilverStripe\ORM\FieldType\DBHTMLText as HTMLText;
use SilverCommerce\TaxAdmin\Interfaces\TaxableProvider;
use SilverStripe\Forms\GridField\GridFieldAddNewButton;
use SilverStripe\Forms\GridField\GridFieldDeleteAction;
use Symbiote\GridFieldExtensions\GridFieldEditableColumns;
use Symbiote\GridFieldExtensions\GridFieldAddNewInlineButton;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;

/**
 * A LineItem is a single line item on an order, extimate or even in
 * the shopping cart.
 *
 * An item has a number of fields that describes a product:
 *
 * - Key: ID used to detect this item
 * - Title: Title of the item
 * - Content: Description of this object
 * - Quantity: Number or items in this order
 * - Weight: Weight of this item (unit of measurment is defined globally)
 * - TaxRate: Rate of tax for this item (e.g. 20.00 for 20%)
 * - ProductClass: ClassName of product that this item is matched against
 * - StockID: Unique identifier of this item (used with ProductClass
 *            match to a product)
 * - Locked: Is this a locked item? Locked items cannot be changed in the
 *           shopping cart
 * - Deliverable: Is this a product that can be delivered? This can effect
 *                delivery options
 *
 * @author Mo <[email protected]>
 */
class LineItem extends DataObject implements TaxableProvider
{
    use Taxable;


    private static $table_name = 'LineItem';

    /**
     * The name of the param used on a related product to
     * track Stock Levels.
     *
     * Defaults to StockLevel
     *
     * @var string
     * @config
     */
    private static $stock_param = "StockLevel";

    /**
     * Standard database columns
     *
     * @var array
     * @config
     */
    private static $db = [
        "Key"           => "Varchar(255)",
        "Title"         => "Varchar",
        "BasePrice"     => "Decimal(9,3)",
        "Price"         => "Currency",
        "Quantity"      => "Int",
        "StockID"       => "Varchar(100)",
        "ProductClass"  => "Varchar",
        "Locked"        => "Boolean",
        "Stocked"       => "Boolean",
        "Deliverable"   => "Boolean"
    ];

    /**
     * Foreign key associations in DB
     *
     * @var array
     * @config
     */
    private static $has_one = [
        "Parent"      => Estimate::class,
        "Tax"         => TaxRate::class,
        "TaxRate"     => TaxRate::class
    ];
    
    /**
     * One to many associations
     *
     * @var array
     * @config
     */
    private static $has_many = [
        "Customisations" => LineItemCustomisation::class
    ];

    /**
     * Specify default values of a field
     *
     * @var array
     * @config
     */
    private static $defaults = [
        "Quantity"      => 1,
        "ProductClass"  => "Product",
        "Locked"        => false,
        "Stocked"       => false,
        "Deliverable"   => true
    ];

    /**
     * Function to DB Object conversions
     *
     * @var array
     * @config
     */
    private static $casting = [
        "UnitPrice" => "Currency(9,3)",
        "UnitTax" => "Currency(9,3)",
        "UnitTotal" => "Currency(9,3)",
        "SubTotal" => "Currency(9,3)",
        "TaxRate" => "Decimal",
        "TaxTotal" => "Currency(9,3)",
        "Total" => "Currency(9,3)",
        "CustomisationList" => "Text",
        "CustomisationAndPriceList" => "Text",
    ];

    /**
     * Fields to display in list tables
     *
     * @var array
     * @config
     */
    private static $summary_fields = [
        "Quantity",
        "Title",
        "StockID",
        "BasePrice",
        "TaxRateID",
        "CustomisationAndPriceList"
    ];

    private static $field_labels = [
        "BasePrice"=> "Item Price",
        "Price"    => "Item Price",
        "TaxID"    => "Tax",
        "TaxRateID"=> "Tax",
        "CustomisationAndPriceList" => "Customisations"
    ];

    /**
     * Get the basic price for this object
     *
     * @return float
     */
    public function getBasePrice()
    {
        return $this->dbObject('BasePrice')->getValue();
    }

    /**
     * Return the tax rate for this Object
     *
     * @return TaxRate
     */
    public function getTaxRate()
    {
        return $this->TaxRate();
        return $this->/** @scrutinizer ignore-call */ TaxRate();
    }

    /**
     * Get the locale from the site
     *
     * @return string
     */
    public function getLocale()
    {
        return i18n::get_locale();
    }

    /**
     * Get should this field automatically show the price including TAX?
     *
     * @return bool
     */
    public function getShowPriceWithTax()
    {
        $config = SiteConfig::current_site_config();
        $show = $config->ShowPriceAndTax;

        $result = $this->filterTaxableExtensionResults(
            $this->extend("updateShowPriceWithTax", $show)
        );

        if (!empty($result)) {
            return (bool)$result;
        }

        return (bool)$show;
    }

    /**
     * We don't want to show a tax string on Line Items
     *
     * @return false
     */
    public function getShowTaxString()
    {
        return false;
    }

    /**
     * Modify default field scaffolding in admin
     *
     * @return FieldList
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function ($fields) {
            $config = SiteConfig::current_site_config();

            $fields->removeByName(
                [
                    'Customisation',
                    'Price',
                    'TaxID'
                ]
            );

            $fields->addFieldToTab(
                "Root.Main",
                ReadonlyField::create("Key"),
                "Title"
            );

            $fields->addFieldToTab(
                "Root.Main",
                DropdownField::create(
                    "TaxRateID",
                    $this->fieldLabel("TaxRate"),
                    $config->TaxRates()->map()
                ),
                "Quantity"
            );

            // Change unlink button to remove on customisation
            $custom_field = $fields->dataFieldByName("Customisations");

            if ($custom_field) {
                $config = $custom_field->getConfig();
                $config
                    ->removeComponentsByType(GridFieldDeleteAction::class)
                    ->removeComponentsByType(GridFieldDataColumns::class)
                    ->removeComponentsByType(GridFieldEditButton::class)
                    ->removeComponentsByType(GridFieldAddNewButton::class)
                    ->removeComponentsByType(GridFieldAddExistingAutocompleter::class)
                    ->addComponents(
                        new GridFieldEditableColumns(),
                        new GridFieldAddNewInlineButton(),
                        new GridFieldEditButton(),
                        new GridFieldDeleteAction()
                    );
                
                    $custom_field->setConfig($config);
            }
        });

        return parent::getCMSFields();
    }
    
    /**
     * Get the price for a single line item (unit), minus any tax
     *
     * @return float
     */
    public function getNoTaxPrice()
    {
        $price = $this->getBasePrice();

        foreach ($this->Customisations() as $customisation) {
        foreach ($this->/** @scrutinizer ignore-call */ Customisations() as $customisation) {
            $price += $customisation->getBasePrice();
        }
        
        $result = $this->getOwner()->filterTaxableExtensionResults(
        $result = $this->/** @scrutinizer ignore-call */ getOwner()->filterTaxableExtensionResults(
            $this->extend("updateNoTaxPrice", $price)
        );

        if (!empty($result)) {
            return $result;
        }

        return $price;
    }

    public function getUnitPrice()
    {
        return $this->getNoTaxPrice();
    }

    /**
     * Get the amount of tax for a single unit of this item
     *
     * **NOTE** Tax is rounded at the single item price to avoid multiplication
     * weirdness. For example 49.995 + 20% is 59.994 for one product,
     * but 239.976 for 4 (it should be 239.96)
     *
     * @return float
     */
    public function getUnitTax()
    {
        // Calculate and round tax now to try and minimise penny rounding issues
        $total = ($this->UnitPrice / 100) * $this->TaxPercentage;


        $this->extend("updateUnitTax", $total);

        return $total;
    }

    /**
     * Overwrite TaxAmount with unit tax
     *
     * @return float
     */
    public function getTaxAmount()
    {
        return $this->UnitTax;

    }

    /**
     * Get the total price and tax for a single unit
     *
     * @return float
     */
    public function getUnitTotal()
    {
        $total = $this->UnitPrice + $this->UnitTax;


        $this->extend("updateUnitTotal", $total);

        return $total;
    }

    /**
     * Get the value of this item, minus any tax
     *
     * @return float
     */
    public function getSubTotal()
    {
        $total = $this->NoTaxPrice * $this->Quantity;


        $this->extend("updateSubTotal", $total);

        return $total;
    }

    /**
     * Get the total amount of tax for a single unit of this item
     *
     * @return float
     */
    public function getTaxTotal()
    {
        $total = $this->UnitTax * $this->Quantity;


        $this->extend("updateTaxTotal", $total);

        return $total;
    }

    /**
     * Get the value of this item, minus any tax
     *
     * @return float
     */
    public function getTotal()
    {
        $total = $this->SubTotal + $this->TaxTotal;


        $this->extend("updateTotal", $total);
    
        return $total;
    }

    /**
     * Get an image object associated with this line item.
     * By default this is retrieved from the base product.
     *
     * @return Image | null
filter:
    dependency_paths: ["lib/*"]
     */
    public function Image()
    {
        $product = $this->FindStockItem();

        if ($product && method_exists($product, "SortedImages")) {
            return  $product->SortedImages()->first();
        } elseif ($product && method_exists($product, "Images")) {
            return $product->Images()->first();
        } elseif ($product && method_exists($product, "Image") && $product->Image()->exists()) {
            return $product->Image();
        }
    }
    
    /**
     * Provide a string of customisations seperated by a comma but not
     * including a price
     *
     * @return string
     */
    public function getCustomisationList()
    {
        $return = [];
        $items = $this->Customisations();

        if ($items && $items->exists()) {
            foreach ($items as $item) {
                $return[] = $item->Title . ': ' . $item->Value;
            }
        }

        $this->extend("updateCustomisationList", $return);

        return implode(", ", $return);
    }

    /**
     * Provide a string of customisations seperated by a comma and
     * including a price
     *
     * @return string
     */
    public function getCustomisationAndPriceList()
    {
        $return = [];
        $items = $this->Customisations();

        if ($items && $items->exists()) {
            foreach ($items as $item) {
                $return[] = $item->Title . ': ' . $item->Value . ' (' . $item->getFormattedPrice() . ')';
            }
        }

        $this->extend("updateCustomisationAndPriceList", $return);

        return implode(", ", $return);
    }
    
    /**
     * Get list of customisations rendering into a basic
     * HTML string
     *
     * @return HTMLText
     */
    public function CustomisationHTML()
    {
        $return = HTMLText::create();
        $items = $this->Customisations();
        $html = "";
        
        if ($items && $items->exists()) {
            foreach ($items as $item) {
                $html .= $item->Title . ': ' . $item->Value . ";<br/>";
            }
        }

        $return->setValue($html);

        $this->extend("updateCustomisationHTML", $return);

        return $return;
    }
        
    /**
     * Match this item to another object in the Database, by the
     * provided details.
     *
     * @param $relation_name = The class name of the related dataobject

     * @param $relation_col = The column name of the related object
     * @param $match_col = The column we use to match the two objects
     * @return DataObject
     */
    public function Match($relation_name = null, $relation_col = "StockID", $match_col = "StockID")
    {
        // Try to determine relation name
        if (!$relation_name && !$this->ProductClass && class_exists(CatalogueProduct::class)) {
filter:
    dependency_paths: ["lib/*"]
            $relation_name = CatalogueProduct::class;
        } elseif (!$relation_name && $this->ProductClass) {
            $relation_name = $this->ProductClass;
        }

        // Setup filter and check for existence of subsites
        // (as sometimes dubplicate stock ID's are found from another subsite)
        $filter = [];
        $filter[$relation_col] = $this->{$match_col};

        $subsites_exists = ModuleLoader::inst()->getManifest()->moduleExists('silverstripe/subsites');
        if ($subsites_exists) {
            $filter['SubsiteID'] = SubsiteState::singleton()->getSubsiteId();
        }

        return $relation_name::get()
            ->filter($filter)
            ->first();
    }

    /**
     * Find our original stock item (useful for adding links back to the
     * original product).
     *
     * This function is a synonym for @Link Match (as a result of) merging
     * LineItem
     *
     * @return DataObject
     */
    public function FindStockItem()
    {
        return $this->Match();
    }

    /**
     * Check stock levels for this item, will return the actual number
     * of remaining stock after removing the current quantity
     *
     * @param $qty The quantity we want to check against
filter:
    dependency_paths: ["lib/*"]
     * @return Int
     */
    public function checkStockLevel($qty)
    {
        $stock_param = $this->config()->get("stock_param");
        $item = $this->Match();
        $stock = ($item->$stock_param) ? $item->$stock_param : 0;
        $return = $stock - $qty;

        $this->extend("updateCheckStockLevel", $return);
        
        return $return;
    }

    /**
     * Generate a key based on this item and its customisations
     *
     * @return string
     */
    public function generateKey()
    {
        // Generate a unique item key based on the current ID and customisations
        $key = base64_encode(
            json_encode(
                $this->Customisations()->map("Title", "Value")->toArray()
            )
        );
        return $this->StockID . ':' . $key;

    }

    /**
     * Only order creators or users with VIEW admin rights can view
     *
     * @return Boolean
     */
    public function canView($member = null, $context = [])
    public function canView($member = null, /** @scrutinizer ignore-unused */ $context = [])
    {
        $extended = $this->extend('canView', $member);
        if ($extended && $extended !== null) {
            return $extended;
        }

        return $this->Parent()->canView($member);
        return $this->/** @scrutinizer ignore-call */ Parent()->canView($member);
    }

    /**
     * Anyone can create an order item
     *
     * @return Boolean
     */
    public function canCreate($member = null, $context = [])
    {
        $extended = $this->extend('canCreate', $member);
        if ($extended && $extended !== null) {
            return $extended;
        }

        return true;
    }

    /**
     * No one can edit items once they are created
     *
     * @return Boolean
     */
    public function canEdit($member = null, $context = [])
    public function canEdit($member = null, /** @scrutinizer ignore-unused */ $context = [])
    {
        $extended = $this->extend('canEdit', $member);
        if ($extended && $extended !== null) {
            return $extended;
        }

        return $this->Parent()->canEdit($member);
    }

    /**
     * No one can delete items once they are created
     *
     * @return Boolean
     */
    public function canDelete($member = null, $context = [])
    public function canDelete($member = null, /** @scrutinizer ignore-unused */ $context = [])
    {
        $extended = $this->extend('canDelete', $member);
        if ($extended && $extended !== null) {
            return $extended;
        }

        return $this->Parent()->canEdit($member);
    }

    /**
     * Overwrite default duplicate function
     *
     * @param boolean $doWrite (write the cloned object to DB)
     * @return DataObject $clone The duplicated object
     */
    public function duplicate($doWrite = true, $manyMany = "many_many")
    {
        $clone = parent::duplicate($doWrite);

        // Ensure we clone any customisations
        if ($doWrite) {
            foreach ($this->Customisations() as $customisation) {
                $new_item = $customisation->duplicate(false);
                $new_item->ParentID = $clone->ID;
                $new_item->write();
            }
        }

        return $clone;
    }

    /**
     * Pre-write tasks
     *
     * @return void
     */
    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
        $this->Key = $this->generateKey();

    }

    /**
     * Clean up DB on deletion
     *
     * @return void
     */
    public function onBeforeDelete()
    {
        parent::onBeforeDelete();

        foreach ($this->Customisations() as $customisation) {
            $customisation->delete();
        }
    }
}

silvercommerce / orders-admin

Push — 1.3 ( 47b397...4f928d )

LineItem::Match() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
