Date::months() - Code Metrics - Inspection of "Update pragmarx/google2fa requirement from ^6.1 to..." - Cherry-Pie/Jarboe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#14)

unknown

created 2020-04-26 10:04 UTC

Date::months() A

↳ Parent: Date

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace Yaro\Jarboe\Table\Fields;

use Yaro\Jarboe\Table\Fields\Traits\Inline;
use Yaro\Jarboe\Table\Fields\Traits\Nullable;
use Yaro\Jarboe\Table\Fields\Traits\Orderable;
use Yaro\Jarboe\Table\Fields\Traits\Placeholder;

class Date extends AbstractField
{
    use Orderable;
    use Nullable;
    use Inline;
    use Placeholder;

    protected $format = 'YYYY-MM-DD';
    protected $months = 1;

    public function default($value)
    {
        if (is_object($value) && is_a($value, \DateTime::class)) {
            /** @var \DateTime $value */
            $this->default = $value->format('Y-m-d');
        } else {
            $this->default = date('Y-m-d', strtotime($value));
        }

        return $this;
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());
}
    }

    public function format(string $momentJsFormat)
    {
        $this->format = $momentJsFormat;

        return $this;
    }

    public function getDateFormat()
    {
        return $this->format;
    }

    public function months(int $months)
    {
        $this->months = $months;

        return $this;
    }

    public function getMonths()
    {
        return $this->months;
    }

    public function getListView($model)
    {
        return view('jarboe::crud.fields.date.list', [
            'model' => $model,
            'field' => $this,
        ]);
    }

    public function getEditFormView($model)
    {
        $template = $this->isReadonly() ? 'readonly' : 'edit';

        return view('jarboe::crud.fields.date.'. $template, [
            'model' => $model,
            'field' => $this,
        ]);
    }

    public function getCreateFormView()
    {
        return view('jarboe::crud.fields.date.create', [
            'field' => $this,
        ]);
    }
}


1			<?php
2
3			namespace Yaro\Jarboe\Table\Fields;
4
5			use Yaro\Jarboe\Table\Fields\Traits\Inline;
6			use Yaro\Jarboe\Table\Fields\Traits\Nullable;
7			use Yaro\Jarboe\Table\Fields\Traits\Orderable;
8			use Yaro\Jarboe\Table\Fields\Traits\Placeholder;
9
10			class Date extends AbstractField
11			{
12			use Orderable;
13			use Nullable;
14			use Inline;
15			use Placeholder;
16
17			protected $format = 'YYYY-MM-DD';
18			protected $months = 1;
19
20	3	View Code Duplication	public function default($value)
21			{
22	3		if (is_object($value) && is_a($value, \DateTime::class)) {
23			/** @var \DateTime $value */
24	1		$this->default = $value->format('Y-m-d');
25			} else {
26	2		$this->default = date('Y-m-d', strtotime($value));
27			}
28
29	3		return $this;
			0 ignored issues – show Bug Best Practice introduced 2019-10-25 12:48 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`Yaro\Jarboe\Table\Fields\Date`) is incompatible with the return type of the parent method `Yaro\Jarboe\Table\Fields\AbstractField::default` of type `Yaro\Jarboe\Table\Fields\Traits\DefaultTrait`. 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...
30			}
31
32	1		public function format(string $momentJsFormat)
33			{
34	1		$this->format = $momentJsFormat;
35
36	1		return $this;
37			}
38
39	2		public function getDateFormat()
40			{
41	2		return $this->format;
42			}
43
44	2		public function months(int $months)
45			{
46	2		$this->months = $months;
47
48	2		return $this;
49			}
50
51	2		public function getMonths()
52			{
53	2		return $this->months;
54			}
55
56	1		public function getListView($model)
57			{
58	1		return view('jarboe::crud.fields.date.list', [
59	1		'model' => $model,
60	1		'field' => $this,
61			]);
62			}
63
64	1		public function getEditFormView($model)
65			{
66	1		$template = $this->isReadonly() ? 'readonly' : 'edit';
67
68	1		return view('jarboe::crud.fields.date.'. $template, [
69	1		'model' => $model,
70	1		'field' => $this,
71			]);
72			}
73
74	1		public function getCreateFormView()
75			{
76	1		return view('jarboe::crud.fields.date.create', [
77	1		'field' => $this,
78			]);
79			}
80			}
81

Cherry-Pie / Jarboe

Pull Request — master (#14)

Date::months() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like