RepeatOrdersPage

Complexity

Total Complexity

8

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	get_repeat_order_link()	0	8	2
A	canCreate()	0	8	2
A	getCMSFields()	0	19	1
A	requireDefaultRecords()	0	17	2
A	onBeforeWrite()	0	4	1

<?php
/**
 * RepeatOrdersPage page shows order history and a form to allow
 * the member to edit his/her details.
 *
 * @package ecommerce
 * @subpackage ecommerce ecommerce_Repeatorders
 * @author nicolaas [at] sunnysideup.co.nz
 */
class RepeatOrdersPage extends AccountPage
{
    use RepeatOrdersTrait;
    /**
     * Standard SS method
     */
    private static $db = array(
        "WhatAreRepeatOrders" => "HTMLText", // explanation of repeat orders in general
        "OnceLoggedInYouCanCreateRepeatOrder" => "HTMLText" //explaining the benefits of logging in for Repeat Orders
    );

    /**
     * Standard SS method
     */
    private static $week_days = array(
        "Monday" => "Monday",
        "Tuesday" => "Tuesday",
        "Wednesday" => "Wednesday",
        "Thursday" => "Thursday",
        "Friday" => "Friday",
        "Saturday" => "Saturday",
        "Sunday" => "Sunday"
    );

    /**
     * Return a link to view the order on the account page.
     * actions are: create, update, view
     * @param String $action
     * @param int|string $orderID ID of the order

There is no parameter named $orderID. Did you maybe mean $repeatOrderID?

     */
    public static function get_repeat_order_link($action = 'view', $repeatOrderID = 0)
    {
        $page = DataObject::get_one(__CLASS__);
        if (!$page) {
            user_error('No RepeatOrderPage was found. Please create one in the CMS!', E_USER_ERROR);
        }
        return $page->Link($action)."/".$repeatOrderID."/";
    }

    /**
     * standard SS Method
     */
    public function canCreate($member = null)
    {
        if(DataObject::get_one("RepeatOrdersPage")) {
            return false;
        } else {
            return parent::canCreate($member);
        }
    }


    /**
     * standard SS Method
     */
    public function getCMSFields()

The return type could not be reliably inferred; please add a @return annotation.

    {
        $fields = parent::getCMSFields();
        $fields->addFieldsToTab(
            "Root.ExplainingRepeatOrders",
            [
                HtmlEditorField::create(
                    $name = "WhatAreRepeatOrders",
                    $title = "What Are Repeat Orders."
                )->setDescription('Explanation Used throughout the site'),
                HtmlEditorField::create(
                    $name = "OnceLoggedInYouCanCreateRepeatOrder",
                    $title = "Not Logged In"
                )->setDescription('Explanation for people who are not logged-in yet explaining that they can turn an order into a Repeat order...')
            ]
        );

        return $fields;
    }

    /**
     * Automatically create an AccountPage if one is not found
     * on the site at the time the database is built (dev/build).
     */
    public function requireDefaultRecords()
    {
        parent::requireDefaultRecords();
        if (!DataObject::get_one('RepeatOrdersPage')) {
            $page = RepeatOrdersPage::create();
            $page->Title = 'Repeat Orders';
            $page->Content = '<p>This is the Repeat orders account page. It is used for shop users to login and create or change their Repeat orders.</p>';
            $page->URLSegment = 'repeat-orders';
            $page->WhatAreRepeatOrders = '<p>Repeat Orders allow you to regularly repeat an order.</p>';
            $page->OnceLoggedInYouCanCreateRepeatOrder = '<p>Once logged in you can setup a repeating order.</p>';
            $page->ShowInMenus = 0;
            $page->ShowInSearch = 0;
            $page->writeToStage('Stage');
            $page->publish('Stage', 'Live');
            DB::alteration_message('Repeat Order page \'Repeat Orders\' created', 'created');
        }
    }

    /**
     * Standard SS method
     * Sets the days available for repeating orders.
     */
    public function onBeforeWrite()
    {
        parent::onBeforeWrite();
    }
}


class RepeatOrdersPage_Controller extends AccountPage_Controller
{

    /**
     * Defines methods that can be called directly
     * @var array
     */
    private static $allowed_actions = array(

Consider using a different property name as you override a private property of the parent class.

        'createorder' => true,
        'cancel' => true,
        'view' => true,
        'modify' => true,
        'admin' => true,
        'ajaxcheckoutcancel' => true,
        'ajaxcreateorder' => true,
        'RepeatOrderForm' => true
    );

    public function init()
    {
        parent::init();
    }

    public function createorder($request)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $orderID = intval($request->param("ID"));
        $order = null;
        if ($orderID) {
            $order = Order::get_by_id_if_can_view($orderID);
        }
        if (!$order) {
            $order = ShoppingCart::current_order();
        }
        //TODO: move items to order
        $params = array(
            'Order' => $order,
        );
        return $this->renderWith(
            ['RepeatOrdersPage_edit', 'Page'],
            $params
        );
    }

    public function view($request)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $params = array(
            'RepeatOrder' => false,
            'Message' => 'Repeating order could not be found.'
        );
        if ($repeatOrderID = intval($request->param("ID"))) {
            $repeatOrder = DataObject::get_one('RepeatOrder', "RepeatOrder.ID = '$repeatOrderID'");
            if ($repeatOrder && $repeatOrder->canView()) {
                $params = array(
                    'RepeatOrder' => $repeatOrder,
                    'Message' => "Please review order below."
                );
            } else {
                $params = array(
                    'RepeatOrder' => '',
                    'Message' => "You do not have permission to view this Order, please log in."
                );
            }
        }

        return $this->renderWith(
            ['RepeatOrdersPage_view', 'Page'],
            $params
        );
    }

    public function modify($request)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $params = [
            'RepeatOrder' => false,
            'Message' => 'There is no order by that ID.'
        ];
        if ($repeatOrderID = intval($request->param("ID"))) {
            $repeatOrder = DataObject::get_by_id('RepeatOrder', $repeatOrderID);
            $member = Member::currentUser();
            if ($repeatOrder->canEdit($member)) {

It seems like $member defined by \Member::currentUser() on line 196 can also be of type object<DataObject>; however, DataObject::canEdit() does only seem to accept object<Member>|null, maybe add an additional type check?

                $params = [
                    'RepeatOrder' => $repeatOrder,
                    'Message' => 'Please edit your details below.'
                ];
            }
        }
        return $this->renderWith(
            ['RepeatOrdersPage_edit', 'Page'],
            $params
        );
    }

    public function cancel($request)

