BusinessDaysSpan::setHolidays()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 4
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 7
ccs 4
cts 4
cp 1
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 1
crap 1
1
<?php
2
3
namespace CL\DateUtils;
4
5
use DateTime;
6
7
/**
8
 * Force week days.
9
 *
10
 * @author    Ivan Kerin <[email protected]>
11
 * @copyright 2015, Clippings Ltd.
12
 * @license   http://spdx.org/licenses/BSD-3-Clause
13
 */
14
class BusinessDaysSpan extends DaysSpan
15
{
16
    /**
17
     * @param BusinessDays $from
18
     * @param BusinessDays $to
19
     */
20 1
    public function __construct(BusinessDays $from, BusinessDays $to)
21
    {
22 1
        parent::__construct($from, $to);
23 1
    }
24
25
    /**
26
     * @param Holidays $holidays
27
     */
28 1
    public function setHolidays(Holidays $holidays)
29
    {
30 1
        $this->getFrom()->setHolidays($holidays);
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class CL\DateUtils\Days as the method setHolidays() does only exist in the following sub-classes of CL\DateUtils\Days: CL\DateUtils\BusinessDays. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
31 1
        $this->getTo()->setHolidays($holidays);
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class CL\DateUtils\Days as the method setHolidays() does only exist in the following sub-classes of CL\DateUtils\Days: CL\DateUtils\BusinessDays. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
32
33 1
        return $this;
34
    }
35
36
    /**
37
     * @return string
38
     */
39 3
    public function humanize()
40
    {
41 3
        if ($this->getFrom()->getDays() === $this->getTo()->getDays()) {
42 1
            return $this->getFrom()->getDays().' business days';
43
        }
44
45 2
        return $this->getFrom()->getDays().' - '.$this->getTo()->getDays().' business days';
46
    }
47
}
48