ShoppingCart::__construct() - Code Metrics - Inspection of "Move shopping cart setup to init" - silvercommerce/shoppingcart - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 1.0 ( c0c1b4...dd1df7 )

by Morven
created 2018-08-14 21:09 UTC
ShoppingCart::__construct() A

↳ Parent: ShoppingCart::init()
Complexity

Conditions	1
Paths	1
Size

Total Lines	8
Code Lines	4
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	4
nc	1
nop	0
dl	0
loc	8
rs	10
c	0
b	0
f	0
<?php

namespace SilverCommerce\ShoppingCart\Control;

use SilverStripe\i18n\i18n;
use SilverStripe\Forms\Form;
use SilverStripe\View\SSViewer;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\TextField;
use SilverStripe\Control\Director;
use SilverStripe\Forms\FormAction;
use SilverStripe\Control\Controller;
use SilverStripe\ORM\ValidationResult;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Subsites\Model\Subsite;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\ORM\ValidationException;
use SilverCommerce\Checkout\Control\Checkout;
filter:
    dependency_paths: ["lib/*"]
use SilverCommerce\Postage\Forms\PostageForm;
use SilverCommerce\OrdersAdmin\Model\Estimate;
use SilverStripe\CMS\Controllers\ContentController;
filter:
    dependency_paths: ["lib/*"]
use SilverCommerce\ShoppingCart\ShoppingCartFactory;

/**
 * Holder for items in the shopping cart and interacting with them, as
 * well as rendering these items into an interface that allows editing
 * of items,
 *
 * @author ilateral (http://www.ilateral.co.uk)
 * @package shoppingcart
 */
class ShoppingCart extends Controller
{

    /**
     * URL Used to access this controller
     *
     * @var string
     * @config
     */
    private static $url_segment = 'shoppingcart';

    /**
     * Setup default templates for this controller
     *
     * @var array
     */
    protected $templates = [
        "index" => [ShoppingCart::class, "Page"],
        "usediscount" => [ShoppingCart::class . "_usediscount", ShoppingCart::class, "Page"]
    ];
    
    /**
     * Overwrite the default title for this controller which is taken
     * from the translation files. This is used for Title and MetaTitle
     * variables in templates.
     *
     * @var string
     * @config
     */
    private static $title;

    /**
     * Class Name of object we use as an assotiated estimate.
     * This defaults to Estimate
     *
     * @var string
     * @config
     */
    private static $checkout_class = Checkout::class;

    /**
     * Show the discount form on the shopping cart
     *
     * @var boolean
     * @config
     */
    private static $show_discount_form = false;

    /**
     * Redirect the user to the cart when an item is added?
     * 
     * @var boolean
     */
    private static $redirect_on_add = false;


    /**
     * The associated dataRecord
     *
     * @var ShoppingCartModel
filter:
    dependency_paths: ["lib/*"]
     */
    protected $dataRecord;

    /**
     * These methods are mapped to sub URLs of this
     * controller.
     *
     * @var array
     */
    private static $allowed_actions = [

        "remove",
        "emptycart",
        "usediscount",
        "setdeliverytype",
        "checkout",
        "CartForm",
        "PostageForm",
        "DiscountForm"
    ];

    /**
     * Overwrite default init to support subsites (if installed)
     * 
     * @return void 
     */
    protected function init()
    {
        parent::init();

        // Setup current controller on init (as Security::getMember()
        // is not available on construction)
        $dataRecord = ShoppingCartFactory::create()->getCurrent();
        $this->setDataRecord($dataRecord);
        $this->setFailover($this->dataRecord);

        # Check for subsites and add support
        if (class_exists(Subsite::class)) {
            $subsite = Subsite::currentSubsite();

            if ($subsite && $subsite->Theme) {
                SSViewer::add_themes([$subsite->Theme]);
            }

            if ($subsite && i18n::getData()->validate($subsite->Language)) {
                i18n::set_locale($subsite->Language);
            }
        }
    }
    
    public function getTitle()
    {
        if ($this->config()->title) {
            return $this->config()->title;
        } else {
            _t("SilverCommerce\ShoppingCart.CartName", "Shopping Cart");
        }
    }

    public function getMetaTitle()
    {
        return $this->getTitle();
    }

    public function getShowDiscountForm()
    {
        return $this->config()->show_discount_form;
    }