The return type could not be reliably inferred; please add a @return annotation.

    {

        if ($repeatOrderID = intval($request->param("ID"))) {
            $repeatOrder = DataObject::get_one('RepeatOrder', ["ID" => $repeatOrderID]);
            $member = Member::currentUser();
            if ($repeatOrder && $repeatOrder->canEdit($member)) {

It seems like $member defined by \Member::currentUser() on line 215 can also be of type object<DataObject>; however, DataObject::canEdit() does only seem to accept object<Member>|null, maybe add an additional type check?

                $repeatOrder->Status = 'MemberCancelled';
                $repeatOrder->write();
                return $this->redirectBack();
            }
        }
        die("Could not cancel repeat order, please contact that administrator for assistance.");
    }

    /**
     * Show a list of all repeating orders.
     * @return HTML
     */
    public function admin()
    {
        $shopAdminCode = EcommerceConfig::get("EcommerceRole", "admin_permission_code");
        if (Permission::check("ADMIN") || Permission::check($shopAdminCode)) {
            RepeatOrder::create_automatically_created_orders();
            $params = array(
                "AllRepeatOrders" => RepeatOrder::get()->filter(["Status" => 'Active'])
            );
            Requirements::javascript(THIRDPARTY_DIR."/jquery/jquery.js");
            //Requirements::block(THIRDPARTY_DIR."/jquery/jquery.js");
            //Requirements::javascript(Director::protocol()."ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js");
            Requirements::javascript("ecommerce_repeatorders/javascript/RepeatOrdersPage_admin.js");
            Requirements::themedCSS("RepeatOrdersPage_admin");

            return $this->renderWith(
                ['RepeatOrdersPage_admin', 'Page'],
                $params
            );
        } else {
            return Security::permissionFailure($this, _t('OrderReport.PERMISSIONFAILURE', 'Sorry you do not have permission for this function. Please login as an Adminstrator'));
        }
    }

    public function ajaxcreateorder($request)
    {
        $orderID = intval($request->postVar('OrderID'));
        if ($request->isAjax()) {
            $orderForm = RepeatOrderForm::create(
                $this,
                'RepeatOrderForm',
                0,
                $orderID
            );
            $orderForm->doCreate($this->request->postVars(), $orderForm, $request);
        }
        else {
            user_error('This function can only be called via Ajax.');
        }
    }

    //* function should only be called from the checkout and only via ajax
    public function ajaxcheckoutcancel($request)
    {
        if ($request->isAjax()) {
            if ($repeatOrderID = intval($request->param("ID"))) {
                $repeatOrder = DataObject::get_one('RepeatOrder', ["ID" => $repeatOrderID]);
                if ($repeatOrder && $repeatOrder->canModify()) {
                    $repeatOrder->Status = 'MemberCancelled';
                    $repeatOrder->write();
                    $order = $repeatOrder->OriginatingOrder();
                    $order->RepeatOrderID = 0;
                    $order->write();
                    return true;
                }
            }
        }
        else {
            user_error('This function can only be called via Ajax.');
        }
    }

    /**
     *
     * @return RepeatOrderForm
     */
    public function RepeatOrderForm()
    {
        $action = $this->request->param('Action');
        $repeatOrderID = intval($this->request->param('ID'));
        $orderID = 0;
        if ($action == 'createorder' || isset($_REQUEST['action_doCreate'])) {
            if (isset($_REQUEST['action_doCreate']) && isset($_REQUEST['repeatOrderID'])) {

This code seems to be duplicated across your project.

                $repeatOrderID = intval($_REQUEST['repeatOrderID']);
            }
            if ($action == 'createorder') {
                $orderID = $repeatOrderID;
                $repeatOrderID = 0;
            }
            return RepeatOrderForm::create(
                $this,
                'RepeatOrderForm',
                $repeatOrderID,
                $orderID
            );
        } elseif ($action == 'update' || isset($_REQUEST['action_doSave'])) {
            if (isset($_REQUEST['action_doSave']) && isset($_REQUEST['RepeatOrderID'])) {

This code seems to be duplicated across your project.

                $repeatOrderID = intval($_REQUEST['RepeatOrderID']);
            }
            return RepeatOrderForm::create(
                $this,
                'RepeatOrderForm',
                $repeatOrderID,
                $orderID
            );
        } elseif ($repeatOrderID) {

            return RepeatOrderForm::create(
                $this,
                'RepeatOrderForm',
                $repeatOrderID,
                $orderID,
                true
            );
        } else {
            return $this->redirect('404-could-not-find-order');
        }
    }

    public function AccountPageLink()

The return type could not be reliably inferred; please add a @return annotation.

    {
        $accountPage = AccountPage::get()->first();
        if($accountPage){
            return $accountPage->Link();
        }
        return false;
    }
}