XmlSchemaDateHandler::deserializeDateIntervalXml() - Code Metrics - Inspection of "Add serialize and deserialize timezone shifting su..." - goetas-webservices/xsd2php-runtime - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#9)

unknown

created 2019-04-04 10:39 UTC

XmlSchemaDateHandler::deserializeDateIntervalXml() A

↳ Parent: XmlSchemaDateHandler

Complexity

Conditions	3
Paths	2

Size

Total Lines

Duplication

Lines	7
Ratio	100 %

Code Coverage

Tests	2
CRAP Score	3

Importance

Changes

Metric	Value
dl	7
loc	7
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	3
nc	2
nop	3
crap	3

<?php
namespace GoetasWebservices\Xsd\XsdToPhpRuntime\Jms\Handler;

use JMS\Serializer\Context;
use JMS\Serializer\GraphNavigator;
use JMS\Serializer\Handler\SubscribingHandlerInterface;
use JMS\Serializer\XmlDeserializationVisitor;
use JMS\Serializer\XmlSerializationVisitor;
use RuntimeException;

class XmlSchemaDateHandler implements SubscribingHandlerInterface
{

    protected $defaultTimezone;
    protected $serializeTimezone;
    protected $deserializeTimezone;

    public static function getSubscribingMethods()
    {
        return array(
            array(
                'direction' => GraphNavigator::DIRECTION_DESERIALIZATION,
                'format' => 'xml',
                'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\Date',
                'method' => 'deserializeDate'
            ),
            array(
                'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
                'format' => 'xml',
                'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\Date',
                'method' => 'serializeDate'
            ),
            array(
                'direction' => GraphNavigator::DIRECTION_DESERIALIZATION,
                'format' => 'xml',
                'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\DateTime',
                'method' => 'deserializeDateTime'
            ),
            array(
                'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
                'format' => 'xml',
                'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\DateTime',
                'method' => 'serializeDateTime'
            ),
            array(
                'direction' => GraphNavigator::DIRECTION_DESERIALIZATION,
                'format' => 'xml',
                'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\Time',
                'method' => 'deserializeTime'
            ),
            array(
                'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
                'format' => 'xml',
                'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\Time',
                'method' => 'serializeTime'
            ),
            array(
                'type' => 'DateInterval',
                'direction' => GraphNavigator::DIRECTION_DESERIALIZATION,
                'format' => 'xml',
                'method' => 'deserializeDateIntervalXml',
            ),
        );
    }

    /**
     * @param string $defaultTimezone default timezone if timezone is absent in deserialized string
     * @param null $serializeTimezone timezone of serialized date/datetime/time. Works properly since php 7.0
     * @param null $deserializeTimezone timezone of deserialized date/datetime/time. Works properly since php 7.0
     *                                  note that $defaultTimezone may be applied first
     */
    public function __construct($defaultTimezone = 'UTC', $serializeTimezone = null, $deserializeTimezone = null)
    {
        $this->defaultTimezone = new \DateTimeZone($defaultTimezone);
        $this->serializeTimezone = $serializeTimezone ? new \DateTimeZone($serializeTimezone) : null;
        $this->deserializeTimezone = $deserializeTimezone ? new \DateTimeZone($deserializeTimezone) : null;
    }

    public function deserializeDateIntervalXml(XmlDeserializationVisitor $visitor, $data, array $type){

        $attributes = $data->attributes('xsi', true);
        if (isset($attributes['nil'][0]) && (string) $attributes['nil'][0] === 'true') {
            return null;
        }
        return new \DateInterval((string)$data);
    }

    public function serializeDate(XmlSerializationVisitor $visitor, \DateTime $date, array $type, Context $context)

    {
        $date = $this->prepareDateTimeBeforeSerialize($date);
        $v = $date->format('Y-m-d');

        return $visitor->visitSimpleString($v, $type, $context);

    }

    public function deserializeDate(XmlDeserializationVisitor $visitor, $data, array $type)

    {
        $attributes = $data->attributes('xsi', true);
        if (isset($attributes['nil'][0]) && (string)$attributes['nil'][0] === 'true') {
            return null;
        }
        if (!preg_match('/^(\d{4})-(\d{2})-(\d{2})(Z|([+-]\d{2}:\d{2}))?$/', $data)) {
            throw new RuntimeException(sprintf('Invalid date "%s", expected valid XML Schema date string.', $data));
        }

        return $this->parseDateTime($data, $type);
    }

    public function serializeDateTime(XmlSerializationVisitor $visitor, \DateTime $date, array $type, Context $context)

    {
        $date = $this->prepareDateTimeBeforeSerialize($date);
        $v = $date->format(\DateTime::W3C);

        return $visitor->visitSimpleString($v, $type, $context);

    }

    public function deserializeDateTime(XmlDeserializationVisitor $visitor, $data, array $type)

    {
        $attributes = $data->attributes('xsi', true);
        if (isset($attributes['nil'][0]) && (string)$attributes['nil'][0] === 'true') {
            return null;
        }

        return $this->parseDateTime($data, $type);

    }

