ModelAdminEcommerceBaseClass::getManagedModels() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/sunnys..." - sunnysideup/silverstripe-ecommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2eee10...777fce )

by Nicolaas

created 2017-03-15 02:15 UTC

ModelAdminEcommerceBaseClass::getManagedModels() B

↳ Parent: ModelAdminEcommerceBaseClass

Complexity

Conditions	5
Paths	6

Size

Total Lines	18
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	11
nc	6
nop	0
dl	0
loc	18
rs	8.8571
c	0
b	0
f	0

<?php

/**
 * @see: http://doc.silverstripe.org/framework/en/reference/ModelAdmin
 *
 * @author Nicolaas [at] sunnyside up . co .nz
 */
class ModelAdminEcommerceBaseClass extends ModelAdmin
namespace YourVendor;

class YourClass { }
{
    /**
     * @return array Map of class name to an array of 'title' (see {@link $managed_models})

     */
    public function getManagedModels()
    {
        if($this->class === 'ModelAdminEcommerceBaseClass') {
            return array();
        }
        $models = EcommerceConfig::get($this->class, 'managed_models');
        foreach ($models as $key => $model) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if (is_array($model)) {
                $model = $key;
            }
            if (!class_exists($model)) {
                unset($models[$key]);
            }
        }
        Config::inst()->update('ModelAdminEcommerceBaseClass', 'managed_models', $models);

        return parent::getManagedModels();
    }

    /**
     * Change this variable if you don't want the Import from CSV form to appear.
     * This variable can be a boolean or an array.
     * If array, you can list className you want the form to appear on. i.e. array('myClassOne','myClasstwo').
     */
    public $showImportForm = false;

    /**
     *
     * @param DataObject $record
     *
     * @return Form

     */
    function oneItemForm($record)

    {
        Config::inst()->update('LeftAndMain', 'tree_class', $record->ClassName);
        $form = LeftAndMain::getEditForm($record);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $idField = HiddenField::create('ID')->setValue($record->ID);
        $cssField = LiteralField::create(
            'oneItemFormCSS',
            '
                <style>
                    .cms-content-view .ui-tabs-nav {
                        margin-left: 0!important;
                    }
                    .cms-content-view .Actions {
                        position: fixed;
                        bottom: 16px;
                        right:  16px;
                    }
                </style>
            '
        );
        $form->Fields()->push($idField);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        $form->Fields()->push($cssField);
        return $form;
    }

    /**
     * Define which fields are used in the {@link getEditForm} GridField export.
     * By default, it uses the summary fields from the model definition.
     *
     * @return array
     */
    public function getExportFields() {
        $obj = singleton($this->modelClass);
        if($obj->hasMethod('getExportFields')) {
            return $obj->getExportFields();
        }
        return $obj->summaryFields();
    }


}


1			<?php
2
3			/**
4			* @see: http://doc.silverstripe.org/framework/en/reference/ModelAdmin
5			*
6			* @author Nicolaas [at] sunnyside up . co .nz
7			*/
8			class ModelAdminEcommerceBaseClass extends ModelAdmin
			0 ignored issues – show Coding Style Compatibility introduced 2016-12-20 03:49 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...
9			{
10			/**
11			* @return array Map of class name to an array of 'title' (see {@link $managed_models})
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report Should the return type not be `array\|integer\|double\|boolean`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
12			*/
13			public function getManagedModels()
14			{
15			if($this->class === 'ModelAdminEcommerceBaseClass') {
16			return array();
17			}
18			$models = EcommerceConfig::get($this->class, 'managed_models');
19			foreach ($models as $key => $model) {
			0 ignored issues – show Bug introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report The expression `$models` of type `array\|integer\|double\|string\|boolean` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
20			if (is_array($model)) {
21			$model = $key;
22			}
23			if (!class_exists($model)) {
24			unset($models[$key]);
25			}
26			}
27			Config::inst()->update('ModelAdminEcommerceBaseClass', 'managed_models', $models);
28
29			return parent::getManagedModels();
30			}
31
32			/**
33			* Change this variable if you don't want the Import from CSV form to appear.
34			* This variable can be a boolean or an array.
35			* If array, you can list className you want the form to appear on. i.e. array('myClassOne','myClasstwo').
36			*/
37			public $showImportForm = false;
38
39			/**
40			*
41			* @param DataObject $record
42			*
43			* @return Form
			0 ignored issues – show Documentation introduced 2017-02-10 01:26 UTC by Report Bug Copy Issue Report Should the return type not be `SS_HTTPResponse\|null\|CMSForm`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
44			*/
45			function oneItemForm($record)
			0 ignored issues – show Best Practice introduced 2017-02-10 01:26 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
46			{
47			Config::inst()->update('LeftAndMain', 'tree_class', $record->ClassName);
48			$form = LeftAndMain::getEditForm($record);
			0 ignored issues – show Documentation introduced 2017-02-10 01:26 UTC by Report Bug Copy Issue Report `$record` is of type `object<DataObject>`, but the function expects a `integer\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
49			$idField = HiddenField::create('ID')->setValue($record->ID);
50			$cssField = LiteralField::create(
51			'oneItemFormCSS',
52			'
53			<style>
54			.cms-content-view .ui-tabs-nav {
55			margin-left: 0!important;
56			}
57			.cms-content-view .Actions {
58			position: fixed;
59			bottom: 16px;
60			right: 16px;
61			}
62			</style>
63			'
64			);
65			$form->Fields()->push($idField);
			0 ignored issues – show Bug introduced 2017-02-10 01:26 UTC by Report Bug Copy Issue Report The method `Fields` does only exist in `CMSForm`, but not in `SS_HTTPResponse`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
66			$form->Fields()->push($cssField);
67			return $form;
68			}
69
70			/**
71			* Define which fields are used in the {@link getEditForm} GridField export.
72			* By default, it uses the summary fields from the model definition.
73			*
74			* @return array
75			*/
76			public function getExportFields() {
77			$obj = singleton($this->modelClass);
78			if($obj->hasMethod('getExportFields')) {
79			return $obj->getExportFields();
80			}
81			return $obj->summaryFields();
82			}
83
84
85			}
86

sunnysideup / silverstripe-ecommerce

Push — master ( 2eee10...777fce )

ModelAdminEcommerceBaseClass::getManagedModels() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like