DateIterator   A
last analyzed

Complexity

Total Complexity 2

Size/Duplication

Total Lines 27
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 4

Test Coverage

Coverage 100%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
wmc 2
c 1
b 0
f 0
lcom 0
cbo 4
dl 0
loc 27
ccs 5
cts 5
cp 1
rs 10

2 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 4 1
A current() 0 4 1
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 Date objects.
13
 *
14
 * @since  2.0.0
15
 */
16
class DateIterator extends DateTimeIterator
17
{
18
	/**
19
	 * Constructor.
20
	 *
21
	 * @param   Date  $start  The start date.
22
	 * @param   Date  $end    The end date.
23
	 *
24
	 * @since   2.0.0
25
	 */
26 3
	public function __construct(Date $start, Date $end)
27
	{
28 3
		parent::__construct(new DateTime($start), new DateTime($end), new DateInterval('P1D'));
29 3
	}
30
31
	/**
32
	 * Returns the current date.
33
	 *
34
	 * @return  Date
35
	 *
36
	 * @since   2.0.0
37
	 */
38 3
	public function current()
39
	{
40 3
		return new Date(parent::current());
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \Joomla\DateT...ate(parent::current()); (Joomla\DateTime\Date) is incompatible with the return type of the parent method Joomla\DateTime\DateTimeIterator::current of type Joomla\DateTime\DateTime.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
41
	}
42
}
43