    public function serializeTime(XmlSerializationVisitor $visitor, \DateTime $date, array $type, Context $context)
    {
        $date = $this->prepareDateTimeBeforeSerialize($date);
        $v = $date->format('H:i:s');
        if ($date->getTimezone()->getOffset($date) !== $this->defaultTimezone->getOffset($date)) {
            $v .= $date->format('P');
        }
        return $visitor->visitSimpleString($v, $type, $context);

    }

    public function deserializeTime(XmlDeserializationVisitor $visitor, $data, array $type)

    {
        $attributes = $data->attributes('xsi', true);
        if (isset($attributes['nil'][0]) && (string)$attributes['nil'][0] === 'true') {
            return null;
        }

        if ($this->deserializeTimezone) {
            return $this->parseDateTime($data, $type);
        }

        $data = (string)$data;

        return new \DateTime($data, $this->defaultTimezone);
    }

    private function parseDateTime($data, array $type)
    {
        $timezone = isset($type['params'][1]) ? new \DateTimeZone($type['params'][1]) : $this->defaultTimezone;
        $datetime = new \DateTime((string)$data, $timezone);
        if (false === $datetime) {
            throw new RuntimeException(sprintf('Invalid datetime "%s", expected valid XML Schema dateTime string.', $data));
        }

        if ($this->deserializeTimezone) {
            $datetime->setTimezone($this->deserializeTimezone);
        }

        return $datetime;
    }

    private function prepareDateTimeBeforeSerialize(\DateTime $date)
    {
        if ($this->serializeTimezone) {
            $dateCopy = clone $date;
            $dateCopy->setTimezone($this->serializeTimezone);
            return $dateCopy;
        }

        return $date;
    }
}



