Passed
Pull Request — main (#14)
by Michael
03:29
created

DateFormatter   A

Complexity

Total Complexity 5

Size/Duplication

Total Lines 35
Duplicated Lines 0 %

Test Coverage

Coverage 90.91%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 10
c 1
b 0
f 0
dl 0
loc 35
ccs 10
cts 11
cp 0.9091
rs 10
wmc 5

2 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 15 4
A format() 0 5 1
1
<?php
2
3
declare(strict_types=1);
4
5
namespace MichaelRubel\Formatters\Collection;
6
7
use Carbon\CarbonInterface;
8
use Illuminate\Support\Carbon;
9
use MichaelRubel\Formatters\Formatter;
10
11
class DateFormatter implements Formatter
12
{
13
    /**
14
     * @param  string|CarbonInterface|null  $date
15
     * @param  string|null  $timezone
16
     * @param  string|null  $date_format
17
     */
18 13
    public function __construct(
19
        public string|null|CarbonInterface $date = null,
20
        public string|null $timezone = null,
21
        public string|null $date_format = 'Y-m-d',
22
    ) {
23 13
        if (! $this->timezone) {
24 9
            $this->timezone = config('app.timezone', 'UTC');
25
        }
26
27 13
        if (! $this->date instanceof CarbonInterface) {
28 7
            $this->date = app(Carbon::class)->parse($this->date);
29
        }
30
31 13
        if (! $this->date_format) {
32
            $this->date_format = 'Y-m-d';
33
        }
34
    }
35
36
    /**
37
     * Format the date.
38
     *
39
     * @return string
40
     */
41 13
    public function format(): string
42
    {
43 13
        return $this->date
44 13
            ->setTimezone($this->timezone)
0 ignored issues
show
Bug introduced by
The method setTimezone() does not exist on null. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

44
            ->/** @scrutinizer ignore-call */ setTimezone($this->timezone)

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
45 13
            ->translatedFormat($this->date_format);
0 ignored issues
show
Bug introduced by
It seems like $this->date_format can also be of type null; however, parameter $format of Carbon\CarbonInterface::translatedFormat() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

45
            ->translatedFormat(/** @scrutinizer ignore-type */ $this->date_format);
Loading history...
46
    }
47
}
48