CreateEcommerceVariations_Field - Code Metrics - sunnysideup/silverstripe-ecommerce_product_variation - Measure and Improve Code Quality continuously with Scrutinizer

CreateEcommerceVariations_Field A
last analyzed 2018-07-12 04:11 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	47
Duplicated Lines	29.79 %

Coupling/Cohesion

Components	0
Dependencies	6

Importance

Changes

Metric	Value
wmc	12
lcom	0
cbo	6
dl	14
loc	47
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	ProductVariationGetPluralName()	0	4	1
A	ProductAttributeTypeGetPluralName()	0	4	1
A	ProductAttributeValueGetPluralName()	0	4	1
A	CheckboxField()	0	4	1
A	TextField()	0	4	1
A	AttributeSorterLink()	7	7	3
A	ValueSorterLink()	7	7	3

How to fix Duplicated Code

<?php

/**
 * this class helps to create/edit/delete variations
 *
 *
 */

class CreateEcommerceVariations extends Controller
namespace YourVendor;

class YourClass { }
{
    private static $allowed_actions = array(

        "jsonforform" => "ADMIN",
        "createvariations",
        "select",
        "rename",
        "add",
        "remove",
        "move",
        'cansavevariation'
    );

    /**
     * The selected Product (ID)
     * @var Int
     */
    protected $_productID = 0;

    /**
     * The select Product (Object)
     * @var Product
     */
    protected $_product = null;

    /**
     * type | value
     * @var String
     */
    protected $_typeorvalue = "type"; // or value!

    /**
     * ProductAttributeValue | ProductAttributeType
     * @var String
     */
    protected $_classname = "type"; // or value!

    /**
     * Name of the Name field
     * @var String
     */
    protected $_namefield = "Name";

    /**
     * Name of the Label field
     * only for ProductAttributeType
     * @var String
     */
    protected $_labelfield = "Label";

    /**
     * Id of the item being altered
     * or its parent...
     * @var Int
     */
    protected $_id = 0;

    /**
     * Value of the item being altered
     * @var String
     */
    protected $_value = "";

    /**
     * Position in the sorting order
     * use -1 to distinguish it from 0 (first in sorting order)
     * @var Int
     */
    protected $_position = -1;

    /**
     * Return message
     * @var String
     */
    protected $_message = "";

    /**
     * Type of message
     * good | bad | warning
     * @var String
     */
    protected $_messageclass = "good";

    /**
     * Type IDs that are selected in the PRODUCT
     * @var Array
     */
    protected $_selectedtypeid = array();

    /**
     * Value IDs that are selected in the PRODUCT
     * @var Array
     */
    protected $_selectedvalueid = array();

    /**
     * What is going to be sent back.
     * @var String
     */
    protected $output = "";

    /**
     * The name for the session varilable.
     * @var String
     */
    private static $session_name_for_selected_values = "SelectecedValues";


    /**
     *
     * @var String
     */
    private static $url_segment = "createecommercevariations";


    public function init()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        parent::init();
        Versioned::set_reading_mode("Stage.Stage");
        $shopAdminCode = EcommerceConfig::get("EcommerceRole", "admin_permission_code");
        if (!Permission::check("CMS_ACCESS_CMSMain") && !Permission::check($shopAdminCode)) {
            return Security::permissionFailure($this, _t('Security.PERMFAILURE', ' This page is secured and you need CMS rights to access it. Enter your credentials below and we will send you right along.'));
        }
        if (isset($_GET["typeorvalue"])) {
            $this->_typeorvalue = $_GET["typeorvalue"];
        }
        if (isset($_GET["id"])) {
            $this->_id = intval($_GET["id"]);
        }
        if (isset($_GET["value"])) {
            $this->_value = urldecode($_GET["value"]);
        }
        if (isset($_GET["position"])) {
            $this->_position = intval($_GET["_position"]);
        }
        if ($this->_typeorvalue == "type") {
            $this->_classname = 'ProductAttributeType';
            $this->_namefield = 'Name';
        } else {
            $this->_classname = 'ProductAttributeValue';
            $this->_namefield = 'Value';
        }

