Dynamic\Foxy\Orders\Model\Order

Complexity

Total Complexity

29

Size/Duplication

Total Lines	360
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	setTransaction()	0	8	2
A	getReceiptLink()	0	7	1
A	ReceiptLink()	0	3	1
A	fieldLabels()	0	16	1
A	getTransaction()	0	6	2
A	onBeforeWrite()	0	4	1
A	canDelete()	0	3	1
A	parseOrder()	0	9	3
A	providePermissions()	0	17	1
A	canEdit()	0	3	1
A	canView()	0	3	1
A	parseOrderCustomer()	0	13	4
B	parseOrderDetails()	0	53	8
A	canCreate()	0	3	1
A	parseOrderInfo()	0	16	1

<?php

namespace Dynamic\Foxy\Orders\Model;

use Dynamic\Foxy\Extension\Purchasable;
use Dynamic\Foxy\Orders\Foxy\Transaction;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Forms\DateField;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\FieldType\DBHTMLVarchar;
use SilverStripe\ORM\ValidationException;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;
use SilverStripe\Security\PermissionProvider;

/**
 * Class Order
 * @package Dynamic\Foxy\Model
 *
 * @property \SilverStripe\ORM\FieldType\DBInt StoreID
 * @property \SilverStripe\ORM\FieldType\DBInt OrderID
 * @property \SilverStripe\ORM\FieldType\DBVarchar Email
 * @property \SilverStripe\ORM\FieldType\DBDatetime TransactionDate
 * @property \SilverStripe\ORM\FieldType\DBCurrency ProductTotal
 * @property \SilverStripe\ORM\FieldType\DBCurrency TaxTotal
 * @property \SilverStripe\ORM\FieldType\DBCurrency ShippingTotal
 * @property \SilverStripe\ORM\FieldType\DBCurrency OrderTotal
 * @property \SilverStripe\ORM\FieldType\DBVarchar ReceiptURL
 * @property \SilverStripe\ORM\FieldType\DBVarchar OrderStatus
 * @property \SilverStripe\ORM\FieldType\DBText Response
 *
 * @property int MemberID
 * @method Member Member
 */
class Order extends DataObject implements PermissionProvider
{
    /**
     * @var array
     */
    private static $db = [

The private property $db is not used, and could be removed.

        'StoreID' => 'Int',
        'OrderID' => 'Int',
        'Email' => 'Varchar(255)',
        'TransactionDate' => 'DBDatetime',
        'ProductTotal' => 'Currency',
        'TaxTotal' => 'Currency',
        'ShippingTotal' => 'Currency',
        'OrderTotal' => 'Currency',
        'ReceiptURL' => 'Varchar(255)',
        'OrderStatus' => 'Varchar(255)',
        'Response' => 'Text',
    ];

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

The private property $has_one is not used, and could be removed.

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

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

The private property $has_many is not used, and could be removed.

        'Details' => OrderDetail::class,
    );

    /**
     * @var string
     */
    private static $singular_name = 'Order';

The private property $singular_name is not used, and could be removed.

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

The private property $plural_name is not used, and could be removed.

    /**
     * @var string
     */
    private static $description = 'Orders from FoxyCart Datafeed';

The private property $description is not used, and could be removed.

    /**
     * @var string
     */
    private static $default_sort = 'TransactionDate DESC, ID DESC';

The private property $default_sort is not used, and could be removed.

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

The private property $summary_fields is not used, and could be removed.

        'OrderID',
        'TransactionDate.Nice',
        'Email',
        'ProductTotal.Nice',
        'ShippingTotal.Nice',
        'TaxTotal.Nice',
        'OrderTotal.Nice',
        'ReceiptLink',
    ];

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

The private property $searchable_fields is not used, and could be removed.

        'OrderID',
        'TransactionDate' => [
            'field' => DateField::class,
            'filter' => 'PartialMatchFilter',
        ],
        'Email',
        'OrderTotal'
    ];

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

The private property $casting is not used, and could be removed.

        'ReceiptLink' => 'HTMLVarchar',
    ];

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

The private property $indexes is not used, and could be removed.

        'OrderID' => true, // make unique
    ];

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

