CouponSheetAbstract - Code Metrics - GermaniaKG/Coupons - Measure and Improve Code Quality continuously with Scrutinizer

CouponSheetAbstract A
last analyzed 2019-02-19 08:42 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

92.31%

Importance

Changes

Metric	Value
wmc	14
lcom	1
cbo	0
dl	0
loc	136
ccs	24
cts	26
cp	0.9231
rs	10
c	0
b	0
f	0

9 Methods

Rating	Name	Size	Complexity
A	getId()	3	1
A	getQuantity()	3	1
A	getSlug()	3	1
A	getName()	3	1
A	getValidFrom()	3	1
A	getValidUntil()	3	1
A	getCoupons()	3	1
A	isValid()	14	4
A	isExpired()	8	3

<?php
namespace Germania\Coupons;

class CouponSheetAbstract implements CouponSheetInterface
{

    /**
     * @var int|string
     */
    public $id;

    /**
     * @var int|string
     */
    public $quantity;

    /**
     * @var string
     */
    public $slug;

    /**
     * @var string
     */
    public $name;

    /**
     * @var DateTime|null
     */
    public $valid_from;

    /**
     * @var DateTime|null
     */
    public $valid_until;

    /**
     * @var string
     */
    public $coupons;


    /**
     * @return int
     * @implements CouponSheetInterface
     */
    public function getId() {
        return $this->id;
    }

    /**
     * @return int
     * @implements CouponSheetInterface
     */
    public function getQuantity() {
        return $this->quantity;
    }


    /**
     * @return string
     * @implements CouponSheetInterface
     */
    public function getSlug(){
        return $this->slug;
    }


    /**
     * @return string
     * @implements CouponSheetInterface
     */
    public function getName() {
        return $this->name;
    }


    /**
     * @return DateTime
     * @implements CouponSheetInterface
     */
    public function getValidFrom() {
        return $this->valid_from;
    }


    /**
     * @return DateTime
     * @implements CouponSheetInterface
     */
    public function getValidUntil() {
        return $this->valid_until;
    }


    /**
     * @return CouponInterface[]
     * @implements CouponSheetInterface
     */
    public function getCoupons() {
        return $this->coupons;
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());
}
    }


    /**
     * @return bool
     * @implements ValidCouponInterface
     */
    public function isValid()
    {
        if (!$valid_from = $this->getValidFrom()
        or  !$valid_from instanceOf \DateTimeInterface )
            return false;

        // is valid_from in future?
        if ( time() < $valid_from->getTimestamp())
            return false;

        // So there's only to check if expired.
        return !$this->isExpired();

    }


    /**
     * @return bool
     * @implements ValidCouponInterface
     */
    public function isExpired()
    {
        if (!$valid_until = $this->getValidUntil()
        or  !$valid_until instanceOf \DateTimeInterface)
            return false;

        return (time() > $valid_until->getTimestamp() );
    }


}


1		<?php
2		namespace Germania\Coupons;
3
4		class CouponSheetAbstract implements CouponSheetInterface
5		{
6
7		/**
8		* @var int\|string
9		*/
10		public $id;
11
12		/**
13		* @var int\|string
14		*/
15		public $quantity;
16
17		/**
18		* @var string
19		*/
20		public $slug;
21
22		/**
23		* @var string
24		*/
25		public $name;
26
27		/**
28		* @var DateTime\|null
29		*/
30		public $valid_from;
31
32		/**
33		* @var DateTime\|null
34		*/
35		public $valid_until;
36
37		/**
38		* @var string
39		*/
40		public $coupons;
41
42
43		/**
44		* @return int
45		* @implements CouponSheetInterface
46		*/
47	10	public function getId() {
48	10	return $this->id;
49		}
50
51		/**
52		* @return int
53		* @implements CouponSheetInterface
54		*/
55		public function getQuantity() {
56		return $this->quantity;
57		}
58
59
60		/**
61		* @return string
62		* @implements CouponSheetInterface
63		*/
64	10	public function getSlug(){
65	10	return $this->slug;
66		}
67
68
69		/**
70		* @return string
71		* @implements CouponSheetInterface
72		*/
73	10	public function getName() {
74	10	return $this->name;
75		}
76
77
78		/**
79		* @return DateTime
80		* @implements CouponSheetInterface
81		*/
82	10	public function getValidFrom() {
83	10	return $this->valid_from;
84		}
85
86
87		/**
88		* @return DateTime
89		* @implements CouponSheetInterface
90		*/
91	15	public function getValidUntil() {
92	15	return $this->valid_until;
93		}
94
95
96		/**
97		* @return CouponInterface[]
98		* @implements CouponSheetInterface
99		*/
100	5	public function getCoupons() {
101	5	return $this->coupons;
		0 ignored issues – show Bug Best Practice introduced 2019-02-06 12:47 UTC by Report Bug Copy Issue Report The return type of `return $this->coupons;` (`string`) is incompatible with the return type declared by the interface `Germania\Coupons\CouponSheetInterface::getCoupons` of type `Germania\Coupons\CouponInterface[]`. 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...
102		}
103
104
105		/**
106		* @return bool
107		* @implements ValidCouponInterface
108		*/
109	5	public function isValid()
110		{
111	5	if (!$valid_from = $this->getValidFrom()
112	5	or !$valid_from instanceOf \DateTimeInterface )
113	5	return false;
114
115		// is valid_from in future?
116	5	if ( time() < $valid_from->getTimestamp())
117	5	return false;
118
119		// So there's only to check if expired.
120	5	return !$this->isExpired();
121
122		}
123
124
125		/**
126		* @return bool
127		* @implements ValidCouponInterface
128		*/
129	10	public function isExpired()
130		{
131	10	if (!$valid_until = $this->getValidUntil()
132	10	or !$valid_until instanceOf \DateTimeInterface)
133	10	return false;
134
135	5	return (time() > $valid_until->getTimestamp() );
136		}
137
138
139		}
140

GermaniaKG / Coupons

CouponSheetAbstract A last analyzed 2019-02-19 08:42 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

9 Methods

Duplication Side-by-Side

Filter issues like

CouponSheetAbstract A
last analyzed 2019-02-19 08:42 UTC