        $this->_productID = $this->request->param("ProductID");
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        $this->_product = Product::get()->byID($this->_productID);
        if (!$this->_product) {
            user_error("could not find product for ID: ".$this->_productID, E_USER_WARNING);
        }
        $this->_selectedtypeid = $this->_product->getArrayOfLinkedProductAttributeTypeIDs();
        $this->_selectedvalueid = $this->_product->getArrayOfLinkedProductAttributeValueIDs();
    }


    public function Link($action = null)
    {
        return Controller::join_links(
            Director::baseURL(),
            $this->Config()->get("url_segment"),
            $action
        );
    }

    public function index()
    {
        return 10;
    }

    public function Output()
    {
        return $this->output;
    }

    /**
     *
     * checks the selected types and values and
     * makes variations from it...
     */
    public function createvariations()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        //lazy array
        $missingTypesID = array(-1 => -1);
        $missingTypes = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        foreach ($this->_selectedtypeid as $typeID) {
            if (! isset($_GET[$typeID])) {
                $missingTypesID[$typeID] = $typeID;
            }
        }
        $types = ProductAttributeType::get()->exclude(array("ID" => $missingTypesID));
        if ($types->count()) {
            $allTypesAndValues = array();
            foreach ($types as $type) {
                if (isset($_GET[$type->ID])) {
                    $oldValuesArray = explode(',', $_GET[$type->ID]);
                    $newValuesArray = array();
                    foreach ($oldValuesArray as $oldValuesArray_Key => $oldValuesArray_Value) {
                        $newValuesArray[$oldValuesArray_Value] = $oldValuesArray_Value;
                    }
                    $allTypesAndValues[$type->ID] = $newValuesArray;
                }
            }
            $cpt = 0;
            if (count($allTypesAndValues) > 0) {
                //create the variations...
                $cpt = $this->_product->generateVariationsFromAttributeValues($allTypesAndValues);
                //reset values in this class ...
                $this->_selectedtypeid = $this->_product->getArrayOfLinkedProductAttributeTypeIDs();
                $this->_selectedvalueid = $this->_product->getArrayOfLinkedProductAttributeValueIDs();
            }
            if ($cpt > 0) {
                $this->_message = ($cpt == 1 ? '1 new variation has' : "$cpt new variations have") . ' been created successfully';
            } else {
                $this->_message = 'No new variations created';
            }
        } else {
            $this->_message = 'No attribute types';
        }
        $this->output = $this->jsonforform();
        return $this->output;
    }


    /**
     *
     * @return String
     */
    public function jsonforform()
    {
        if (! $this->_message) {
            $this->_message = _t("CreateEcommerceVariations.STARTEDITING", "Start editing the list below to create variations.");
        }
        $result['Message'] = $this->_message;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $result['MessageClass'] = $this->_messageclass;
        $types = ProductAttributeType::get();
        if ($types->count()) {
            foreach ($types as $type) {
                $resultType = array(
                    'ID' => $type->ID,
                    'Name' => $type->Name,
                    'EditLink' => $type->CMSEditLink(),
                    'Checked' => isset($this->_selectedtypeid[$type->ID]),
                    'Disabled' => ! $this->_product->canRemoveAttributeType($type),
                    'CanDelete' => $type->canDelete()
                );
                $values = $type->Values();
                if ($values) {
                    foreach ($values as $value) {
                        $resultType['Values'][] = array(
                            'ID' => $value->ID,
                            'Name' => $value->Value,
                            'EditLink' => $value->CMSEditLink(),
                            'Checked' => isset($this->_selectedvalueid[$value->ID]),
                            'CanDelete' => $value->canDelete()
                        );
                    }
                }
                $result['Types'][] = $resultType;
            }
        }
        $this->output =  Convert::array2json($result);
        return $this->output;
    }

    public function select()

    {
        // is it type of Value?
        // if type is value -> create / delete Product Variation (if allowed)
        // elseif type is type - > add / remove selection...
        $this->_product->addAttributeType($obj);

        $this->_product->removeAttributeType($obj);
        die("not completed yet");

        $this->output =  $this->jsonforform();
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        return $this->output;
    }

    public function rename()
    {
        //is it Type or Value?
        $className = $this->_classname;
        $obj = $className::get()->byID($this->_id);
        if ($obj) {
            $name = $obj->{$this->_namefield};
            if ($obj instanceof ProductAttributeType) {
                $obj->{$this->_labelfield} = $this->_value;
                $name .= " (".$obj->{$this->_labelfield}.")";
            }
            $obj->{$this->_namefield} = $this->_value;
            $obj->write();
            $this->_message = _t("CreateEcommerceVariations.HASBEENRENAMED", "$name has been renamed to ".$this->_value, ".");
        } else {
            $this->_message = _t("CreateEcommerceVariations.CANNOTBEFOUND", "Entry can not be found.");
            $this->_messageclass = "bad";
        }
        $this->output =  $this->jsonforform();
        return $this->output;
    }

    /**
     * add a Type or a Value
     */
    public function add()
    {
        //is it Type or Value?
        $obj = new $this->_classname();
        $obj->{$this->_namefield} = $this->_value;
        if ($this->_id) {
            $obj->TypeID = $this->_id;
            $obj->write();
        } else {
            $obj->write();
            if ($obj instanceof ProductAttributeType) {
                $this->_product->addAttributeType($obj);
            }
        }
        $this->_selectedtypeid = $this->_product->getArrayOfLinkedProductAttributeTypeIDs();
        $this->_selectedvalueid = $this->_product->getArrayOfLinkedProductAttributeValueIDs();
        $this->_message = $this->_value.' '._t("CreateEcommerceVariations.HASBEENADDED", 'has been added.');
        $this->output =  $this->jsonforform();
        return $this->output;
    }

    /**
     * remove a Type or a Value
     */
    public function remove()
    {
        //is it Type or Value?
        $className = $this->_classname;
        $obj = $className::get()->byID($this->_id);
        if ($obj) {
            $name = $obj->{$this->_namefield};
            if ($obj->canDelete()) {
                if ($this->_typeorvalue == "type") {
                    $this->_product->removeAttributeType($obj);
                }
                $obj->delete();
                $obj->destroy();
                $this->_selectedtypeid = $this->_product->getArrayOfLinkedProductAttributeTypeIDs();
                $this->_selectedvalueid = $this->_product->getArrayOfLinkedProductAttributeValueIDs();
                $this->_message = _t("CreateEcommerceVariations.HASBEENDELETED", "$name has been deleted.");
            } else {
                $this->_message = _t("CreateEcommerceVariations.CANNOTBEDELETED", "$name can not be deleted (it is probably used in a sale).");
                $this->_messageclass = "bad";
            }
        } else {
            $this->_message = _t("CreateEcommerceVariations.CANNOTBEFOUND", "Entry can not be found.");
            $this->_messageclass = "bad";
        }
        $this->output =  $this->jsonforform();
        return $this->output;
    }

    public function move()

    {
        //is it Type or Value?
        //move Item
        die("not completed yet");

        $this->output =  "ok";
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        return $this->output;
    }

    /**
     *
     *
     * @return Boolean
     */
    public function cansavevariation()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $variation = null;
        if (isset($_GET['variation'])) {
            $obj = ProductVariation::get()->byID(intval($_GET['variation']));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        }
        foreach ($this->_selectedtypeid as $typeID) {
            if (isset($_GET[$typeID])) {
                $value = $_GET[$typeID];
                if (! $variation && ! $value) {
                    $this->output =  false;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
                    return $this->output;
                }
                if ($value) {
                    $values[$typeID] = $value;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                }
            } else {
                $this->output =  false;
                return $this->output;
            }
        }
        $variations = $this->_product->getComponents('Variations', $variation ? "\"ProductVariation\".\"ID\" != '$variation->ID'" : '');
        foreach ($variations as $otherVariation) {
            $otherValues = DB::query(
                "
                SELECT \"TypeID\", \"ProductAttributeValueID\"
                FROM \"ProductVariation_AttributeValues\"
                    INNER JOIN \"ProductAttributeValue\" ON \"ProductAttributeValue\".\"ID\" = \"ProductAttributeValueID\"
                WHERE \"ProductVariationID\" = '$otherVariation->ID' ORDER BY \"TypeID\""
            )->map()->toArray();
            if ($otherValues == $values) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                $this->output =  false;
                return $this->output;
            }
        }
        $this->output =  true;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        return $this->output;
    }
}


