SearchHistory::i18n_singular_name() - 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 ( 3a7943...bccb03 )

by Nicolaas

created 2017-07-17 03:32 UTC

SearchHistory::i18n_singular_name() A

↳ Parent: SearchHistory

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

class SearchHistory extends DataObject
namespace YourVendor;

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

        'Title' => 'Varchar(255)',
        'ProductCount' => 'Int',
        'GroupCount' => 'Int',
    );

    private static $default_sort = '"Created" DESC';


    private static $searchable_fields = array(

        'Title' => 'PartialMatchFilter',
        'ProductCount' => 'GreaterThanOrEqualFilter',
        'GroupCount' => 'GreaterThanOrEqualFilter',
    );

    private static $summary_fields = array(

        'Created' => 'When',
        'Title' => 'Keyword',
        'ProductCount' => 'Products Found',
        'GroupCount' => 'Categories Found',
    );


    /**
     * standard SS variable.
     *
     * @Var String
     */
    private static $singular_name = 'Search History Entry';

    public function i18n_singular_name()

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

    /**
     * standard SS variable.
     *
     * @Var String
     */
    private static $plural_name = 'Search History Entries';

    public function i18n_plural_name()

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

    /**
     * creates a new entry if you are not a shop admin.
     *
     * @param string $keywordString
     *
     * @return int
     */
    public static function add_entry($keywordString, $productCount = 0, $groupCount = 0)
    {
        if ($member = Member::currentUser()) {
            if ($member->IsShopAdmin()) {
                return -1;
            }
        }
        $obj = new self();
        $obj->Title = $keywordString;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $obj->ProductCount = $productCount;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $obj->GroupCount = $groupCount;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        return $obj->write();
    }

    /**
     * remove excessive spaces.
     */
    public function onBeforeWrite()
    {
        $this->Title = trim(preg_replace('!\s+!', ' ', $this->Title));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        parent::onBeforeWrite();
    }

    /**
     * standard SS method.
     *
     * @param Member $member

     *
     * @return bool
     */
    public function canCreate($member = null)
    {
        return false;
    }

    /**
     * standard SS method.
     *
     * @param Member $member

     *
     * @return 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

     *
     * @return bool
     */
    public function canEdit($member = null)
    {
        return false;
    }

    /**
     * standard SS method.
     *
     * @param Member $member

     *
     * @return bool
     */
    public function canDelete($member = null)
    {
        return false;
    }
}


1			<?php
2
3			class SearchHistory extends DataObject
			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...
4			{
5			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...
6			'Title' => 'Varchar(255)',
7			'ProductCount' => 'Int',
8			'GroupCount' => 'Int',
9			);
10
11			private static $default_sort = '"Created" DESC';
			0 ignored issues – show Unused Code introduced 2016-10-31 23:06 UTC by Report Bug Copy Issue Report The property `$default_sort` 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...
12
13			private static $searchable_fields = array(
			0 ignored issues – show Unused Code introduced 2016-10-31 23:06 UTC by Report Bug Copy Issue Report The property `$searchable_fields` 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...
14			'Title' => 'PartialMatchFilter',
15			'ProductCount' => 'GreaterThanOrEqualFilter',
16			'GroupCount' => 'GreaterThanOrEqualFilter',
17			);
18
19			private static $summary_fields = array(
			0 ignored issues – show Unused Code introduced 2016-10-31 23:06 UTC by Report Bug Copy Issue Report The property `$summary_fields` 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			'Created' => 'When',
21			'Title' => 'Keyword',
22			'ProductCount' => 'Products Found',
23			'GroupCount' => 'Categories Found',
24			);
25
26
27			/**
28			* standard SS variable.
29			*
30			* @Var String
31			*/
32			private static $singular_name = 'Search History Entry';
			0 ignored issues – show Comprehensibility introduced 2017-07-17 03:35 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-07-17 03:35 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...
33			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...
34			{
35			return $this->Config()->get('singular_name');
36			}
37
38			/**
39			* standard SS variable.
40			*
41			* @Var String
42			*/
43			private static $plural_name = 'Search History Entries';
			0 ignored issues – show Comprehensibility introduced 2017-07-17 03:35 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-07-17 03:35 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...
44			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...
45			{
46			return $this->Config()->get('plural_name');
47			}
48
49			/**
50			* creates a new entry if you are not a shop admin.
51			*
52			* @param string $keywordString
53			*
54			* @return int
55			*/
56			public static function add_entry($keywordString, $productCount = 0, $groupCount = 0)
57			{
58			if ($member = Member::currentUser()) {
59			if ($member->IsShopAdmin()) {
60			return -1;
61			}
62			}
63			$obj = new self();
64			$obj->Title = $keywordString;
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<SearchHistory>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
65			$obj->ProductCount = $productCount;
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report The property `ProductCount` does not exist on `object<SearchHistory>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
66			$obj->GroupCount = $groupCount;
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report The property `GroupCount` does not exist on `object<SearchHistory>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
67
68			return $obj->write();
69			}
70
71			/**
72			* remove excessive spaces.
73			*/
74			public function onBeforeWrite()
75			{
76			$this->Title = trim(preg_replace('!\s+!', ' ', $this->Title));
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<SearchHistory>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<SearchHistory>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
77			parent::onBeforeWrite();
78			}
79
80			/**
81			* standard SS method.
82			*
83			* @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...
84			*
85			* @return bool
86			*/
87			public function canCreate($member = null)
88			{
89			return false;
90			}
91
92			/**
93			* standard SS method.
94			*
95			* @param Member $member
			0 ignored issues – show Documentation introduced 2017-02-02 07:40 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			* @return bool
			0 ignored issues – show Documentation introduced 2016-12-20 03:49 UTC by Report Bug Copy Issue Report Should the return type not be `boolean\|string\|null`? 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...
98			*/
99			public function canView($member = null)
100			{
101			if (! $member) {
102			$member = Member::currentUser();
103			}
104			$extended = $this->extendedCan(__FUNCTION__, $member);
			0 ignored issues – show Documentation introduced 2017-02-10 01:26 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... 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...
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			* @return bool
121			*/
122			public function canEdit($member = null)
123			{
124			return false;
125			}
126
127			/**
128			* standard SS method.
129			*
130			* @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...
131			*
132			* @return bool
133			*/
134			public function canDelete($member = null)
135			{
136			return false;
137			}
138			}
139

sunnysideup / silverstripe-ecommerce

Push — master ( 3a7943...bccb03 )

SearchHistory::i18n_singular_name() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like