ShippingMethod - Code Metrics - Inspection of "ShippingMethod should now define requiresAddress...." - silvershop/silvershop-shipping - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dd0de2...7f19c4 )

by Roman

created 2017-07-18 08:10 UTC

ShippingMethod A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

Metric	Value
wmc	5
lcom	0
cbo	2
dl	0
loc	49
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	getCalculator()	4	1
A	calculateRate()	4	1
A	getRate()	4	1
A	getTitle()	11	1
A	requiresAddress()	4	1

<?php

/**
 * ShippingMethod is a base class for providing shipping options to customers.
 *
 * @package silvershop-shipping
 */
class ShippingMethod extends DataObject
{
    private static $db = array(

        "Name" => "Varchar",
        "Description" => "Text",
        "Enabled" => "Boolean"
    );

    private static $casting = array(

        'Rate' => 'Currency'
    );

    public function getCalculator(Order $order)
    {
        return new ShippingCalculator($this, $order);
    }

    public function calculateRate(ShippingPackage $package, Address $address)
    {
        return null;
    }

    public function getRate()
    {
        return $this->CalculatedRate;
<?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.");
        }
    }

}
    }

    public function getTitle()
    {
        $title = implode(" - ", array_filter(array(
            $this->Rate,
<?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.");
        }
    }

}
            $this->Name,
<?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.");
        }
    }

}
            $this->Description
<?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.");
        }
    }

}
        )));

        $this->extend('updateTitle', $title);
        return $title;
    }

    /**
     * Some shipping methods might require an address present on the order.
     *
     * @return bool
     */
    public function requiresAddress()
    {
        return false;
    }
}

/**
 * Helper class for encapsulating shipping calculation logic.
 */
class ShippingCalculator
{
    protected $method;
    protected $order;

    public function __construct(ShippingMethod $method, Order $order)
    {
        $this->method = $method;
        $this->order = $order;
    }

    public function calculate($address = null)
    {
        return $this->method->calculateRate(
            $this->order->createShippingPackage(),
            $address ? $address : $this->order->getShippingAddress()
        );
    }
}


1			<?php
2
3			/**
4			* ShippingMethod is a base class for providing shipping options to customers.
5			*
6			* @package silvershop-shipping
7			*/
8			class ShippingMethod extends DataObject
9			{
10			private static $db = array(
			0 ignored issues – show Comprehensibility introduced 2016-03-01 01:25 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...
11			"Name" => "Varchar",
12			"Description" => "Text",
13			"Enabled" => "Boolean"
14			);
15
16			private static $casting = array(
			0 ignored issues – show Comprehensibility introduced 2016-03-01 01:25 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...
17			'Rate' => 'Currency'
18			);
19
20			public function getCalculator(Order $order)
21			{
22			return new ShippingCalculator($this, $order);
23			}
24
25			public function calculateRate(ShippingPackage $package, Address $address)
26			{
27			return null;
28			}
29
30			public function getRate()
31			{
32			return $this->CalculatedRate;
			0 ignored issues – show Documentation introduced 2016-03-01 01:25 UTC by Report Bug Copy Issue Report The property `CalculatedRate` does not exist on `object<ShippingMethod>`. 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...
33			}
34
35			public function getTitle()
36			{
37			$title = implode(" - ", array_filter(array(
38			$this->Rate,
			0 ignored issues – show Documentation introduced 2016-03-01 01:25 UTC by Report Bug Copy Issue Report The property `Rate` does not exist on `object<ShippingMethod>`. 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...
39			$this->Name,
			0 ignored issues – show Documentation introduced 2016-03-01 01:25 UTC by Report Bug Copy Issue Report The property `Name` does not exist on `object<ShippingMethod>`. 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...
40			$this->Description
			0 ignored issues – show Documentation introduced 2016-03-01 01:25 UTC by Report Bug Copy Issue Report The property `Description` does not exist on `object<ShippingMethod>`. 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...
41			)));
42
43			$this->extend('updateTitle', $title);
44			return $title;
45			}
46
47			/**
48			* Some shipping methods might require an address present on the order.
49			*
50			* @return bool
51			*/
52			public function requiresAddress()
53			{
54			return false;
55			}
56			}
57
58			/**
59			* Helper class for encapsulating shipping calculation logic.
60			*/
61			class ShippingCalculator
62			{
63			protected $method;
64			protected $order;
65
66			public function __construct(ShippingMethod $method, Order $order)
67			{
68			$this->method = $method;
69			$this->order = $order;
70			}
71
72			public function calculate($address = null)
73			{
74			return $this->method->calculateRate(
75			$this->order->createShippingPackage(),
76			$address ? $address : $this->order->getShippingAddress()
77			);
78			}
79			}
80

silvershop / silvershop-shipping

Push — master ( dd0de2...7f19c4 )

ShippingMethod A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like