    public function getDataRecord()
    {
        return $this->dataRecord;
    }

    public function setDataRecord($record)
    {
        $this->dataRecord = $record;
        return $this;
    }

    /**
     * Get the link to this controller
     *
     * @param string $action The action you want to add to the link
     * @return string
     */
    public function Link($action = null)
    {
        return Controller::join_links(
            $this->config()->url_segment,
            $action
        );
    }

    /**
     * Get an absolute link to this controller
     *
     * @param string $action The action you want to add to the link
     * @return string
     */
    public function AbsoluteLink($action = null)
    {
        return Director::absoluteURL($this->Link($action));
    }

    /**
     * Get a relative (to the root url of the site) link to this
     * controller
     *
     * @param string $action The action you want to add to the link
     * @return string
     */
    public function RelativeLink($action = null)
    {
        return Controller::join_links(
            Director::baseURL(),
            $this->Link($action)
        );
    }

    /**
     * If content controller exists, return it's menu function
     * @param int $level Menu level to return.
     * @return ArrayList
filter:
    dependency_paths: ["lib/*"]
     */
    public function getMenu($level = 1)
    {
        if (class_exists(ContentController::class)) {
            $controller = ContentController::singleton();
            return $controller->getMenu($level);
        }
    }

    public function Menu($level)
    public function Menu(/** @scrutinizer ignore-unused */ $level)
    {
        return $this->getMenu();
    }

    /**
     * Default acton for the shopping cart
     */
    public function index()
    {
        $this->extend("onBeforeIndex");

        return $this->render();
    }

    /**
     * Remove a product from ShoppingCart Via its ID. This action
     * expects an ID to be sent through the URL that matches a specific
     * key added to an item in the cart
     *
     * @return Redirect
filter:
    dependency_paths: ["lib/*"]
     */
    public function remove()
    {
        $key = $this->request->param('ID');
        $item = null;
        $title = null;


        if (isset($key)) {
            $item = $this
                ->Items()
                ->/** @scrutinizer ignore-call */ Items()
                ->find("Key", $key);
        }

        if (isset($item)) {
            $title = $item->Title;
            ShoppingCartFactory::create()->removeItem($item);

            $form = $this->CartForm();
            $form->sessionMessage(_t(
                "ShoppingCart.RemovedItem",
                "Removed '{title}' from your cart",
                ["title" => $title]
            ));
        }

        return $this->redirectBack();
    }
    
    /**
     * Action that will clear shopping cart and associated items
     *
     */
    public function emptycart()
    {
        ShoppingCartFactory::create()->delete();
        
        $form = $this->CartForm();
        $form->sessionMessage(_t(
            "ShoppingCart.EmptiedCart",
            "Shopping cart emptied"
        ));

        return $this->redirectBack();
    }
    
    
    /**
     * Action used to add a discount to the users session via a URL.
     * This is preferable to using the dicount form as disount code
     * forms seem to provide a less than perfect user experience
     *
     */
    public function usediscount()
    {   
        $code_to_search = $this->request->param("ID");
        $code = false;
        $curr = $this->getDiscount();
        $curr = $this->getDiscount();
        
        if (!$code_to_search) {
            return $this->httpError(404, "Page not found");
        }
        
        // First check if the discount is already added (so we don't
        // query the DB if we don't have to).
        if (!$curr || ($curr && $curr->Code != $code_to_search)) {
            $code = Discount::get()
filter:
    dependency_paths: ["lib/*"]
                ->filter("Code", $code_to_search)
                ->exclude("Expires:LessThan", date("Y-m-d"))
                ->first();
            
            if ($code) {
                $this->setDiscount($code);
                       setDiscount($code);
                $this->save();
                       save();
            }
        } elseif ($curr && $code->Code == $code_to_search) {

            $code = $this->getDiscount();
        }

        $this->extend("onBeforeUseDiscount");

        return $this
            ->customise([
                "Discount" => $code
            ])->render();
    }

    /**
     * Setup the checkout and redirect to it
     *
     * @return Redirect
     */
    public function checkout()
    {
        if (!class_exists($this->config()->checkout_class)) {
            return $this->httpError(404);
        }

        $checkout = Injector::inst()
            ->get($this->config()->checkout_class);
        $checkout->setEstimate($this->dataRecord);

        $this->extend("onBeforeCheckout");

        $this->redirect($checkout->Link());
    }
    