class CreateEcommerceVariations_Field extends LiteralField
namespace YourVendor;

class YourClass { }
{
    public function __construct($name, $additionalContent = '', $productID)
// $a must always be passed; it's default value is never used.
function someFunction($a = 5, $b) { }
    {
        Requirements::themedCSS("CreateEcommerceVariationsField", "ecommerce_product_variation");
        $additionalContent .= $this->renderWith("CreateEcommerceVariations_Field");
        parent::__construct($name, $additionalContent);
    }

    public function ProductVariationGetPluralName()
    {
        return Convert::raw2att(singleton("ProductVariation")->plural_name());
    }

    public function ProductAttributeTypeGetPluralName()
    {
        return Convert::raw2att(singleton("ProductAttributeType")->plural_name());
    }
    public function ProductAttributeValueGetPluralName()
    {
        return Convert::raw2att(singleton("ProductAttributeValue")->plural_name());
    }

    public function CheckboxField($name, $title)
    {
        return new CheckboxField($name, $title);
    }
    public function TextField($name, $title)
    {
        return new TextField($name, $title);
    }

    public function AttributeSorterLink()

    {
        $singleton = singleton("ProductAttributeType");
        if (class_exists("DataObjectSorterController") && $singleton->hasExtension("DataObjectSorterDOD")) {
            return DataObjectSorterController::popup_link($className = "ProductAttributeType", $filterField = "", $filterValue = "", $linkText = "Sort Types");
        }
    }
    public function ValueSorterLink()

