OrderModifierForm

Complexity

Total Complexity

11

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	5

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	hp ➔ lcfirst()	0	6	1
B	__construct()	0	36	6
A	myLcFirst()	0	13	2
A	redirect()	0	4	1
A	submit()	0	5	1
A	saveDataToSession()	0	5	1

<?php

/**
 * @description: this class is the base class for modifier forms in the checkout form... we could do with more stuff here....
 *
 *
 * @authors: Nicolaas [at] Sunny Side Up .co.nz
 * @package: ecommerce
 * @sub-package: forms
 * @inspiration: Silverstripe Ltd, Jeremy
 **/
class OrderModifierForm extends Form

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * @var Order
     */
    protected $order;

    /**
     *NOTE: we semi-enforce using the OrderModifier_Controller here to deal with the submission of the OrderModifierForm
     * You can use your own modifiers or an extension of OrderModifier_Controller by setting the first parameter (optionalController)
     * to your own controller.
     *
     *@param $optionalController Controller
     *@param $name String
     *@param $fields FieldList
     *@param $actions FieldList
     *@param $validator SS_Validator
     **/
    public function __construct(
        Controller $optionalController = null,
        $name,

Parameters which have default values should be placed at the end.

        FieldList $fields,
        FieldList $actions,
        Validator $optionalValidator = null
    ) {
        if (!$optionalController) {
            $controllerClassName = EcommerceConfig::get('OrderModifierForm', 'controller_class');
            $optionalController = new $controllerClassName();
        }
        if (!$optionalValidator) {
            $validatorClassName = EcommerceConfig::get('OrderModifierForm', 'validator_class');
            $optionalValidator = new $validatorClassName();
        }
        parent::__construct($optionalController, $name, $fields, $actions, $optionalValidator);

        //extension point
        $this->extend('updateFields', $fields);
        $this->setFields($fields);
        $this->extend('updateActions', $actions);
        $this->setActions($actions);
        $this->extend('updateValidator', $optionalValidator);
        $this->setValidator($optionalValidator);

        $this->setAttribute('autocomplete', 'off');
        Requirements::themedCSS($this->ClassName, 'ecommerce');

The property ClassName does not exist on object<OrderModifierForm>. Since you implemented __get, maybe consider adding a @property annotation.

        $this->addExtraClass($this->myLcFirst(ucwords($name)));

$this->myLcFirst(ucwords($name)) is of type null|array<integer,string,{"0":"string"}>, but the function expects a string.

        Requirements::javascript(THIRDPARTY_DIR.'/jquery-form/jquery.form.js');
        //add JS for the modifier - added in modifier
        $oldData = Session::get("FormInfo.{$this->FormName()}.data");
        if ($oldData && (is_array($oldData) || is_object($oldData))) {
            $this->loadDataFrom($oldData);

It seems like $oldData can also be of type object; however, Form::loadDataFrom() does only seem to accept array|object<DataObject>, maybe add an additional type check?

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

    protected function myLcFirst($str)
    {
        if (function_exists('lcfirst') === false) {
            function lcfirst($str)
            {
                $str[0] = strtolower($str[0]);

                return $str;
            }
        } else {
            return lcfirst($str);
        }
    }

    /**
     * @param string $status
     * @param string $message
     */
    public function redirect($status = 'success', $message = '')

The parameter $status is not used and could be removed.

The parameter $message is not used and could be removed.

    {
        //return ShoppingCart::singleton()->addmessage($status, $message);

69% of this comment could be valid code. Did you maybe forget this after debugging?

    }

    /**
     * @param array  $data
     * @param Form   $form
     * @param string $status
     * @param string $message
     *
     * @return ShoppingCart Response (JSON / Redirect Back)
     */
    public function submit(array $data, Form $form, $message = 'order updated', $status = 'good')

The parameter $data is not used and could be removed.

The parameter $form is not used and could be removed.

    {
        //to do - add other checks here...
         return ShoppingCart::singleton()->setMessageAndReturn($message, $status);
    }

    /**
     * saves the form into session.
     *
     * @param array $data - data from form.

There is no parameter named $data. Was it maybe removed?

     */
    public function saveDataToSession()
    {
        $data = $this->getData();
        Session::set("FormInfo.{$this->FormName()}.data", $data);

$data is of type array, but the function expects a string.

    }
}