EditableIPField - Code Metrics - Inspection of "Hidden IP Field" - silverstripe/silverstripe-userforms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#638)

unknown

created 2017-07-11 14:07 UTC

EditableIPField A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	20
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	2
lcom	1
cbo	2
dl	0
loc	20
ccs	0
cts	5
cp	0
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getSetsOwnError()	0	4	1
A	getFormField()	0	5	1

<?php
/**
 * EditableIPField
 *
 * Allows you to track the ip of the person filling in the form.
 *
 * @package userforms
 */

class EditableIPField extends EditableFormField
namespace YourVendor;

class YourClass { }
{

    private static $singular_name = 'IP Field';


    private static $plural_name = 'IP Fields';


    private static $has_placeholder = false;


    public function getSetsOwnError()
    {
        return true;
    }

    public function getFormField()
// 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);
    }
}
    {
        $field = HiddenField::create($this->Name, $this->EscapedTitle, $_SERVER['REMOTE_ADDR']);
<?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 $field;
    }
}


1			<?php
2			/**
3			* EditableIPField
4			*
5			* Allows you to track the ip of the person filling in the form.
6			*
7			* @package userforms
8			*/
9
10			class EditableIPField extends EditableFormField
			0 ignored issues – show Coding Style Compatibility introduced 2015-11-21 07:02 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...
11			{
12
13			private static $singular_name = 'IP Field';
			0 ignored issues – show Comprehensibility introduced 2015-11-21 07:02 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 2015-11-21 07:02 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...
14
15			private static $plural_name = 'IP Fields';
			0 ignored issues – show Comprehensibility introduced 2015-11-21 07:02 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 2015-11-21 07:02 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...
16
17			private static $has_placeholder = false;
			0 ignored issues – show Comprehensibility introduced 2017-04-25 12:00 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-04-25 12:00 UTC by Report Bug Copy Issue Report The property `$has_placeholder` 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...
18
19			public function getSetsOwnError()
20			{
21			return true;
22			}
23
24			public function getFormField()
			0 ignored issues – show Coding Style introduced 2017-07-11 14:21 UTC by Report Bug Copy Issue Report `getFormField` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // 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); } } Loading history...
25			{
26			$field = HiddenField::create($this->Name, $this->EscapedTitle, $_SERVER['REMOTE_ADDR']);
			0 ignored issues – show Documentation introduced 2017-07-11 14:21 UTC by Report Bug Copy Issue Report The property `EscapedTitle` does not exist on `object<EditableIPField>`. 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...
27			return $field;
28			}
29			}
30

silverstripe / silverstripe-userforms

Pull Request — master (#638)

EditableIPField A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Duplication Side-by-Side

Filter issues like