DateTimeBuilder::resetFeedTimezone() - Code Metrics - Inspection of "Issue/136" - alexdebril/feed-io - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — project/php-7 (#141)

by Alex

created 2017-08-16 08:41 UTC

DateTimeBuilder::resetFeedTimezone() A

↳ Parent: DateTimeBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php declare(strict_types=1);
/*
 * This file is part of the feed-io package.
 *
 * (c) Alexandre Debril <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FeedIo\Rule;

use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

class DateTimeBuilder
{
    /**
     * Supported date formats
     * @var array
     */
    protected $dateFormats = [
        \DateTime::RFC2822,
        \DateTime::ATOM,
        \DateTime::RFC3339,
        \DateTime::RSS,
        \DateTime::W3C,
        'Y-m-d\TH:i:s.uP',
        'Y-m-d\TH:i:s',
        'Y-m-d',
        'd/m/Y',
        'D, d M Y H:i O',
        'D, d M Y H:i:s O',
        'D M d Y H:i:s e',
        '*, m#d#Y - H:i',
    ];

    /**
     * @var \DateTimeZone
     */
    protected $feedTimezone;

    /**
     * @var \DateTimeZone
     */
    protected $serverTimezone;

    /**
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * @var string
     */
    protected $lastGuessedFormat = \DateTime::RFC2822;

    /**
     * @param \Psr\Log\LoggerInterface        $logger
     */
    public function __construct(LoggerInterface $logger = null)
    {
        if (is_null($logger)) {
            $logger = new NullLogger;
        }
        $this->logger = $logger;
        $this->setTimezone(new \DateTimeZone(date_default_timezone_get()));
    }

    /**
     * @param $dateFormat
     * @return DateTimeBuilder
     */
    public function addDateFormat(string $dateFormat) : DateTimeBuilder
    {
        $this->dateFormats[] = $dateFormat;

        return $this;
    }

    /**
     * @param  array $dateFormats
     * @return $this
     */
    public function setDateFormats(array $dateFormats) : DateTimeBuilder
    {
        $this->dateFormats = $dateFormats;

        return $this;
    }

    /**
     * @return string
     */
    public function getLastGuessedFormat() : string
    {
        return $this->lastGuessedFormat;
    }

    /**
     * Tries to guess the date's format from the list
     * @param  string                   $date
     * @return string|null             date Format
     */
    public function guessDateFormat(string $date) : ? string
    {
        foreach ($this->dateFormats as $format) {
            $test = \DateTime::createFromFormat($format, $date);
            if ($test instanceof \DateTime) {
                $this->lastGuessedFormat = $format;

                return $format;
            }
        }

        return null;
    }

    /**
     * Creates a DateTime instance for the given string. Default format is RFC2822
     * @param  string                   $string
     * @return \DateTime
     */
    public function convertToDateTime(string $string) : \DateTime
    {
        $string = trim($string);
        foreach ([$this->getLastGuessedFormat(), $this->guessDateFormat($string) ] as $format) {
            $date = $this->newDate((string) $format, $string);
            if ($date instanceof \DateTime) {
                $date->setTimezone($this->getTimezone());

                return $date;
            }
        }

        return $this->stringToDateTime($string);
    }

    /**
     * Creates a DateTime instance for the given string if the format was not catch from the list
     * @param  string                   $string
     * @return \DateTime
     * @throws InvalidArgumentException
     */
    public function stringToDateTime(string $string) : \DateTime
    {
        $this->logger->notice("unsupported date format, use strtotime() to build the DateTime instance : {$string}");

        if (false === strtotime($string)) {
            throw new \InvalidArgumentException('Impossible to convert date : '.$string);
        }
        $date = new \DateTime($string, $this->getFeedTimezone());
        $date->setTimezone($this->getTimezone());

        return $date;
    }

    /**
     * @return \DateTimeZone
     */
    public function getFeedTimezone() : ? \DateTimeZone
    {
        return $this->feedTimezone;
    }

    /**
     * Specifies the feed's timezone. Do this it the timezone is missing
     *
     * @param \DateTimeZone $timezone
     */
    public function setFeedTimezone(\DateTimeZone $timezone) : void
    {
        $this->feedTimezone = $timezone;
    }

    /**
     * Resets feedTimezone to null.
     */
    public function resetFeedTimezone() : void
    {
        $this->feedTimezone = null;
    }

    /**
     * @return \DateTimeZone
     */
    public function getServerTimezone() : ? \DateTimeZone
    {
        return $this->serverTimezone;
    }

    /**
     * @param \DateTimeZone $timezone
     */
    public function setServerTimezone(\DateTimeZone $timezone) : void
    {
        $this->serverTimezone = $timezone;
    }

    /**
     * @return \DateTimeZone
     */
    public function getTimezone() : ? \DateTimeZone
    {
        return $this->getServerTimezone();
    }

    /**
     * @param \DateTimeZone $timezone
     */
    public function setTimezone(\DateTimeZone $timezone) : void
    {
        $this->setServerTimezone($timezone);
    }


    /**
     * @param $format
     * @param $string
     * @return \DateTime
     */
    protected function newDate(string $format, string $string)
    {
        if (!! $this->getFeedTimezone()) {
            return \DateTime::createFromFormat($format, $string, $this->getFeedTimezone());

        }

        return \DateTime::createFromFormat($format, $string);

    }
}


