DayOfWeek::__construct() - Code Metrics - Inspection of "2.0" - cashongo/chronoShifter - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#18)

by Kristjan

created 2016-05-10 11:45 UTC

DayOfWeek::__construct() A

↳ Parent: DayOfWeek

Complexity

Conditions	4
Paths	4

Size

Total Lines	16
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	16
rs	9.2
cc	4
eloc	8
nc	4
nop	1

<?php

namespace COG\ChronoShifter\Evaluator;

use COG\ChronoShifter\HolidayProvider\HolidayProvider;

/**
 * @author Kristjan Siimson <[email protected]>
 * @package Evaluator\Domain
 */
class DayOfWeek implements Evaluator
{
    const MONDAY = 1;
    const TUESDAY = 2;
    const WEDNESDAY = 3;
    const THURSDAY = 4;
    const FRIDAY = 5;
    const SATURDAY = 6;
    const SUNDAY = 7;

    /**
     * @var HolidayProvider
     */
    private $weekday;

    /**
     * @param int $dayOfWeek
     */
    public function __construct($dayOfWeek)
    {
        if (false === filter_var($dayOfWeek, FILTER_VALIDATE_INT)) {
            throw new \InvalidArgumentException('Integer required');
        }

        if ($dayOfWeek <= 0) {
            throw new \OutOfBoundsException('Day of week less than 1');
        }

        if ($dayOfWeek > 7) {
            throw new \OutOfBoundsException('Day of week greater than 7');
        }

        $this->weekday = (int)$dayOfWeek;

    }

    /**
     * @param string $date
     * @return bool
     */
    public function is($date)
    {
        return (int)date('N', strtotime($date)) === $this->weekday;
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());
}
    }
}


1			<?php
2
3			namespace COG\ChronoShifter\Evaluator;
4
5			use COG\ChronoShifter\HolidayProvider\HolidayProvider;
6
7			/**
8			* @author Kristjan Siimson <[email protected]>
9			* @package Evaluator\Domain
10			*/
11			class DayOfWeek implements Evaluator
12			{
13			const MONDAY = 1;
14			const TUESDAY = 2;
15			const WEDNESDAY = 3;
16			const THURSDAY = 4;
17			const FRIDAY = 5;
18			const SATURDAY = 6;
19			const SUNDAY = 7;
20
21			/**
22			* @var HolidayProvider
23			*/
24			private $weekday;
25
26			/**
27			* @param int $dayOfWeek
28			*/
29			public function __construct($dayOfWeek)
30			{
31			if (false === filter_var($dayOfWeek, FILTER_VALIDATE_INT)) {
32			throw new \InvalidArgumentException('Integer required');
33			}
34
35			if ($dayOfWeek <= 0) {
36			throw new \OutOfBoundsException('Day of week less than 1');
37			}
38
39			if ($dayOfWeek > 7) {
40			throw new \OutOfBoundsException('Day of week greater than 7');
41			}
42
43			$this->weekday = (int)$dayOfWeek;
			0 ignored issues – show Documentation Bug introduced 2016-05-10 11:37 UTC by Report Bug Copy Issue Report It seems like `(int) $dayOfWeek` of type `integer` is incompatible with the declared type `object<COG\ChronoShifter...ovider\HolidayProvider>` of property `$weekday`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
44			}
45
46			/**
47			* @param string $date
48			* @return bool
49			*/
50			public function is($date)
51			{
52			return (int)date('N', strtotime($date)) === $this->weekday;
			0 ignored issues – show Bug Best Practice introduced 2016-05-10 11:37 UTC by Report Bug Copy Issue Report The return type of `return (int) date('N', s...e)) === $this->weekday;` (`boolean`) is incompatible with the return type declared by the interface `COG\ChronoShifter\Evaluator\Evaluator::is` of type `integer`. 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...
53			}
54			}
55

cashongo / chronoShifter

GitHub Access Token became invalid

Pull Request — master (#18)

DayOfWeek::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like