OrderAttribute_Group::i18n_singular_name() - Code Metrics - Inspection of "PATCH: searchresults cleanup" - sunnysideup/silverstripe-ecommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bccb03...5772ae )

by Nicolaas

created 2017-07-18 00:02 UTC

OrderAttribute_Group::i18n_singular_name() A

↳ Parent: OrderAttribute_Group

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php


/**
 * Allows you to group OrderAttributes.
 */
class OrderAttribute_Group extends DataObject implements EditableEcommerceObject
namespace YourVendor;

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

        'Name' => 'Varchar',
        'Sort' => 'Int',
    );

    /**
     * Standard SS variable.
     *
     * @var array
     */
    private static $indexes = array(

        'Sort' => true,
    );


    /**
     * standard SS variable.
     *
     * @Var String
     */
    private static $singular_name = 'Order Modifier Group';

    public function i18n_singular_name()

    {
        return $this->Config()->get('singular_name');
    }

    /**
     * standard SS variable.
     *
     * @Var String
     */
    private static $plural_name = 'Order Modifier Types';

    public function i18n_plural_name()

    {
        return $this->Config()->get('plural_name');
    }

    /**
     * Standard SS Method.
     *
     * @param Member $member

     *
     * @var bool
     */
    public function canCreate($member = null)
    {
        if (! $member) {
            $member = Member::currentUser();
        }
        $extended = $this->extendedCan(__FUNCTION__, $member);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ($extended !== null) {
            return $extended;
        }
        if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
            return true;
        }

        return parent::canEdit($member);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Standard SS Method.
     *
     * @param Member $member

     *
     * @var bool
     */
    public function canView($member = null)
    {
        if (! $member) {
            $member = Member::currentUser();
        }
        $extended = $this->extendedCan(__FUNCTION__, $member);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ($extended !== null) {
            return $extended;
        }
        if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
            return true;
        }

        return parent::canEdit($member);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Standard SS Method.
     *
     * @param Member $member

     *
     * @var bool
     */
    public function canEdit($member = null)
    {
        if (! $member) {
            $member = Member::currentUser();
        }
        $extended = $this->extendedCan(__FUNCTION__, $member);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ($extended !== null) {
            return $extended;
        }
        if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
            return true;
        }

        return parent::canEdit($member);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Standard SS Method.
     *
     * @param Member $member

     *
     * @var bool
     */
    public function canDelete($member = null)
    {
        if (! $member) {
            $member = Member::currentUser();
        }
        $extended = $this->extendedCan(__FUNCTION__, $member);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if ($extended !== null) {
            return $extended;
        }
        if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
            return true;
        }

        return parent::canEdit($member);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * link to edit the record.
     *
     * @param string | Null $action - e.g. edit
     *
     * @return string
     */
    public function CMSEditLink($action = null)
    {
        return CMSEditLinkAPI::find_edit_link_for_object($this, $action);
    }
}


1			<?php
2
3
4			/**
5			* Allows you to group OrderAttributes.
6			*/
7			class OrderAttribute_Group extends DataObject implements EditableEcommerceObject
			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...