1			<?php
2			namespace GoetasWebservices\Xsd\XsdToPhpRuntime\Jms\Handler;
3
4			use JMS\Serializer\Context;
5			use JMS\Serializer\GraphNavigator;
6			use JMS\Serializer\Handler\SubscribingHandlerInterface;
7			use JMS\Serializer\XmlDeserializationVisitor;
8			use JMS\Serializer\XmlSerializationVisitor;
9			use RuntimeException;
10
11			class XmlSchemaDateHandler implements SubscribingHandlerInterface
12			{
13
14			protected $defaultTimezone;
15			protected $serializeTimezone;
16			protected $deserializeTimezone;
17
18			public static function getSubscribingMethods()
19			{
20			return array(
21			array(
22			'direction' => GraphNavigator::DIRECTION_DESERIALIZATION,
23			'format' => 'xml',
24			'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\Date',
25			'method' => 'deserializeDate'
26			),
27			array(
28			'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
29			'format' => 'xml',
30			'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\Date',
31			'method' => 'serializeDate'
32			),
33			array(
34			'direction' => GraphNavigator::DIRECTION_DESERIALIZATION,
35			'format' => 'xml',
36			'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\DateTime',
37			'method' => 'deserializeDateTime'
38			),
39			array(
40			'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
41			'format' => 'xml',
42			'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\DateTime',
43			'method' => 'serializeDateTime'
44			),
45			array(
46			'direction' => GraphNavigator::DIRECTION_DESERIALIZATION,
47			'format' => 'xml',
48			'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\Time',
49			'method' => 'deserializeTime'
50			),
51			array(
52			'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
53			'format' => 'xml',
54			'type' => 'GoetasWebservices\Xsd\XsdToPhp\XMLSchema\Time',
55			'method' => 'serializeTime'
56			),
57			array(
58			'type' => 'DateInterval',
59			'direction' => GraphNavigator::DIRECTION_DESERIALIZATION,
60			'format' => 'xml',
61			'method' => 'deserializeDateIntervalXml',
62			),
63			);
64	17		}
65
66	17		/**
67			* @param string $defaultTimezone default timezone if timezone is absent in deserialized string
68	17		* @param null $serializeTimezone timezone of serialized date/datetime/time. Works properly since php 7.0
69			* @param null $deserializeTimezone timezone of deserialized date/datetime/time. Works properly since php 7.0
70			* note that $defaultTimezone may be applied first
71			*/
72			public function __construct($defaultTimezone = 'UTC', $serializeTimezone = null, $deserializeTimezone = null)
73			{
74			$this->defaultTimezone = new \DateTimeZone($defaultTimezone);
75			$this->serializeTimezone = $serializeTimezone ? new \DateTimeZone($serializeTimezone) : null;
76			$this->deserializeTimezone = $deserializeTimezone ? new \DateTimeZone($deserializeTimezone) : null;
77			}
78	5
79		View Code Duplication	public function deserializeDateIntervalXml(XmlDeserializationVisitor $visitor, $data, array $type){
			0 ignored issues – show Unused Code introduced 2018-01-28 22:03 UTC by Report Bug Copy Issue Report The parameter `$visitor` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2018-01-28 22:03 UTC by Report Bug Copy Issue Report The parameter `$type` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2018-03-16 09:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
80			$attributes = $data->attributes('xsi', true);
81	5		if (isset($attributes['nil'][0]) && (string) $attributes['nil'][0] === 'true') {
82			return null;
83	5		}
84			return new \DateInterval((string)$data);
85			}
86	5
87		View Code Duplication	public function serializeDate(XmlSerializationVisitor $visitor, \DateTime $date, array $type, Context $context)
			0 ignored issues – show Duplication introduced 2019-03-15 13:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
88	5		{
89	5		$date = $this->prepareDateTimeBeforeSerialize($date);
90			$v = $date->format('Y-m-d');
91
92	5		return $visitor->visitSimpleString($v, $type, $context);
			0 ignored issues – show Unused Code introduced 2018-11-18 09:28 UTC by Report Bug Copy Issue Report The call to `XmlSerializationVisitor::visitSimpleString()` has too many arguments starting with `$context`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
93	1		}
94
95			public function deserializeDate(XmlDeserializationVisitor $visitor, $data, array $type)
			0 ignored issues – show Unused Code introduced 2018-01-28 22:03 UTC by Report Bug Copy Issue Report The parameter `$visitor` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
96	4		{
97			$attributes = $data->attributes('xsi', true);
98			if (isset($attributes['nil'][0]) && (string)$attributes['nil'][0] === 'true') {
99	7		return null;
100			}
101			if (!preg_match('/^(\d{4})-(\d{2})-(\d{2})(Z\|([+-]\d{2}:\d{2}))?$/', $data)) {
102	7		throw new RuntimeException(sprintf('Invalid date "%s", expected valid XML Schema date string.', $data));
103			}
104	7
105			return $this->parseDateTime($data, $type);
106			}
107
108		View Code Duplication	public function serializeDateTime(XmlSerializationVisitor $visitor, \DateTime $date, array $type, Context $context)
			0 ignored issues – show Duplication introduced 2019-03-15 13:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
109			{
110			$date = $this->prepareDateTimeBeforeSerialize($date);
111			$v = $date->format(\DateTime::W3C);
112
113			return $visitor->visitSimpleString($v, $type, $context);
			0 ignored issues – show Unused Code introduced 2018-11-18 09:28 UTC by Report Bug Copy Issue Report The call to `XmlSerializationVisitor::visitSimpleString()` has too many arguments starting with `$context`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
114			}
115
116		View Code Duplication	public function deserializeDateTime(XmlDeserializationVisitor $visitor, $data, array $type)
			0 ignored issues – show Unused Code introduced 2018-01-28 22:03 UTC by Report Bug Copy Issue Report The parameter `$visitor` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2018-01-28 22:03 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
117			{
118			$attributes = $data->attributes('xsi', true);
119			if (isset($attributes['nil'][0]) && (string)$attributes['nil'][0] === 'true') {
120			return null;
121			}
122
123			return $this->parseDateTime($data, $type);
124
125			}
126
127			public function serializeTime(XmlSerializationVisitor $visitor, \DateTime $date, array $type, Context $context)
128			{
129			$date = $this->prepareDateTimeBeforeSerialize($date);
130			$v = $date->format('H:i:s');
131			if ($date->getTimezone()->getOffset($date) !== $this->defaultTimezone->getOffset($date)) {
132			$v .= $date->format('P');
133			}
134			return $visitor->visitSimpleString($v, $type, $context);
			0 ignored issues – show Unused Code introduced 2018-11-18 09:28 UTC by Report Bug Copy Issue Report The call to `XmlSerializationVisitor::visitSimpleString()` has too many arguments starting with `$context`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
135			}
136
137			public function deserializeTime(XmlDeserializationVisitor $visitor, $data, array $type)
			0 ignored issues – show Unused Code introduced 2018-01-28 22:03 UTC by Report Bug Copy Issue Report The parameter `$visitor` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
138			{
139	4		$attributes = $data->attributes('xsi', true);
140			if (isset($attributes['nil'][0]) && (string)$attributes['nil'][0] === 'true') {
141	4		return null;
142	4		}
143	4
144			if ($this->deserializeTimezone) {
145			return $this->parseDateTime($data, $type);
146			}
147	4
148			$data = (string)$data;
149
150			return new \DateTime($data, $this->defaultTimezone);
151			}
152
153			private function parseDateTime($data, array $type)
154			{
155			$timezone = isset($type['params'][1]) ? new \DateTimeZone($type['params'][1]) : $this->defaultTimezone;
156			$datetime = new \DateTime((string)$data, $timezone);
157			if (false === $datetime) {
158			throw new RuntimeException(sprintf('Invalid datetime "%s", expected valid XML Schema dateTime string.', $data));
159			}
160
161			if ($this->deserializeTimezone) {
162			$datetime->setTimezone($this->deserializeTimezone);
163			}
164
165			return $datetime;
166			}
167
168			private function prepareDateTimeBeforeSerialize(\DateTime $date)
169			{
170			if ($this->serializeTimezone) {
171			$dateCopy = clone $date;
172			$dateCopy->setTimezone($this->serializeTimezone);
173			return $dateCopy;
174			}
175
176			return $date;
177			}
178			}
179
180

goetas-webservices / xsd2php-runtime

Pull Request — master (#9)

XmlSchemaDateHandler::deserializeDateIntervalXml() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like