DateParserOffset - Code Metrics - Inspection of "Refactor" - graze/ciff-renderer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

by John

created 2016-11-22 22:30 UTC

DateParserOffset A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	38
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	2
lcom	1
cbo	1
dl	0
loc	38
rs	10
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	setXmlHeader()	0	4	1
A	getDateTime()	0	17	1

<?php

namespace Graze\CiffRenderer\Field\Parser\DateParser;

use Graze\CiffRenderer\Field\Parser\DateParser\AbstractDateParser;
use \DateInterval;
use \DateTimeImmutable;
use \SimpleXMLElement;

class DateParserOffset extends AbstractDateParser
{
    /**
     * @var SimpleXMLElement
     */
    protected $xmlHeader;

    /**
     * @param SimpleXMLElement $xmlHeader
     *
     * @return void
     */
    public function setXmlHeader(SimpleXMLElement $xmlHeader)
    {
        $this->xmlHeader = $xmlHeader;
    }

    /**
     * @return DateTimeInterface

     */
    protected function getDateTime()
    {
        $offsetFieldName = (string) $this->xmlField->Data->Object->OffsetDate['SrcOffset'];

        $offsetField = $this->xmlHeader->xpath('//DateOffset[@Name="'. $offsetFieldName .'"]')[0];

        // currenty only supports offset days
        // @codingStandardsIgnoreStart
        $offsetDays = (string) $offsetField->DefaultOffset->Day;
        // @codingStandardsIgnoreStart

        $dateInterval = new DateInterval('P' . $offsetDays . 'D');

        $dateTime = new DateTimeImmutable();

        return $dateTime->add($dateInterval);
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 Graze\CiffRenderer\Field\Parser\DateParser;
4
5			use Graze\CiffRenderer\Field\Parser\DateParser\AbstractDateParser;
6			use \DateInterval;
7			use \DateTimeImmutable;
8			use \SimpleXMLElement;
9
10			class DateParserOffset extends AbstractDateParser
11			{
12			/**
13			* @var SimpleXMLElement
14			*/
15			protected $xmlHeader;
16
17			/**
18			* @param SimpleXMLElement $xmlHeader
19			*
20			* @return void
21			*/
22			public function setXmlHeader(SimpleXMLElement $xmlHeader)
23			{
24			$this->xmlHeader = $xmlHeader;
25			}
26
27			/**
28			* @return DateTimeInterface
			0 ignored issues – show Documentation introduced 2016-11-17 21:37 UTC by Report Bug Copy Issue Report Should the return type not be `DateTimeImmutable`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
29			*/
30			protected function getDateTime()
31			{
32			$offsetFieldName = (string) $this->xmlField->Data->Object->OffsetDate['SrcOffset'];
33
34			$offsetField = $this->xmlHeader->xpath('//DateOffset[@Name="'. $offsetFieldName .'"]')[0];
35
36			// currenty only supports offset days
37			// @codingStandardsIgnoreStart
38			$offsetDays = (string) $offsetField->DefaultOffset->Day;
39			// @codingStandardsIgnoreStart
40
41			$dateInterval = new DateInterval('P' . $offsetDays . 'D');
42
43			$dateTime = new DateTimeImmutable();
44
45			return $dateTime->add($dateInterval);
			0 ignored issues – show Bug Best Practice introduced 2016-04-23 16:33 UTC by Report Bug Copy Issue Report The return type of `return $dateTime->add($dateInterval);` (`DateTimeImmutable`) is incompatible with the return type declared by the abstract method `Graze\CiffRenderer\Field...DateParser::getDateTime` of type `Graze\CiffRenderer\Field...arser\DateTimeInterface`. 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...
46			}
47			}
48

graze / ciff-renderer

Pull Request — master (#18)

DateParserOffset A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

2 Methods

Duplication Side-by-Side

Filter issues like