1		<?php declare(strict_types=1);
2		/*
3		* This file is part of the feed-io package.
4		*
5		* (c) Alexandre Debril <[email protected]>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace FeedIo\Rule;
12
13		use Psr\Log\LoggerInterface;
14		use Psr\Log\NullLogger;
15
16		class DateTimeBuilder
17		{
18		/**
19		* Supported date formats
20		* @var array
21		*/
22		protected $dateFormats = [
23		\DateTime::RFC2822,
24		\DateTime::ATOM,
25		\DateTime::RFC3339,
26		\DateTime::RSS,
27		\DateTime::W3C,
28		'Y-m-d\TH:i:s.uP',
29		'Y-m-d\TH:i:s',
30		'Y-m-d',
31		'd/m/Y',
32		'D, d M Y H:i O',
33		'D, d M Y H:i:s O',
34		'D M d Y H:i:s e',
35		'*, m#d#Y - H:i',
36		];
37
38		/**
39		* @var \DateTimeZone
40		*/
41		protected $feedTimezone;
42
43		/**
44		* @var \DateTimeZone
45		*/
46		protected $serverTimezone;
47
48		/**
49		* @var LoggerInterface
50		*/
51		protected $logger;
52
53		/**
54		* @var string
55		*/
56		protected $lastGuessedFormat = \DateTime::RFC2822;
57
58		/**
59		* @param \Psr\Log\LoggerInterface $logger
60		*/
61	69	public function __construct(LoggerInterface $logger = null)
62		{
63	69	if (is_null($logger)) {
64	62	$logger = new NullLogger;
65		}
66	69	$this->logger = $logger;
67	69	$this->setTimezone(new \DateTimeZone(date_default_timezone_get()));
68	69	}
69
70		/**
71		* @param $dateFormat
72		* @return DateTimeBuilder
73		*/
74	24	public function addDateFormat(string $dateFormat) : DateTimeBuilder
75		{
76	24	$this->dateFormats[] = $dateFormat;
77
78	24	return $this;
79		}
80
81		/**
82		* @param array $dateFormats
83		* @return $this
84		*/
85	3	public function setDateFormats(array $dateFormats) : DateTimeBuilder
86		{
87	3	$this->dateFormats = $dateFormats;
88
89	3	return $this;
90		}
91
92		/**
93		* @return string
94		*/
95	10	public function getLastGuessedFormat() : string
96		{
97	10	return $this->lastGuessedFormat;
98		}
99
100		/**
101		* Tries to guess the date's format from the list
102		* @param string $date
103		* @return string\|null date Format
104		*/
105	12	public function guessDateFormat(string $date) : ? string
106		{
107	12	foreach ($this->dateFormats as $format) {
108	12	$test = \DateTime::createFromFormat($format, $date);
109	12	if ($test instanceof \DateTime) {
110	10	$this->lastGuessedFormat = $format;
111
112	12	return $format;
113		}
114		}
115
116	2	return null;
117		}
118
119		/**
120		* Creates a DateTime instance for the given string. Default format is RFC2822
121		* @param string $string
122		* @return \DateTime
123		*/
124	10	public function convertToDateTime(string $string) : \DateTime
125		{
126	10	$string = trim($string);
127	10	foreach ([$this->getLastGuessedFormat(), $this->guessDateFormat($string) ] as $format) {
128	10	$date = $this->newDate((string) $format, $string);
129	10	if ($date instanceof \DateTime) {
130	9	$date->setTimezone($this->getTimezone());
131
132	10	return $date;
133		}
134		}
135
136	1	return $this->stringToDateTime($string);
137		}
138
139		/**
140		* Creates a DateTime instance for the given string if the format was not catch from the list
141		* @param string $string
142		* @return \DateTime
143		* @throws InvalidArgumentException
144		*/
145	2	public function stringToDateTime(string $string) : \DateTime
146		{
147	2	$this->logger->notice("unsupported date format, use strtotime() to build the DateTime instance : {$string}");
148
149	2	if (false === strtotime($string)) {
150	1	throw new \InvalidArgumentException('Impossible to convert date : '.$string);
151		}
152	1	$date = new \DateTime($string, $this->getFeedTimezone());
153	1	$date->setTimezone($this->getTimezone());
154
155	1	return $date;
156		}
157
158		/**
159		* @return \DateTimeZone
160		*/
161	11	public function getFeedTimezone() : ? \DateTimeZone
162		{
163	11	return $this->feedTimezone;
164		}
165
166		/**
167		* Specifies the feed's timezone. Do this it the timezone is missing
168		*
169		* @param \DateTimeZone $timezone
170		*/
171		public function setFeedTimezone(\DateTimeZone $timezone) : void
172		{
173		$this->feedTimezone = $timezone;
174		}
175
176		/**
177		* Resets feedTimezone to null.
178		*/
179		public function resetFeedTimezone() : void
180		{
181		$this->feedTimezone = null;
182		}
183
184		/**
185		* @return \DateTimeZone
186		*/
187	11	public function getServerTimezone() : ? \DateTimeZone
188		{
189	11	return $this->serverTimezone;
190		}
191
192		/**
193		* @param \DateTimeZone $timezone
194		*/
195	69	public function setServerTimezone(\DateTimeZone $timezone) : void
196		{
197	69	$this->serverTimezone = $timezone;
198	69	}
199
200		/**
201		* @return \DateTimeZone
202		*/
203	11	public function getTimezone() : ? \DateTimeZone
204		{
205	11	return $this->getServerTimezone();
206		}
207
208		/**
209		* @param \DateTimeZone $timezone
210		*/
211	69	public function setTimezone(\DateTimeZone $timezone) : void
212		{
213	69	$this->setServerTimezone($timezone);
214	69	}
215
216
217		/**
218		* @param $format
219		* @param $string
220		* @return \DateTime
221		*/
222	10	protected function newDate(string $format, string $string)
223		{
224	10	if (!! $this->getFeedTimezone()) {
225		return \DateTime::createFromFormat($format, $string, $this->getFeedTimezone());
		0 ignored issues – show Comprehensibility Best Practice introduced 2017-08-04 06:56 UTC by Report Bug Copy Issue Report The expression `\DateTime::createFromFor...is->getFeedTimezone());` of type `DateTime\|false` adds `false` to the return on line 225 which is incompatible with the return type documented by `FeedIo\Rule\DateTimeBuilder::newDate` of type `DateTime`. It seems like you forgot to handle an error condition. Loading history...
226		}
227
228	10	return \DateTime::createFromFormat($format, $string);
		0 ignored issues – show Comprehensibility Best Practice introduced 2017-08-04 06:56 UTC by Report Bug Copy Issue Report The expression `\DateTime::createFromFormat($format, $string);` of type `DateTime\|false` adds `false` to the return on line 228 which is incompatible with the return type documented by `FeedIo\Rule\DateTimeBuilder::newDate` of type `DateTime`. It seems like you forgot to handle an error condition. Loading history...
229		}
230		}
231

alexdebril / feed-io

Pull Request — project/php-7 (#141)

DateTimeBuilder::resetFeedTimezone() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like