Estimate::generate_order_number() - Code Metrics - Inspection of "Add additional order fields to an account controll..." - silvercommerce/orders-admin - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 1.0 ( 07b100...83f8df )

by Morven
created 2018-02-23 15:32 UTC
Estimate::generate_order_number() B

↳ Parent: Estimate
Complexity

Conditions	4
Paths	8
Size

Total Lines	27
Code Lines	16
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	4
eloc	16
nc	8
nop	0
dl	0
loc	27
rs	8.5806
c	0
b	0
f	0
<?php

namespace SilverCommerce\OrdersAdmin\Model;

use SilverStripe\ORM\DataObject;
use SilverStripe\Core\Config\Config;
use SilverStripe\Versioned\Versioned;
use SilverStripe\Control\Controller;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\HeaderField;
use SilverStripe\Forms\TextField;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\Forms\FieldGroup;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\DateField;
use SilverStripe\ORM\FieldType\DBCurrency;
use SilverStripe\ORM\ArrayList;
use SilverStripe\View\ArrayData;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldConfig;
use SilverStripe\Forms\GridField\GridFieldButtonRow;
use Symbiote\GridFieldExtensions\GridFieldTitleHeader;
use Symbiote\GridFieldExtensions\GridFieldEditableColumns;
use SilverStripe\Forms\GridField\GridFieldEditButton;
use SilverStripe\Forms\GridField\GridFieldDetailForm;
use SilverStripe\Forms\GridField\GridFieldDeleteAction;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\i18n\i18n;
use SilverCommerce\OrdersAdmin\Forms\GridField\AddLineItem;
use SilverCommerce\OrdersAdmin\Forms\GridField\LineItemGridField;
use SilverCommerce\TaxAdmin\Helpers\MathsHelper;
use SilverCommerce\ContactAdmin\Model\Contact;
use SilverCommerce\ContactAdmin\Model\ContactLocation;
use SilverCommerce\OrdersAdmin\Control\DisplayController;
use SilverCommerce\OrdersAdmin\Tools\ShippingCalculator;
use DateTime;

class Estimate extends DataObject implements PermissionProvider
{
    private static $table_name = 'Estimate';

    /**
     * The amount of days that by default that this estimate
     * will end (cease to be valid).
     *
     * @var integer
     */
    private static $default_end = 30;

    /**
     * Actions on an order are to determine what will happen on
     * completion (the defaults are post or collect).
     * 
     * @var array
     * @config
     */
    private static $actions = [
        "post" => "Post",
        "collect" => "Collect"
    ];

    /**
     * Set the default action on our order. If we were using this module
     * for a more POS type solution, we would probably change this to
     * collect.
     * 
     * @var string
     * @config
     */
    private static $default_action = "post";
    
    /**
     * What is the action string for a order to be posted
     * 
     * @var string
     * @config
     */
    private static $post_action = "post";

    /**
     * What is the action string for a order to be collected
     * 
     * @var string
     * @config
     */
    private static $collect_action = "collect";

    private static $db = [
        'OrderNumber'       => 'Varchar',
        'StartDate'         => 'Date',
        'EndDate'           => 'Date',
        "Action"            => "Varchar",
        
        // Personal Details
        'Company'           => 'Varchar',
        'FirstName'         => 'Varchar',
        'Surname'           => 'Varchar',
        'Email'             => 'Varchar',
        'PhoneNumber'       => 'Varchar',
        
        // Billing Address
        'Address1'          => 'Varchar',
        'Address2'          => 'Varchar',
        'City'              => 'Varchar',
        'PostCode'          => 'Varchar',
        'Country'           => 'Varchar',
        
        // Delivery Details
        'DeliveryCompany'   => 'Varchar',
        'DeliveryFirstName' => 'Varchar',
        'DeliverySurname'   => 'Varchar',
        'DeliveryAddress1'  => 'Varchar',
        'DeliveryAddress2'  => 'Varchar',
        'DeliveryCity'      => 'Varchar',
        'DeliveryPostCode'  => 'Varchar',
        'DeliveryCountry'   => 'Varchar',
        
        // Discount Provided
        "DiscountType"      => "Varchar",
        "DiscountAmount"    => "Currency",
        
        // Postage
        "PostageType"       => "Varchar",
        "PostageCost"       => "Currency",
        "PostageTax"        => "Currency",

        // Access key (for viewing via non logged in users)
        "AccessKey"         => "Varchar(40)"
    ];