    /**
     * Shortcut to checkout config, to allow us to access it via
     * templates
     *
     * @return boolean
     */
    public function ShowTax()
    {
        $config = SiteConfig::current_site_config();
        return $config->ShowPriceAndTax;
    }

    /**
     * Form responsible for listing items in the shopping cart and
     * allowing management (such as addition, removal, etc)
     *
     * @return Form
     */
    public function CartForm()
    {   
        $form = Form::create(
            $this,
            "CartForm",
            FieldList::create(),
            FieldList::create(
                FormAction::create(
                    'doUpdate',
                    _t('ShoppingCart.UpdateCart', 'Update Cart')
                )->addExtraClass('btn btn-info')
            )
        )->setTemplate("SilverCommerce\ShoppingCart\Forms\Includes\ShoppingCartForm");
        
        $this->extend("updateCartForm", $form);
        
        return $form;
    }
    
    /**
     * Form that allows you to add a discount code which then gets added
     * to the cart's list of discounts.
     *
     * @return Form
     */
    public function DiscountForm()
    {
        $form = Form::create(
            $this,
            "DiscountForm",
            FieldList::create(
                TextField::create(
                    "DiscountCode",
                    _t("ShoppingCart.DiscountCode", "Discount Code")
                )->setAttribute(
                    "placeholder",
                    _t("ShoppingCart.EnterDiscountCode", "Enter a discount code")
                )
            ),
            FieldList::create(
                FormAction::create(
                    'doAddDiscount',
                    _t('ShoppingCart.Add', 'Add')
                )->addExtraClass('btn btn-info')
            )
        );
        
        $this->extend("updateDiscountForm", $form);
        
        return $form;
    }
    
    /**
     * Form responsible for estimating shipping based on location and
     * postal code
     *
     * @return Form
     */
    public function PostageForm()
    {
        if ($this->isDeliverable()) {
        if ($this->/** @scrutinizer ignore-call */ isDeliverable()) {
            $form = PostageForm::create(
                $this,
                "PostageForm",
                $this->dataRecord,
                $this->dataRecord->SubTotal,
                $this->dataRecord->TotalWeight,
                $this->dataRecord->TotalItems
            );

            $form->setLegend(_t(
                "SilverCommerce\ShoppingCart.EstimatePostage",
                "Estimate Postage"
            ));

            // Extension call
            $this->extend("updatePostageForm", $form);

            return $form;
        }
    }

    /**
     * Action that will update cart
     *
     * @param type $data
     * @param type $form
filter:
    dependency_paths: ["lib/*"]
     */
    public function doUpdate($data, $form)
    {
        try {
            foreach ($this->Items() as $item) {
                foreach ($data as $key => $value) {
                    $sliced_key = explode("_", $key);
                    if ($sliced_key[0] == "Quantity") {
                        if (isset($item) && ($item->Key == $sliced_key[1])) {
                            if ($value > 0) {
                                ShoppingCartFactory::create()->updateItem(
                                    $item,
                                    $value
                                );
                            } else {
                                $item->delete();
                            }

                            $form->sessionMessage(
                                _t("ShoppingCart.UpdatedShoppingCart", "Shopping cart updated"),
                                ValidationResult::TYPE_GOOD
                            );
                        }
                    }
                }
            }
        } catch (ValidationException $e) {
            $form->sessionMessage(
                $e->getMessage()
            );
        } catch (Exception $e) {

            $form->sessionMessage(
                $e->getMessage()
            );
        }
        
        return $this->redirectBack();
    }
    
    /**
     * Action that will find a discount based on the code
     *
     * @param type $data
     * @param type $form
     */
    public function doAddDiscount($data, $form)
    public function doAddDiscount($data, /** @scrutinizer ignore-unused */ $form)
    {
        $code_to_search = $data['DiscountCode'];
        
        // First check if the discount is already added (so we don't
        // query the DB if we don't have to).
        if ($this->getDiscount()->Code != $code_to_search) {
            $code = Discount::get()
                ->filter("Code", $code_to_search)
                ->exclude("Expires:LessThan", date("Y-m-d"))
                ->first();
            
            if ($code) {
                $this->setDiscount($code);
                $this->save();
            }
        }
        
        return $this->redirectBack();
    }
}

silvercommerce / shoppingcart

Push — 1.0 ( c0c1b4...dd1df7 )

ShoppingCart::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
