DateTimeIterator::valid() - Code Metrics - joomla-framework/datetime - Measure and Improve Code Quality continuously with Scrutinizer

DateTimeIterator::valid() A
last analyzed 2018-04-08 21:10 UTC

↳ Parent: DateTimeIterator

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * Part of the Joomla Framework DateTime Package
 *
 * @copyright  Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
 * @license    GNU Lesser General Public License version 2.1 or later; see LICENSE
 */

namespace Joomla\DateTime;

/**
 * Iterator for ranges of DateTime objects.
 *
 * @since  2.0.0
 */
class DateTimeIterator implements \Iterator
{
	/**
	 * DateTime object representing the start date of the iterator
	 *
	 * @var    DateTime
	 * @since  2.0.0
	 */
	private $start;

	/**
	 * DateTime object representing the end date of the iterator
	 *
	 * @var    DateTime
	 * @since  2.0.0
	 */
	private $end;

	/**
	 * Interval between dates
	 *
	 * @var    DateInterval
	 * @since  2.0.0
	 */
	private $interval;

	/**
	 * DateTime object representing the current date
	 *
	 * @var    DateTime
	 * @since  2.0.0
	 */
	private $current;

	/**
	 * The key of the current date
	 *
	 * @var    integer
	 * @since  2.0.0
	 */
	private $key;

	/**
	 * Constructor.
	 *
	 * @param   DateTime      $start     The start date.
	 * @param   DateTime      $end       The end date.
	 * @param   DateInterval  $interval  The interval between adjacent dates.
	 *
	 * @since   2.0.0
	 */
	public function __construct(DateTime $start, DateTime $end, DateInterval $interval)
	{
		$this->start = $this->current = $start;
		$this->end = $end;
		$this->interval = $interval;
	}

	/**
	 * Returns the current date.
	 *
	 * @return  DateTime
	 *
	 * @since   2.0.0
	 */
	public function current()
	{
		return $this->current;
	}

	/**
	 * Returns the key of the current date.
	 *
	 * @return  integer
	 *
	 * @since   2.0.0
	 */
	public function key()
	{
		return $this->key;
	}

	/**
	 * Moves the current position to the next date.
	 *
	 * @return  void
	 *
	 * @since   2.0.0
	 */
	public function next()
	{
		$this->key++;
		$this->current = $this->current->add($this->interval);
	}

	/**
	 * Rewinds back to the first date.
	 *
	 * @return  void
	 *
	 * @since   2.0.0
	 */
	public function rewind()
	{
		$this->key = 0;
		$this->current = $this->start;
	}

	/**
	 * Checks if current position is valid.
	 *
	 * @return  boolean
	 *
	 * @since   2.0.0
	 */
	public function valid()
	{
		return !$this->current->isAfter($this->end);
	}
}


1		<?php
2		/**
3		* Part of the Joomla Framework DateTime Package
4		*
5		* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
6		* @license GNU Lesser General Public License version 2.1 or later; see LICENSE
7		*/
8
9		namespace Joomla\DateTime;
10
11		/**
12		* Iterator for ranges of DateTime objects.
13		*
14		* @since 2.0.0
15		*/
16		class DateTimeIterator implements \Iterator
17		{
18		/**
19		* DateTime object representing the start date of the iterator
20		*
21		* @var DateTime
22		* @since 2.0.0
23		*/
24		private $start;
25
26		/**
27		* DateTime object representing the end date of the iterator
28		*
29		* @var DateTime
30		* @since 2.0.0
31		*/
32		private $end;
33
34		/**
35		* Interval between dates
36		*
37		* @var DateInterval
38		* @since 2.0.0
39		*/
40		private $interval;
41
42		/**
43		* DateTime object representing the current date
44		*
45		* @var DateTime
46		* @since 2.0.0
47		*/
48		private $current;
49
50		/**
51		* The key of the current date
52		*
53		* @var integer
54		* @since 2.0.0
55		*/
56		private $key;
57
58		/**
59		* Constructor.
60		*
61		* @param DateTime $start The start date.
62		* @param DateTime $end The end date.
63		* @param DateInterval $interval The interval between adjacent dates.
64		*
65		* @since 2.0.0
66		*/
67	10	public function __construct(DateTime $start, DateTime $end, DateInterval $interval)
68		{
69	10	$this->start = $this->current = $start;
70	10	$this->end = $end;
71	10	$this->interval = $interval;
72	10	}
73
74		/**
75		* Returns the current date.
76		*
77		* @return DateTime
78		*
79		* @since 2.0.0
80		*/
81	10	public function current()
82		{
83	10	return $this->current;
84		}
85
86		/**
87		* Returns the key of the current date.
88		*
89		* @return integer
90		*
91		* @since 2.0.0
92		*/
93		public function key()
94		{
95		return $this->key;
96		}
97
98		/**
99		* Moves the current position to the next date.
100		*
101		* @return void
102		*
103		* @since 2.0.0
104		*/
105	10	public function next()
106		{
107	10	$this->key++;
108	10	$this->current = $this->current->add($this->interval);
109	10	}
110
111		/**
112		* Rewinds back to the first date.
113		*
114		* @return void
115		*
116		* @since 2.0.0
117		*/
118	10	public function rewind()
119		{
120	10	$this->key = 0;
121	10	$this->current = $this->start;
122	10	}
123
124		/**
125		* Checks if current position is valid.
126		*
127		* @return boolean
128		*
129		* @since 2.0.0
130		*/
131	10	public function valid()
132		{
133	10	return !$this->current->isAfter($this->end);
134		}
135		}
136

joomla-framework / datetime

DateTimeIterator::valid() A last analyzed 2018-04-08 21:10 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

DateTimeIterator::valid() A
last analyzed 2018-04-08 21:10 UTC