The private property $table_name is not used, and could be removed.

    /**
     * @var
     */
    private $transaction;

    /**
     * @return mixed
     */
    protected function getTransaction()
    {
        if (!$this->transaction) {
            $this->setTransaction();
        }
        return $this->transaction;
    }

    /**
     * @return $this
     */
    protected function setTransaction()
    {
        if ($this->Response) {
            $this->transaction = Transaction::create($this->OrderID, urldecode($this->Response));
        } else {
            $this->transaction = false;
        }
        return $this;
    }

    /**
     * @param bool $includerelations
     *
     * @return array|string
     */
    public function fieldLabels($includerelations = true)
    {
        $labels = parent::fieldLabels();
        $labels['StoreID'] = _t(__CLASS__ . '.StoreID', 'Store ID#');
        $labels['OrderID'] = _t(__CLASS__ . '.OrderID', 'Order ID#');
        $labels['TransactionDate'] = _t(__CLASS__ . '.TransactionDate', 'Date');
        $labels['TransactionDate.NiceUS'] = _t(__CLASS__ . '.TransactionDate', 'Date');
        $labels['Email'] = _t(__CLASS__ . '.Email', 'Email');
        $labels['ProductTotal.Nice'] = _t(__CLASS__ . '.ProductTotal', 'Sub Total');
        $labels['TaxTotal.Nice'] = _t(__CLASS__ . '.TaxTotal', 'Tax');
        $labels['ShippingTotal.Nice'] = _t(__CLASS__ . '.ShippingTotal', 'Shipping');
        $labels['OrderTotal'] = _t(__CLASS__ . '.OrderTotal', 'Total');
        $labels['OrderTotal.Nice'] = _t(__CLASS__ . '.OrderTotal', 'Total');
        $labels['ReceiptLink'] = _t(__CLASS__ . '.ReceiptLink', 'Invoice');
        $labels['Details.ProductID'] = _t(__CLASS__ . '.Details.ProductID', 'Product');
        return $labels;
    }

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

    /**
     * @return mixed
     */
    public function getReceiptLink()
    {
        $obj = DBHTMLVarchar::create();
        $obj->setValue(
            '<a href="' . $this->ReceiptURL . '" target="_blank" class="cms-panel-link action external-link">view</a>'
        );
        return $obj;
    }

    /**
     * @throws \SilverStripe\ORM\ValidationException
     */
    protected function onBeforeWrite()
    {
        parent::onBeforeWrite();
        $this->parseOrder();
    }

    /**
     * @return bool
     *
     * @throws ValidationException
     */
    public function parseOrder()
    {
        if ($this->getTransaction() && $this->getTransaction()->exists()) {
            $this->parseOrderInfo();
            $this->parseOrderCustomer();
            $this->parseOrderDetails();
        }

        $this->extend('updateParseOrder', $this);
    }

    /**
     * @param $response
     */
    public function parseOrderInfo()
    {
        $transaction = $this->getTransaction()->getTransaction();

        // Record transaction data from FoxyCart Datafeed:
        $this->StoreID = (int)$transaction->store_id;

It seems like (int)$transaction->store_id of type integer is incompatible with the declared type SilverStripe\ORM\FieldType\DBInt of property $StoreID.

        $this->Email = (string)$transaction->customer_email;

It seems like (string)$transaction->customer_email of type string is incompatible with the declared type SilverStripe\ORM\FieldType\DBVarchar of property $Email.

        $this->TransactionDate = (string)$transaction->transaction_date;

It seems like (string)$transaction->transaction_date of type string is incompatible with the declared type SilverStripe\ORM\FieldType\DBDatetime of property $TransactionDate.

        $this->ProductTotal = (float)$transaction->product_total;

It seems like (double)$transaction->product_total of type double is incompatible with the declared type SilverStripe\ORM\FieldType\DBCurrency of property $ProductTotal.

        $this->TaxTotal = (float)$transaction->tax_total;

It seems like (double)$transaction->tax_total of type double is incompatible with the declared type SilverStripe\ORM\FieldType\DBCurrency of property $TaxTotal.

        $this->ShippingTotal = (float)$transaction->shipping_total;

It seems like (double)$transaction->shipping_total of type double is incompatible with the declared type SilverStripe\ORM\FieldType\DBCurrency of property $ShippingTotal.

        $this->OrderTotal = (float)$transaction->order_total;

It seems like (double)$transaction->order_total of type double is incompatible with the declared type SilverStripe\ORM\FieldType\DBCurrency of property $OrderTotal.

        $this->ReceiptURL = (string)$transaction->receipt_url;

It seems like (string)$transaction->receipt_url of type string is incompatible with the declared type SilverStripe\ORM\FieldType\DBVarchar of property $ReceiptURL.

        $this->OrderStatus = (string)$transaction->status;

It seems like (string)$transaction->status of type string is incompatible with the declared type SilverStripe\ORM\FieldType\DBVarchar of property $OrderStatus.

        $this->extend('handleOrderInfo', $order, $response);
    }

    /**
     * @param $response
     * @throws \SilverStripe\ORM\ValidationException
     */
    public function parseOrderCustomer()
    {
        $transaction = $this->getTransaction()->getTransaction();
        $customer = false;

        // if not a guest transaction in Foxy
        if (isset($transaction->customer_email) && $transaction->is_anonymous == 0) {
            if ($customer = Member::get()->filter('Email', $transaction->customer_email)->first()) {
                // set Order MemberID
                $this->MemberID = $customer->ID;
            }
        }
        $this->extend('updateParseOrderCustomer', $transaction, $customer);
    }

    /**
     * @param $response
     *
     * @throws \SilverStripe\ORM\ValidationException
     */
    public function parseOrderDetails()
    {
        // remove previous OrderDetails and OrderOptions so we don't end up with duplicates
        foreach ($this->Details() as $detail) {

The method Details() does not exist on Dynamic\Foxy\Orders\Model\Order. Since you implemented __call, consider adding a @method annotation.

            /** @var OrderOption $orderOption */
            foreach ($detail->OrderOptions() as $orderOption) {
                $orderOption->delete();
            }
            $detail->delete();
        }

        $transaction = $this->getTransaction()->getTransaction();

        // Associate ProductPages, Options, Quantity with Order
        foreach ($transaction->transaction_details->transaction_detail as $detail) {
            $OrderDetail = OrderDetail::create();
            $OrderDetail->Quantity = (int)$detail->product_quantity;
            $OrderDetail->ProductName = (string)$detail->product_name;
            $OrderDetail->ProductCode = (string)$detail->product_code;
            $OrderDetail->ProductImage = (string)$detail->image;
            $OrderDetail->ProductCategory = (string)$detail->category_code;
            $priceModifier = 0;

            // parse OrderOptions
            foreach ($detail->transaction_detail_options->transaction_detail_option as $option) {
                // Find product via product_id custom variable
                if ($option->product_option_name == 'product_id') {
                    // if product is found, set relation to OrderDetail
                    $OrderProduct = SiteTree::get()->byID((int)$option->product_option_value);
                    if ($OrderProduct && $OrderProduct->isProduct()) {
                        $OrderDetail->ProductID = $OrderProduct->ID;
                    }
                } else {
                    // record non product_id options as OrderOption
                    $OrderOption = OrderOption::create();
                    $OrderOption->Name = (string)$option->product_option_name;
                    $OrderOption->Value = (string)$option->product_option_value;
                    $OrderOption->write();
                    $OrderDetail->OrderOptions()->add($OrderOption);
                    $priceModifier += $option->price_mod;
                }
            }

            $OrderDetail->Price = (float)$detail->product_price + (float)$priceModifier;

            // extend OrderDetail parsing, allowing for recording custom fields from FoxyCart
            $this->extend('handleOrderItem', $this, $transaction, $OrderDetail);

            // write
            $OrderDetail->write();

            // associate with this order
            $this->Details()->add($OrderDetail);
        }
    }

    /**
     * @return array
     */
    public function providePermissions()
    {
        return [
            'MANAGE_FOXY_ORDERS' => [
                'name' => _t(
                    __CLASS__ . '.PERMISSION_MANAGE_ORDERS_DESCRIPTION',
                    'Manage orders'
                ),
                'category' => _t(
                    Purchasable::class . '.PERMISSIONS_CATEGORY',
                    'Foxy'
                ),
                'help' => _t(
                    __CLASS__ . '.PERMISSION_MANAGE_ORDERS_HELP',
                    'Manage orders and view recipts'
                ),
                'sort' => 400,
            ],
        ];
    }

    /**
     * @param bool $member
     *
     * @return bool|int
     */
    public function canView($member = null)
    {
        return Permission::checkMember($member, 'MANAGE_FOXY_ORDERS');
    }

    /**
     * @param null $member

Are you sure the doc-type for parameter $member is correct as it would always require null to be passed?

     *
     * @return bool
     */
    public function canEdit($member = null)
    {
        return false;
    }

    /**
     * @param null $member

Are you sure the doc-type for parameter $member is correct as it would always require null to be passed?

     *
     * @return bool
     */
    public function canDelete($member = null)
    {
        return false;
    }

    /**
     * @param null  $member

Are you sure the doc-type for parameter $member is correct as it would always require null to be passed?

     * @param array $context
     *
     * @return bool
     */
    public function canCreate($member = null, $context = [])
    {
        return false;
    }
}