TimeZone::__construct() - Code Metrics - Inspection of "json serializable value objects" - nicolopignatelli/valueobjects - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#62)

by Adam

created 2016-04-20 15:58 UTC

TimeZone::__construct() A

↳ Parent: TimeZone

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	2
eloc	4
c	2
b	0
f	0
nc	2
nop	1
dl	0
loc	8
ccs	5
cts	5
cp	1
crap	2
rs	9.4285

<?php

namespace ValueObjects\DateTime;

use ValueObjects\DateTime\Exception\InvalidTimeZoneException;
use ValueObjects\StringLiteral\StringLiteral;
use ValueObjects\Util\Util;
use ValueObjects\ValueObjectInterface;

class TimeZone implements ValueObjectInterface
{
    /** @var StringLiteral */
    protected $name;

    /**
     * Returns a new Time object from native timezone name
     *
     * @param  string $name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return self
     */
    public static function fromNative()
    {
        $args = func_get_args();

        $name = new StringLiteral($args[0]);

        return new static($name);
    }

    /**
     * Returns a new Time from a native PHP \DateTime
     *
     * @param  \DateTimeZone $timezone
     * @return self
     */
    public static function fromNativeDateTimeZone(\DateTimeZone $timezone)
    {
        return static::fromNative($timezone->getName());
    }

    /**
     * Returns default TimeZone
     *
     * @return self
     */
    public static function fromDefault()
    {
        return new static(new StringLiteral(date_default_timezone_get()));
    }

    /**
     * Returns a new TimeZone object
     *
     * @param StringLiteral $name
     * @throws InvalidTimeZoneException
     */
    public function __construct(StringLiteral $name)
    {
        if (!in_array($name->toNative(), timezone_identifiers_list())) {
            throw new InvalidTimeZoneException($name);
        }

        $this->name = $name;
    }

    /**
     * Returns a native PHP \DateTimeZone version of the current TimeZone.
     *
     * @return \DateTimeZone
     */
    public function toNativeDateTimeZone()
    {
        return new \DateTimeZone($this->getName()->toNative());
    }

    /**
     * Tells whether two DateTimeZone are equal by comparing their names
     *
     * @param  ValueObjectInterface $timezone
     * @return bool
     */
    public function sameValueAs(ValueObjectInterface $timezone)
    {
        if (false === Util::classEquals($this, $timezone)) {
            return false;
        }

        return $this->getName()->sameValueAs($timezone->getName());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Returns timezone name
     *
     * @return String
     */
    public function getName()
    {
        return clone $this->name;
    }

    /**
     * Returns timezone name as string
     *
     * @return string
     */
    public function __toString()
    {
        return $this->getName()->__toString();
    }

    function jsonSerialize()

    {
        return (string) $this;
    }


}


1		<?php
2
3		namespace ValueObjects\DateTime;
4
5		use ValueObjects\DateTime\Exception\InvalidTimeZoneException;
6		use ValueObjects\StringLiteral\StringLiteral;
7		use ValueObjects\Util\Util;
8		use ValueObjects\ValueObjectInterface;
9
10		class TimeZone implements ValueObjectInterface
11		{
12		/** @var StringLiteral */
13		protected $name;
14
15		/**
16		* Returns a new Time object from native timezone name
17		*
18		* @param string $name
		0 ignored issues – show Bug introduced 2015-11-21 01:12 UTC by Report Bug Copy Issue Report There is no parameter named `$name`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
19		* @return self
20		*/
21	4	public static function fromNative()
22		{
23	4	$args = func_get_args();
24
25	4	$name = new StringLiteral($args[0]);
26
27	4	return new static($name);
28		}
29
30		/**
31		* Returns a new Time from a native PHP \DateTime
32		*
33		* @param \DateTimeZone $timezone
34		* @return self
35		*/
36	2	public static function fromNativeDateTimeZone(\DateTimeZone $timezone)
37		{
38	2	return static::fromNative($timezone->getName());
39		}
40
41		/**
42		* Returns default TimeZone
43		*
44		* @return self
45		*/
46	2	public static function fromDefault()
47		{
48	2	return new static(new StringLiteral(date_default_timezone_get()));
49		}
50
51		/**
52		* Returns a new TimeZone object
53		*
54		* @param StringLiteral $name
55		* @throws InvalidTimeZoneException
56		*/
57	17	public function __construct(StringLiteral $name)
58		{
59	17	if (!in_array($name->toNative(), timezone_identifiers_list())) {
60	1	throw new InvalidTimeZoneException($name);
61		}
62
63	16	$this->name = $name;
64	16	}
65
66		/**
67		* Returns a native PHP \DateTimeZone version of the current TimeZone.
68		*
69		* @return \DateTimeZone
70		*/
71	3	public function toNativeDateTimeZone()
72		{
73	3	return new \DateTimeZone($this->getName()->toNative());
74		}
75
76		/**
77		* Tells whether two DateTimeZone are equal by comparing their names
78		*
79		* @param ValueObjectInterface $timezone
80		* @return bool
81		*/
82	7	public function sameValueAs(ValueObjectInterface $timezone)
83		{
84	7	if (false === Util::classEquals($this, $timezone)) {
85	1	return false;
86		}
87
88	7	return $this->getName()->sameValueAs($timezone->getName());
		0 ignored issues – show Bug introduced 2015-11-21 01:12 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `ValueObjects\ValueObjectInterface` as the method `getName()` does only exist in the following implementations of said interface: `ValueObjects\DateTime\Month`, `ValueObjects\DateTime\TimeZone`, `ValueObjects\DateTime\WeekDay`, `ValueObjects\Enum\Enum`, `ValueObjects\Geography\Address`, `ValueObjects\Geography\Continent`, `ValueObjects\Geography\Country`, `ValueObjects\Geography\CountryCode`, `ValueObjects\Geography\DistanceFormula`, `ValueObjects\Geography\DistanceUnit`, `ValueObjects\Geography\Ellipsoid`, `ValueObjects\Geography\Street`, `ValueObjects\Money\CurrencyCode`, `ValueObjects\Number\RoundingMode`, `ValueObjects\Person\Gender`, `ValueObjects\Web\IPAddressVersion`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
89		}
90
91		/**
92		* Returns timezone name
93		*
94		* @return String
95		*/
96	15	public function getName()
97		{
98	15	return clone $this->name;
99		}
100
101		/**
102		* Returns timezone name as string
103		*
104		* @return string
105		*/
106	4	public function __toString()
107		{
108	4	return $this->getName()->__toString();
109		}
110
111		function jsonSerialize()
		0 ignored issues – show Best Practice introduced 2016-04-20 16:03 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... Comprehensibility Best Practice introduced 2016-04-20 16:03 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `jsonSerialize`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history...
112		{
113		return (string) $this;
114		}
115
116
117		}
118

nicolopignatelli / valueobjects

Pull Request — master (#62)

TimeZone::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like