8			{
9			private static $db = array(
			0 ignored issues – show Unused Code introduced 2016-10-31 23:06 UTC by Report Bug Copy Issue Report The property `$db` 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... Comprehensibility introduced 2016-12-20 03:49 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...
10			'Name' => 'Varchar',
11			'Sort' => 'Int',
12			);
13
14			/**
15			* Standard SS variable.
16			*
17			* @var array
18			*/
19			private static $indexes = array(
			0 ignored issues – show Unused Code introduced 2016-10-31 23:06 UTC by Report Bug Copy Issue Report The property `$indexes` 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... Comprehensibility introduced 2016-12-20 03:49 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...
20			'Sort' => true,
21			);
22
23
24			/**
25			* standard SS variable.
26			*
27			* @Var String
28			*/
29			private static $singular_name = 'Order Modifier Group';
			0 ignored issues – show Comprehensibility introduced 2016-12-20 03:49 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 2016-10-31 23:06 UTC by Report Bug Copy Issue Report The property `$singular_name` 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...
30			public function i18n_singular_name()
			0 ignored issues – show Documentation introduced 2017-07-17 03:35 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
31			{
32			return $this->Config()->get('singular_name');
33			}
34
35			/**
36			* standard SS variable.
37			*
38			* @Var String
39			*/
40			private static $plural_name = 'Order Modifier Types';
			0 ignored issues – show Comprehensibility introduced 2016-12-20 03:49 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 2016-10-31 23:06 UTC by Report Bug Copy Issue Report The property `$plural_name` 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...
41			public function i18n_plural_name()
			0 ignored issues – show Documentation introduced 2017-07-17 03:35 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
42			{
43			return $this->Config()->get('plural_name');
44			}
45
46			/**
47			* Standard SS Method.
48			*
49			* @param Member $member
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report Should the type for parameter `$member` not be `Member\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
50			*
51			* @var bool
52			*/
53			public function canCreate($member = null)
54			{
55			if (! $member) {
56			$member = Member::currentUser();
57			}
58			$extended = $this->extendedCan(__FUNCTION__, $member);
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report `$member` is of type `object<DataObject>\|null`, but the function expects a `object<Member>\|integer`. 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...
59			if ($extended !== null) {
60			return $extended;
61			}
62			if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
63			return true;
64			}
65
66			return parent::canEdit($member);
			0 ignored issues – show Bug introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report It seems like `$member` defined by `\Member::currentUser()` on line `56` can also be of type `object<DataObject>`; however, `DataObject::canEdit()` does only seem to accept `object<Member>\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history... Comprehensibility Bug introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`canEdit()` instead of `canCreate()`). Are you sure this is correct? If so, you might want to change this to `$this->canEdit()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
67			}
68
69			/**
70			* Standard SS Method.
71			*
72			* @param Member $member
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report Should the type for parameter `$member` not be `Member\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
73			*
74			* @var bool
75			*/
76			public function canView($member = null)
77			{
78			if (! $member) {
79			$member = Member::currentUser();
80			}
81			$extended = $this->extendedCan(__FUNCTION__, $member);
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report `$member` is of type `object<DataObject>\|null`, but the function expects a `object<Member>\|integer`. 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...
82			if ($extended !== null) {
83			return $extended;
84			}
85			if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
86			return true;
87			}
88
89			return parent::canEdit($member);
			0 ignored issues – show Bug introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report It seems like `$member` defined by `\Member::currentUser()` on line `79` can also be of type `object<DataObject>`; however, `DataObject::canEdit()` does only seem to accept `object<Member>\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history... Comprehensibility Bug introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`canEdit()` instead of `canView()`). Are you sure this is correct? If so, you might want to change this to `$this->canEdit()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
90			}
91
92			/**
93			* Standard SS Method.
94			*
95			* @param Member $member
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report Should the type for parameter `$member` not be `Member\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
96			*
97			* @var bool
98			*/
99			public function canEdit($member = null)
100			{
101			if (! $member) {
102			$member = Member::currentUser();
103			}
104			$extended = $this->extendedCan(__FUNCTION__, $member);
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report `$member` is of type `object<DataObject>\|null`, but the function expects a `object<Member>\|integer`. 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...
105			if ($extended !== null) {
106			return $extended;
107			}
108			if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
109			return true;
110			}
111
112			return parent::canEdit($member);
			0 ignored issues – show Bug introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report It seems like `$member` defined by `\Member::currentUser()` on line `102` can also be of type `object<DataObject>`; however, `DataObject::canEdit()` does only seem to accept `object<Member>\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
113			}
114
115			/**
116			* Standard SS Method.
117			*
118			* @param Member $member
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report Should the type for parameter `$member` not be `Member\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
119			*
120			* @var bool
121			*/
122			public function canDelete($member = null)
123			{
124			if (! $member) {
125			$member = Member::currentUser();
126			}
127			$extended = $this->extendedCan(__FUNCTION__, $member);
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report `$member` is of type `object<DataObject>\|null`, but the function expects a `object<Member>\|integer`. 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...
128			if ($extended !== null) {
129			return $extended;
130			}
131			if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) {
132			return true;
133			}
134
135			return parent::canEdit($member);
			0 ignored issues – show Bug introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report It seems like `$member` defined by `\Member::currentUser()` on line `125` can also be of type `object<DataObject>`; however, `DataObject::canEdit()` does only seem to accept `object<Member>\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history... Comprehensibility Bug introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`canEdit()` instead of `canDelete()`). Are you sure this is correct? If so, you might want to change this to `$this->canEdit()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
136			}
137
138			/**
139			* link to edit the record.
140			*
141			* @param string \| Null $action - e.g. edit
142			*
143			* @return string
144			*/
145			public function CMSEditLink($action = null)
146			{
147			return CMSEditLinkAPI::find_edit_link_for_object($this, $action);
148			}
149			}
150

sunnysideup / silverstripe-ecommerce

Push — master ( bccb03...5772ae )

OrderAttribute_Group::i18n_singular_name() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like