    private static $has_one = [
        "Discount"  => Discount::class,
        "Postage"   => PostageArea::class,
        "Customer"  => Contact::class
    ];

    private static $has_many = [
        'Items'     => LineItem::class
    ];

    private static $casting = [
        "PersonalDetails"   => "Text",
        'BillingAddress'    => 'Text',
        'CountryFull'       => 'Varchar',
        'DeliveryAddress'   => 'Text',
        'DeliveryCountryFull'=> 'Varchar',
        'SubTotal'          => 'Currency',
        'TaxTotal'          => 'Currency',
        'Total'             => 'Currency',
        'TotalItems'        => 'Int',
        'TotalWeight'       => 'Decimal',
        'ItemSummary'       => 'Text',
        'ItemSummaryHTML'   => 'HTMLText',
        'TranslatedStatus'  => 'Varchar',
        'PostageDetails'    => "Varchar",
        'DiscountDetails'   => "Varchar"
    ];

    private static $defaults = [
        'DiscountAmount'    => 0,
        "PostageCost"       => 0
    ];

    /**
     * Fields to show in summary views
     *
     * @var array
     * @config
     */
    private static $summary_fields = [
        'OrderNumber'   => '#',
        'StartDate'     => 'Date',
        'EndDate'       => 'Expires',
        'Company'       => 'Company',
        'FirstName'     => 'First Name',
        'Surname'       => 'Surname',
        'Email'         => 'Email',
        'PostCode'      => 'Post Code',
        "Total"         => "Total",
        "LastEdited"    => "Last Edited"
    ];

    private static $extensions = [
        Versioned::class . '.versioned',
    ];

    private static $versioning = [
        "History"
    ];

    private static $default_sort = [
        "StartDate" => "DESC"
    ];

    public function populateDefaults()
    {
        parent::populateDefaults();
        $this->Action = $this->config()->get("default_action");

    }

    /**
     * Generate a link to view the associated front end
     * display for this order
     *
     * @return string
     */
    public function DisplayLink()
    {
        return Controller::join_links(
            DisplayController::create()->AbsoluteLink("estimate"),
            $this->ID,
            $this->AccessKey
        );
    }

    /**
     * Generate a link to view the associated front end
     * display for this order
     *
     * @return string
     */
    public function PDFLink()
    {
        return Controller::join_links(
            DisplayController::create()->AbsoluteLink("estimatepdf"),
            $this->ID,
            $this->AccessKey
        );
    }

