Completed
Push — master ( ec4d94...e740a7 )
by Neomerx
06:52
created

JsonApiDateTime::getValue()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 0
1
<?php namespace Limoncello\Flute\Types;
2
3
/**
4
 * Copyright 2015-2017 [email protected]
5
 *
6
 * Licensed under the Apache License, Version 2.0 (the "License");
7
 * you may not use this file except in compliance with the License.
8
 * You may obtain a copy of the License at
9
 *
10
 * http://www.apache.org/licenses/LICENSE-2.0
11
 *
12
 * Unless required by applicable law or agreed to in writing, software
13
 * distributed under the License is distributed on an "AS IS" BASIS,
14
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
 * See the License for the specific language governing permissions and
16
 * limitations under the License.
17
 */
18
19
use DateTimeInterface;
20
use JsonSerializable;
21
22
/**
23
 * Wrapper class for `DateTimeInterface` value with JSON serialization support.
24
 *
25
 * Unfortunately PHP forbids implementing `DateTimeInterface` in user-level classes so it's not
26
 * possible to make it look and behave like 'ordinary' date time.
27
 *
28
 * @package Limoncello\Flute
29
 */
30
class JsonApiDateTime implements JsonSerializable
31
{
32
    /**
33
     * @var DateTimeInterface
34
     */
35
    private $value;
36
37
    /**
38
     * @var string
39
     */
40
    private $format;
41
42
    /**
43
     * @param DateTimeInterface $value
44
     * @param string            $format
45
     */
46
    public function __construct(DateTimeInterface $value, string $format = DateBaseType::JSON_API_FORMAT)
47
    {
48
        $this->value  = $value;
49
        $this->format = $format;
50
    }
51
52
    /**
53
     * @return DateTimeInterface
54
     */
55
    public function getValue(): DateTimeInterface
56
    {
57
        return $this->value;
58
    }
59
60
    /**
61
     * @return string
62
     */
63
    public function getFormat(): string
64
    {
65
        return $this->format;
66
    }
67
68
    /**
69
     * @inheritdoc
70
     */
71
    public function jsonSerialize()
72
    {
73
        return $this->getValue()->format($this->getFormat());
74
    }
75
}
76