    {
        $singleton = singleton("ProductAttributeValue");
        if (class_exists("DataObjectSorterController") && $singleton->hasExtension("DataObjectSorterDOD")) {
            return DataObjectSorterController::popup_link($className = "ProductAttributeValue", $filterField = "TypeChangeToId", $filterValue = "ID", $linkText = "Sort Values");
        }
    }
}


1			<?php
2
3			/**
4			* this class helps to create/edit/delete variations
5			*
6			*
7			*/
8
9			class CreateEcommerceVariations extends Controller
			0 ignored issues – show Coding Style Compatibility introduced 2017-01-03 01:10 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
10			{
11			private static $allowed_actions = array(
			0 ignored issues – show Comprehensibility introduced 2017-01-03 01:10 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-01-03 01:10 UTC by Report Bug Copy Issue Report The property `$allowed_actions` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
12			"jsonforform" => "ADMIN",
13			"createvariations",
14			"select",
15			"rename",
16			"add",
17			"remove",
18			"move",
19			'cansavevariation'
20			);
21
22			/**
23			* The selected Product (ID)
24			* @var Int
25			*/
26			protected $_productID = 0;
27
28			/**
29			* The select Product (Object)
30			* @var Product
31			*/
32			protected $_product = null;
33
34			/**
35			* type \| value
36			* @var String
37			*/
38			protected $_typeorvalue = "type"; // or value!

sunnysideup / silverstripe-ecommerce_product_variation

CreateEcommerceVariations_Field A last analyzed 2018-07-12 04:11 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like

CreateEcommerceVariations_Field A
last analyzed 2018-07-12 04:11 UTC