DateTimeBuilder::getFeedTimezone() - Code Metrics - alexdebril/feed-io - Measure and Improve Code Quality continuously with Scrutinizer

DateTimeBuilder::getFeedTimezone() A
last analyzed 2021-03-01 18:10 UTC

↳ Parent: DateTimeBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?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 implements DateTimeBuilderInterface
{
    /**
     * Supported date formats
     * @var array
     */
    protected $dateFormats = [
        \DateTime::RFC2822,
        \DateTime::ATOM,
        \DateTime::RFC3339,
        \DateTime::RFC3339_EXTENDED,
        \DateTime::RSS,
        \DateTime::W3C,
        'Y-m-d\TH:i:s.uP',
        'Y-m-d\TH:i:s.uvP',
        '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',
        'D, d M Y H:i:s \U\T',
        '*, d M* Y H:i:s e',
        '*, d M Y',
    ];

    /**
     * @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) : DateTimeBuilderInterface
    {
        $this->dateFormats[] = $dateFormat;

        return $this;
    }

    /**
     * @param  array $dateFormats
     * @return $this
     */
    public function setDateFormats(array $dateFormats) : DateTimeBuilderInterface
    {
        $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 implements DateTimeBuilderInterface
17		{
18		/**
19		* Supported date formats
20		* @var array
21		*/
22		protected $dateFormats = [
23		\DateTime::RFC2822,
24		\DateTime::ATOM,
25		\DateTime::RFC3339,
26		\DateTime::RFC3339_EXTENDED,
27		\DateTime::RSS,
28		\DateTime::W3C,
29		'Y-m-d\TH:i:s.uP',
30		'Y-m-d\TH:i:s.uvP',
31		'Y-m-d\TH:i:s',
32		'Y-m-d',
33		'd/m/Y',
34		'D, d M Y H:i O',
35		'D, d M Y H:i:s O',
36		'D M d Y H:i:s e',
37		'*, m#d#Y - H:i',
38		'D, d M Y H:i:s \U\T',
39		', d M Y H:i:s e',
40		'*, d M Y',
41		];
42
43		/**
44		* @var \DateTimeZone
45		*/
46		protected $feedTimezone;
47
48		/**
49		* @var \DateTimeZone
50		*/
51		protected $serverTimezone;
52
53		/**
54		* @var LoggerInterface
55		*/
56		protected $logger;
57
58		/**
59		* @var string
60		*/
61		protected $lastGuessedFormat = \DateTime::RFC2822;
62
63		/**
64		* @param \Psr\Log\LoggerInterface $logger
65		*/
66	78	public function __construct(LoggerInterface $logger = null)
67		{
68	78	if (is_null($logger)) {
69	65	$logger = new NullLogger;
70		}
71	78	$this->logger = $logger;
72	78	$this->setTimezone(new \DateTimeZone(date_default_timezone_get()));
73	78	}
74
75		/**
76		* @param $dateFormat
77		* @return DateTimeBuilder
78		*/
79	22	public function addDateFormat(string $dateFormat) : DateTimeBuilderInterface
80		{
81	22	$this->dateFormats[] = $dateFormat;
82
83	22	return $this;
84		}
85
86		/**
87		* @param array $dateFormats
88		* @return $this
89		*/
90	2	public function setDateFormats(array $dateFormats) : DateTimeBuilderInterface
91		{
92	2	$this->dateFormats = $dateFormats;
93
94	2	return $this;
95		}
96
97		/**
98		* @return string
99		*/
100	15	public function getLastGuessedFormat() : string
101		{
102	15	return $this->lastGuessedFormat;
103		}
104
105		/**
106		* Tries to guess the date's format from the list
107		* @param string $date
108		* @return string\|null date Format
109		*/
110	17	public function guessDateFormat(string $date) : ? string
111		{
112	17	foreach ($this->dateFormats as $format) {
113	17	$test = \DateTime::createFromFormat($format, $date);
114	17	if ($test instanceof \DateTime) {
115	15	$this->lastGuessedFormat = $format;
116
117	15	return $format;
118		}
119		}
120
121	2	return null;
122		}
123
124		/**
125		* Creates a DateTime instance for the given string. Default format is RFC2822
126		* @param string $string
127		* @return \DateTime
128		*/
129	15	public function convertToDateTime(string $string) : \DateTime
130		{
131	15	$string = trim($string);
132	15	foreach ([$this->getLastGuessedFormat(), $this->guessDateFormat($string) ] as $format) {
133	15	$date = $this->newDate((string) $format, $string);
134	15	if ($date instanceof \DateTime) {
135	14	$date->setTimezone($this->getTimezone());
136
137	14	return $date;
138		}
139		}
140
141	1	return $this->stringToDateTime($string);
142		}
143
144		/**
145		* Creates a DateTime instance for the given string if the format was not catch from the list
146		* @param string $string
147		* @return \DateTime
148		* @throws InvalidArgumentException
149		*/
150	2	public function stringToDateTime(string $string) : \DateTime
151		{
152	2	$this->logger->notice("unsupported date format, use strtotime() to build the DateTime instance : {$string}");
153
154	2	if (false === strtotime($string)) {
155	1	throw new \InvalidArgumentException('Impossible to convert date : '.$string);
156		}
157	1	$date = new \DateTime($string, $this->getFeedTimezone());
158	1	$date->setTimezone($this->getTimezone());
159
160	1	return $date;
161		}
162
163		/**
164		* @return \DateTimeZone
165		*/
166	16	public function getFeedTimezone() : ? \DateTimeZone
167		{
168	16	return $this->feedTimezone;
169		}
170
171		/**
172		* Specifies the feed's timezone. Do this it the timezone is missing
173		*
174		* @param \DateTimeZone $timezone
175		*/
176		public function setFeedTimezone(\DateTimeZone $timezone) : void
177		{
178		$this->feedTimezone = $timezone;
179		}
180
181		/**
182		* Resets feedTimezone to null.
183		*/
184		public function resetFeedTimezone() : void
185		{
186		$this->feedTimezone = null;
187		}
188
189		/**
190		* @return \DateTimeZone
191		*/
192	16	public function getServerTimezone() : ? \DateTimeZone
193		{
194	16	return $this->serverTimezone;
195		}
196
197		/**
198		* @param \DateTimeZone $timezone
199		*/
200	78	public function setServerTimezone(\DateTimeZone $timezone) : void
201		{
202	78	$this->serverTimezone = $timezone;
203	78	}
204
205		/**
206		* @return \DateTimeZone
207		*/
208	16	public function getTimezone() : ? \DateTimeZone
209		{
210	16	return $this->getServerTimezone();
211		}
212
213		/**
214		* @param \DateTimeZone $timezone
215		*/
216	78	public function setTimezone(\DateTimeZone $timezone) : void
217		{
218	78	$this->setServerTimezone($timezone);
219	78	}
220
221		/**
222		* @param $format
223		* @param $string
224		* @return \DateTime
225		*/
226	15	protected function newDate(string $format, string $string)
227		{
228	15	if (!! $this->getFeedTimezone()) {
229		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 229 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...
230		}
231
232	15	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 232 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...
233		}
234		}
235

alexdebril / feed-io

DateTimeBuilder::getFeedTimezone() A last analyzed 2021-03-01 18:10 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DateTimeBuilder::getFeedTimezone() A
last analyzed 2021-03-01 18:10 UTC