    /**
     * Generate a string of the customer's personal details
     *
     * @return string
     */
    public function getPersonalDetails()
    {
        $return = [];

        if ($this->Company) {

            $return[] = $this->Company;
        }

        if ($this->FirstName) {

            $return[] = $this->FirstName;
        }

        if ($this->Surname) {

            $return[] = $this->Surname;
        }

        if ($this->Email) {

            $return[] = $this->Email;
        }

        if ($this->PhoneNumber) {

            $return[] = $this->PhoneNumber;
        }

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

    /**
     * Get the complete billing address for this order
     *
     * @return string
     */
    public function getBillingAddress()
    {
        $address = ($this->Address1) ? $this->Address1 . ",\n" : '';

        $address .= ($this->Address2) ? $this->Address2 . ",\n" : '';

        $address .= ($this->City) ? $this->City . ",\n" : '';

        $address .= ($this->PostCode) ? $this->PostCode . ",\n" : '';

        $address .= ($this->Country) ? $this->Country : '';


        return $address;
    }

    /**
     * Get the rendered name of the billing country, based on the local
     * 
     * @return string
     */
    public function getCountryFull()
    {
        $list = i18n::getData()->getCountries();
        return (array_key_exists($this->Country, $list)) ? $list[$this->Country] : $this->Country;

    }

    /**
     * Get the complete delivery address for this order
     *
     * @return string
     */
    public function getDeliveryAddress()
    {
        $address = ($this->DeliveryAddress1) ? $this->DeliveryAddress1 . ",\n" : '';
        $address .= ($this->DeliveryAddress2) ? $this->DeliveryAddress2 . ",\n" : '';
        $address .= ($this->DeliveryCity) ? $this->DeliveryCity . ",\n" : '';
        $address .= ($this->DeliveryPostCode) ? $this->DeliveryPostCode . ",\n" : '';
        $address .= ($this->DeliveryCountry) ? $this->DeliveryCountry : '';

        return $address;
    }

    /**
     * Get the rendered name of the delivery country, based on the local
     * 
     * @return string 
     */
    public function getDeliveryCountryFull()
    {
        $list = i18n::getData()->getCountries();
        return (array_key_exists($this->DeliveryCountry, $list)) ? $list[$this->DeliveryCountry] : $this->DeliveryCountry;
    }

    /**
     * Generate a string outlining the details of selected
     * postage
     *
     * @return string
     */
    public function getPostageDetails()
    {
        if ($this->PostageType) {
            return $this->PostageType . " (" . $this->dbObject("PostageCost")->Nice() . ")";
        } else {
            return "";
        }      
    }

    /**
     * Generate a string outlining the details of selected
     * discount
     *
     * @return string
     */
    public function getDiscountDetails()
    {
        if ($this->DiscountType) {
            return $this->DiscountType . " (" . $this->dbObject("DiscountAmount")->Nice() . ")";
        } else {
            return "";
        }      
    }

    /**
     * Find the total quantity of items in the shopping cart
     *
     * @return Int
     */
    public function getTotalItems()
    {
        $total = 0;

        foreach ($this->Items() as $item) {
        foreach ($this->/** @scrutinizer ignore-call */ Items() as $item) {
            $total += ($item->Quantity) ? $item->Quantity : 1;
        }

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

        return $total;
    }

    /**
    * Find the total weight of all items in the shopping cart
    *
    * @return float
    */
    public function getTotalWeight()
    {
        $total = 0;
        
        foreach ($this->Items() as $item) {
            if ($item->Weight && $item->Quantity) {
                $total = $total + ($item->Weight * $item->Quantity);
            }
        }

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

    /**
     * Total values of items in this order (without any tax)
     *
     * @return float
     */
    public function getSubTotal()
    {
        $total = 0;

        // Calculate total from items in the list
        foreach ($this->Items() as $item) {
            $total += $item->SubTotal;
        }
        
        $this->extend("updateSubTotal", $total);

        return $total;
    }

    /**
     * Total values of items in this order
     *
     * @return float
     */
    public function getTaxTotal()
    {
        $total = 0;
        $items = $this->Items();
        
        // Calculate total from items in the list
        foreach ($items as $item) {
            // If a discount applied, get the tax based on the
            // discounted amount
            if ($this->DiscountAmount > 0) {
                $discount = $this->DiscountAmount / $this->TotalItems;

                $price = $item->UnitPrice - $discount;
                $tax = ($price / 100) * $item->TaxRate;
            } else {
                $tax = $item->UnitTax;
            }

            $total += $tax * $item->Quantity;
        }
        
        if ($this->PostageTax) {
            $total += $this->PostageTax;
        }
        
        $this->extend("updateTaxTotal", $total);

        $total = MathsHelper::round_up($total, 2);

        return $total;
    }

    /**
     * Get a list of all taxes used and and associated value
     *
     * @return ArrayList
     */
    public function getTaxList()
    {
        $taxes = ArrayList::create();

        foreach ($this->Items() as $item) {
            $existing = null;
            $rate = $item->Tax();

            if ($rate->exists()) {
                $existing = $taxes->find("ID", $rate->ID);
            }

            if (!$existing) {
                $currency = DBCurrency::create();
                $currency->setValue($item->getTaxTotal());
                $taxes->push(ArrayData::create([
                    "ID" => $rate->ID,
                    "Rate" => $rate,
                    "Total" => $currency
                ]));
            } elseif($rate && $existing) {
                $existing->Total->setValue(
                    $existing->Total->getValue() + $item->getTaxTotal()
                );
            }
        }

        return $taxes;
    }

    /**
     * Total of order including postage
     *
     * @return float
     */
    public function getTotal()
    {   
        $total = (($this->SubTotal + $this->Postage) - $this->DiscountAmount) + $this->TaxTotal;

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

    /**
     * Factory method to convert this estimate to an
     * order.
     *
     * This method writes and reloads the object so
     * we are now working with the new object type
     *
     * @return Invoice The currently converted invoice
     */
    public function convertToInvoice()
    {
        $this->ClassName = Invoice::class;
        $this->write();

        // Get our new Invoice
        $record = Invoice::get()->byID($this->ID);
        $record->OrderNumber = null;
        $record->StartDate = null;
        $record->EndDate = null;
        $record->write();
        
        return $record;
    }

    /**
     * Return a list string summarising each item in this order
     *
     * @return string
     */
    public function getItemSummary()
    {
        $return = '';

        foreach ($this->Items() as $item) {
            $return .= "{$item->Quantity} x {$item->Title};\n";
        }

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

        return $return;
    }

    /**
     * Return a list string summarising each item in this order
     *
     * @return HTMLText
     */
    public function getItemSummaryHTML()
    {
        $html = new HTMLText("ItemSummary");
filter:
    dependency_paths: ["lib/*"]
        $html->setValue(nl2br($this->ItemSummary));

        
        $this->extend("updateItemSummaryHTML", $html);

        return $html;
    }

    /**
     * Determine if the current estimate contains delivereable
     * items.
     *
     * @return boolean
     */
    public function isDeliverable()
    {
        foreach ($this->Items() as $item) {
            if ($item->Deliverable) {
                return true;
            }
        }
        
        return false;
    }

    /**
     * Mark this Estimate for collection?
     *
     * @return boolean
     */
    public function MarkForCollection()
    {
        $this->Action = $this->config()->collection_action;

        return $this;
    }

    /**
     * Mark this Estimate for collection?
     *
     * @return boolean
     */
    public function MarkForPost()
    {
        $this->Action = $this->config()->post_action;

        return $this;
    }

    /**
     * Is this Estimate marked for collection?
     *
     * @return boolean
     */
    public function isCollection()
    {
        return ($this->Action == $this->config()->collection_action);
    }

    /**
     * Is this Estimate marked for postage?
     *
     * @return boolean
     */
    public function isPost()
    {
        return ($this->Action == $this->config()->post_action);
    }

    /**
     * Has this order got a discount applied?
     *
     * @return boolean
     */
    public function hasDiscount()
    {
        return (ceil($this->DiscountAmount)) ? true : false;
    }
    
    public function getCMSFields()
    {
        
        $this->beforeUpdateCMSFields(function ($fields) {
            $siteconfig = SiteConfig::current_site_config();

            $fields->removeByName("StartDate");
            $fields->removeByName("EndDate");
            $fields->removeByName("OrderNumber");
            $fields->removeByName("AccessKey");
            $fields->removeByName("Action");
            $fields->removeByName("DiscountID");
            $fields->removeByName("DiscountType");
            $fields->removeByName("DiscountAmount");
            $fields->removeByName("PostageType");
            $fields->removeByName("PostageCost");
            $fields->removeByName("PostageTax");
            $fields->removeByName("Items");
            
            $fields->addFieldsToTab(
                "Root.Main",
                [
                    // Items field
                    GridField::create(
                        "Items",
                        /** @scrutinizer ignore-type */ "Items",
                        "",
                        $this->Items(),
                        $config = GridFieldConfig::create()
                            ->addComponents(
                                new GridFieldButtonRow('before'),
                                new GridFieldTitleHeader(),
                                new GridFieldEditableColumns(),
                                new GridFieldEditButton(),
                                new GridFieldDetailForm(),
                                new GridFieldDeleteAction(),
                                new AddLineItem()
                            )
                    ),

                    LiteralField::create(
                        "ItemsDivider",
                        '<div class="field form-group"></div>'
                    ),
                    
                    // Discount
                    HeaderField::create(
                        "DiscountDetailsHeader",
                        _t("Orders.DiscountDetails", "Discount")
                    ),
                    DropdownField::create(
                        "DiscountID",
                        $this->fieldLabel("Discount"),
                        $siteconfig->Discounts()->map()
                    )->setEmptyString(_t(
                        "OrdersAdmin.ApplyADiscount",
                        "Apply a discount"
                    )),
                    ReadonlyField::create("DiscountDetails"),
                    
                    // Sidebar
                    FieldGroup::create(
                        DateField::create("StartDate", _t("OrdersAdmin.Date", "Date")),
                        DateField::create("EndDate", _t("OrdersAdmin.Expires", "Expires")),
                        DropdownField::create(
                            'Action',
                            $this->fieldLabel("Action"),
                            $this->config()->get("actions")
                        ),
                        ReadonlyField::create("OrderNumber", "#"),
                        ReadonlyField::create("SubTotalValue",_t("OrdersAdmin.SubTotal", "Sub Total"))
                            ->setValue($this->obj("SubTotal")->Nice()),
                        ReadonlyField::create("DiscountValue",_t("OrdersAdmin.Discount", "Discount"))
                            ->setValue($this->dbObject("DiscountAmount")->Nice()),
                        ReadonlyField::create("PostageValue",_t("OrdersAdmin.Postage", "Postage"))
                            ->setValue($this->dbObject("PostageCost")->Nice()),
                        ReadonlyField::create("TaxValue",_t("OrdersAdmin.Tax", "Tax"))
                            ->setValue($this->obj("TaxTotal")->Nice()),
                        ReadonlyField::create("TotalValue",_t("OrdersAdmin.Total", "Total"))
                            ->setValue($this->obj("Total")->Nice())
                    )->setName("OrdersSidebar")
                    ->setTitle(_t("Orders.EstimateDetails", "Estimate Details"))
                    ->addExtraClass("order-admin-sidebar")
                ]
            );

            $fields->addFieldsToTab(
                "Root.Customer",
                [
                    DropdownField::create(
                        'CustomerID',
                        _t('OrdersAdmin.ExistingCustomer', 'Existing Customer'),
                        Contact::get()->map()
                        /** @scrutinizer ignore-type */ Contact::get()->map()
                    )->setEmptyString(_t(
                        "OrdersAdmin.SelectACustomer",
                        "Select existing customer"
                    )),
                    TextField::create("Company"),
                    TextField::create("FirstName"),
                    TextField::create("Surname"),
                    TextField::create("Address1"),
                    TextField::create("Address2"),
                    TextField::create("City"),
                    TextField::create("PostCode"),
                    DropdownField::create(
                        'Country',
                        _t('OrdersAdmin.Country', 'Country'),
                        i18n::getData()->getCountries()
                    )->setEmptyString(""),
                    TextField::create("Email"),
                    TextField::create("PhoneNumber")
                ]
            );

            // Try and calculate valid postage areas
            $calc = new ShippingCalculator($this->DeliveryPostCode,$this->DeliveryCountry);
            $calc
                ->setCost($this->SubTotal)

                ->setWeight($this->TotalWeight)

                ->setItems($this->TotalItems)

                ->setDiscount($this->Discount());
                ->setDiscount($this->/** @scrutinizer ignore-call */ Discount());
            
            $postage_areas = $calc->getPostageAreas();

            if (!$postage_areas->exists()) {
                $postage_areas = $siteconfig->PostageAreas();
            }

            $fields->addFieldsToTab(
                "Root.Delivery",
                [
                    HeaderField::create(
                        "DeliveryDetailsHeader",
                        _t("Orders.DeliveryDetails", "Delivery Details")
                    ),
                    TextField::create("DeliveryCompany"),
                    TextField::create("DeliveryFirstName"),
                    TextField::create("DeliverySurname"),
                    TextField::create("DeliveryAddress1"),
                    TextField::create("DeliveryAddress2"),
                    TextField::create("DeliveryCity"),
                    TextField::create("DeliveryPostCode"),
                    DropdownField::create(
                        'DeliveryCountry',
                        _t('OrdersAdmin.Country', 'Country'),
                        i18n::getData()->getCountries()
                    )->setEmptyString(""),

                    // Postage
                    HeaderField::create(
                        "PostageDetailsHeader",
                        _t("Orders.PostageDetails", "Postage Details")
                    ),
                    DropdownField::create(
                        "PostageID",
                        $this->fieldLabel("PostageID"),
                        $postage_areas->map()
                    )->setEmptyString(_t(
                        "OrdersAdmin.SelectPostage",
                        "Select Postage"
                    )),
                    ReadonlyField::create("PostageDetails")
                ]
            );
            
            $root = $fields->findOrMakeTab("Root");

            if ($root) {
                $root->addextraClass('orders-root');
            }
        });
        
        return parent::getCMSFields();
    }

        /**
     * Find the total discount based on discount items added.
     *
     * @return float
     */
    protected function get_discount_amount()
    {
        $discount = $this->Discount();
        $total = 0;
        $discount_amount = 0;
        $items = $this->TotalItems;

        
        foreach ($this->Items() as $item) {
            if ($item->Price) {
                $total += ($item->Price * $item->Quantity);
            }
            
            if ($item->Price && $discount && $discount->Amount) {
                if ($discount->Type == "Fixed") {
                    $discount_amount = $discount_amount + ($discount->Amount / $items) * $item->Quantity;
                } elseif ($discount->Type == "Percentage") {
                    $discount_amount = $discount_amount + (($item->Price / 100) * $discount->Amount) * $item->Quantity;
                }
            }
        }

        if ($discount_amount > $total) {
            $discount_amount = $total;
        }

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

    /**
     * Retrieve an order prefix from siteconfig
     * for an Estimate
     *
     * @return string
     */
    protected function get_prefix()
    {
        $config = SiteConfig::current_site_config();
        return $config->EstimateNumberPrefix;
    }

    /**
     * Generate a randomised order number for this order.
     * 
     * The order number is generated based on the current order
     * ID and is padded to a multiple of 4 and we add "-" every
     * 4 characters.
     * 
     * We then add an order prefix (if one is set) or the current
     * year.
     * 
     * This keeps a consistent order number structure that allows
     * for a large number of orders before changing.
     *
     * @return string
     */
    protected function generate_order_number()
    {
        $config = SiteConfig::current_site_config();
        $default_length = $config->OrderNumberLength;
        $length = strlen($this->ID);
        $i = $length;
        $prefix = $this->get_prefix();

        // Determine what the next multiple of 4 is
        while ($i % 4 != 0) {
            $i++;
        }

        $pad_amount = ($i >= $default_length) ? $i : $default_length;
        $id_base = str_pad($this->ID, $pad_amount, "0", STR_PAD_LEFT);
        $id_base = wordwrap($id_base, 4, "-", true);

        $current_date = new DateTime();

        // Work out if an order prefix string has been set
        if ($prefix) {
            $order_num = $prefix . '-' . $id_base;
        } else {
            $order_num = $current_date->format("Y") . "-" . $id_base;
        }

        return $order_num;
    }

    protected function generate_random_string($length = 20)
    {
        $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
        $randomString = '';
        for ($i = 0; $i < $length; $i++) {
            $randomString .= $characters[rand(0, strlen($characters) - 1)];
        }
        return $randomString;
    }

    /**
     * Check if the currently generated order number
     * is valid (not duplicated)
     *
     * @return boolean
     */
    protected function validOrderNumber()
    {
        $existing = Estimate::get()
            ->filterAny("OrderNumber", $this->OrderNumber)
            ->first();
        
        return !($existing);
    }

    /**
     * Check if the access key generated for this estimate is
     * valid (exists on another object)
     *
     * @return boolean
     */
    protected function validAccessKey()
    {
        $existing = Estimate::get()
            ->filter("AccessKey", $this->AccessKey)
            ->first();
        
        return !($existing);
    }

    /**
     * Create a duplicate of this order/estimate as well as duplicating
     * associated items
     *
     * @param $doWrite Perform a write() operation before returning the object.  If this is true, it will create the
filter:
    dependency_paths: ["lib/*"]
     *                 duplicate in the database.
     * @return DataObject A duplicate of this node. The exact type will be the type of this node.
     */
    public function duplicate($doWrite = true, $manyMany = 'many_many')
    {
        $clone = parent::duplicate($doWrite, $manyMany);
        
        // Set up items
        if ($doWrite) {
            $clone->OrderNumber = "";
            $clone->write();

            foreach ($this->Items() as $item) {
                $item_class = $item->ClassName;
                $clone_item = new $item_class($item->toMap(), false, $this->model);

                $clone_item->ID = 0;
                $clone_item->ParentID = $clone->ID;
                $clone_item->write();
            }
        }
        
        $clone->invokeWithExtensions('onAfterDuplicate', $this, $doWrite);
        
        return $clone;
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();

        // Ensure that this object has a non-conflicting Access Key
        if (!$this->AccessKey) {
            $this->AccessKey = $this->generate_random_string(40);

            
            while (!$this->validAccessKey()) {
                $this->AccessKey = $this->generate_random_string(40);
            }
        }

        $contact = $this->Customer();
        $contact = $this->Customer();

        // If a contact is assigned and no customer details set
        // then use contact details
        if (!$this->PersonalDetails && $contact->exists()) {

            foreach (Config::inst()->get(Contact::class, "db") as $param => $value) {
                $this->$param = $contact->$param;
            }
        }

        // if Billing Address is not set, use customer's default
        // location 
        if (!$this->BillingAddress && $contact->exists() && $contact->DefaultLocation()) {

            $location = $contact->DefaultLocation();
            foreach (Config::inst()->get(ContactLocation::class, "db") as $param => $value) {
                $this->$param = $location->$param;
            }
        }


        // Is delivery address set, if not, set it here
        if (!$this->DeliveryAddress && $this->BillingAddress) {

            $this->DeliveryCompany = $this->Company;

            $this->DeliveryFirstName = $this->FirstName;

            $this->DeliverySurname = $this->Surname;

            $this->DeliveryAddress1 = $this->Address1;

            $this->DeliveryAddress2 = $this->Address2;

            $this->DeliveryCity = $this->City;

            $this->DeliveryPostCode = $this->PostCode;

            $this->DeliveryCountry = $this->Country;

        }

        // Assign discount info if needed
        if ($this->Discount()->exists()) {
            $this->DiscountAmount = $this->get_discount_amount();

            $this->DiscountType = $this->Discount()->Title;

        }

        // Assign postage info if set
        if ($this->Postage()->exists()) {
        if ($this->/** @scrutinizer ignore-call */ Postage()->exists()) {
            $postage = $this->Postage();
            $this->PostageType = $postage->Title;

            $this->PostageCost = $postage->Cost;

            $this->PostageTax = $postage->TaxAmount;

        }

        // If date not set, make thie equal the created date
        if (!$this->StartDate) {
            $this->StartDate = $this->Created;

        }

        if (!$this->EndDate && $this->StartDate) {
            $start = new DateTime($this->StartDate);
            $start->modify("+ {$this->config()->default_end} days");
            $this->EndDate = $start->format("Y-m-d");

        }
    }

    /**
     * API Callback after this object is written to the DB
     *
     */
    public function onAfterWrite()
    {
        parent::onAfterWrite();

        // Check if an order number has been generated, if not, add it and save again
        if (!$this->OrderNumber) {
            $this->OrderNumber = $this->generate_order_number();

            
            while (!$this->validOrderNumber()) {
                $this->OrderNumber = $this->generate_order_number();
            }
            $this->write();
        }
    }

    /**
     * API Callback before this object is removed from to the DB
     *
     */
    public function onBeforeDelete()
    {
        parent::onBeforeDelete();
        
        // Delete all items attached to this order
        foreach ($this->Items() as $item) {
            $item->delete();
        }
    }

    public function providePermissions()
    {
        return [
            "ORDERS_VIEW_ESTIMATES" => [
                'name' => 'View any estimate',
                'help' => 'Allow user to view any estimate',
                'category' => 'Orders',
                'sort' => 89
            ],
            "ORDERS_CREATE_ESTIMATES" => [
                'name' => 'Create estimates',
                'help' => 'Allow user to create new estimates',
                'category' => 'Orders',
                'sort' => 88
            ],
            "ORDERS_EDIT_ESTIMATES" => [
                'name' => 'Edit any estimate',
                'help' => 'Allow user to edit any estimate',
                'category' => 'Orders',
                'sort' => 87
            ],
            "ORDERS_DELETE_ESTIMATES" => [
                'name' => 'Delete any estimate',
                'help' => 'Allow user to delete any estimate',
                'category' => 'Orders',
                'sort' => 86
            ]
        ];
    }

    /**
     * Only order creators or users with VIEW admin rights can view
     *
     * @return boolean
     */
    public function canView($member = null)
    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
        
        if ($extended !== null) {
            return $extended;
        }

        if (!$member) {
            $member = Member::currentUser();
            $member = /** @scrutinizer ignore-deprecated */ Member::currentUser();
        }

        if ($member && Permission::checkMember($member->ID, ["ADMIN", "ORDERS_VIEW_ESTIMATES"])) {
            return true;
        }

        return false;
    }

    /**
     * Anyone can create orders, even guest users
     *
     * @return boolean
     */
    public function canCreate($member = null, $context = [])
    {
        $extended = $this->extendedCan(__FUNCTION__, $member, $context);
        
        if ($extended !== null) {
            return $extended;
        }

        if (!$member) {
            $member = Member::currentUser();
            $member = /** @scrutinizer ignore-deprecated */ Member::currentUser();
        }
        
        if ($member && Permission::checkMember($member->ID, ["ADMIN", "ORDERS_CREATE_ESTIMATES"])) {
            return true;
        }

        return false;
    }

    /**
     * Only users with EDIT admin rights can view an order
     *
     * @return boolean
     */
    public function canEdit($member = null)
    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
        
        if ($extended !== null) {
            return $extended;
        }

        if (!$member) {
            $member = Member::currentUser();
            $member = /** @scrutinizer ignore-deprecated */ Member::currentUser();
        }

        if ($member && Permission::checkMember($member->ID, ["ADMIN", "ORDERS_EDIT_ESTIMATES"])) {
            return true;
        }

        return false;
    }

    /**
     * No one should be able to delete an order once it has been created
     *
     * @return boolean
     */
    public function canDelete($member = null)
    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
        
        if ($extended !== null) {
            return $extended;
        }

        if (!$member) {
            $member = Member::currentUser();
            $member = /** @scrutinizer ignore-deprecated */ Member::currentUser();
        }

        if ($member && Permission::checkMember($member->ID, ["ADMIN", "ORDERS_DELETE_ESTIMATES"])) {
            return true;
        }

        return false;
    }
}

silvercommerce / orders-admin

Push — 1.0 ( 07b100...83f8df )

Estimate::generate_order_number() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
