Completed
Push — master ( 0d14b2...954878 )
by Joschi
03:11
created

AbstractApparatObject::getType()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 1
eloc 2
c 1
b 0
f 1
nc 1
nop 0
dl 0
loc 4
ccs 2
cts 2
cp 1
crap 1
rs 10
1
<?php
2
3
/**
4
 * apparat/object
5
 *
6
 * @category    Apparat
7
 * @package     Apparat\Object
8
 * @subpackage  Apparat\Object\Infrastructure
9
 * @author      Joschi Kuphal <[email protected]> / @jkphl
10
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
12
 */
13
14
/***********************************************************************************
15
 *  The MIT License (MIT)
16
 *
17
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18
 *
19
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
20
 *  this software and associated documentation files (the "Software"), to deal in
21
 *  the Software without restriction, including without limitation the rights to
22
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23
 *  the Software, and to permit persons to whom the Software is furnished to do so,
24
 *  subject to the following conditions:
25
 *
26
 *  The above copyright notice and this permission notice shall be included in all
27
 *  copies or substantial portions of the Software.
28
 *
29
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35
 ***********************************************************************************/
36
37
namespace Apparat\Object\Infrastructure\Model\Object\Apparat;
38
39
use Apparat\Object\Application\Model\Object\ApplicationObjectInterface;
40
use Apparat\Object\Infrastructure\Model\Object\Apparat\Traits\ApparatObjectTrait;
41
use Apparat\Object\Ports\Contract\ApparatObjectInterface;
42
43
/**
44
 * Abstract apparat object
45
 *
46
 * @package Apparat\Object
47
 * @subpackage Apparat\Object\Infrastructure
48
 * @method \DateTimeImmutable getPublished() Return the object publication date
49
 * @method \DateTimeImmutable getUpdated() Return the object modification date
50
 * @method array getAuthor() Return the object authors
51
 * @method array getCategory() Return the object authors
52
 * @method array getUrl() Return the object URL
53
 * @method array getUid() Return the object UID
54
 * @method array getLocation() Return the object location
55
 * @method array getSyndication() Return the object location
56
 */
57
abstract class AbstractApparatObject extends \ArrayObject implements ApparatObjectInterface
58
{
59
    /**
60
     * Use the apparat object common properties
61
     */
62
    use ApparatObjectTrait;
63
    /**
64
     * Object type
65
     *
66
     * @var string
67
     */
68
    const TYPE = null;
69
    /**
70
     * Application object
71
     *
72
     * @var ApplicationObjectInterface
73
     */
74
    protected $object;
75
76
    /**
77
     * Apparat object constructor
78
     *
79
     * @param ApplicationObjectInterface $object Object
80
     * @param int $flags Flags
81
     * @param string $iteratorClass Iterator class
82
     */
83 10
    public function __construct(
84
        ApplicationObjectInterface $object,
85
        $flags = 0,
86
        $iteratorClass = ApparatObjectIterator::class
87
    ) {
88 10
        $this->mapping[ApparatObjectInterface::PROPERTY_TYPE] = ApparatObjectInterface::PROPERTY_TYPE;
89 10
        parent::__construct(
90 10
            $this->mapping,
91 10
            $flags,
92
            $iteratorClass
93 10
        );
94 10
        $this->object = $object;
95 10
    }
96
97
    /**
98
     * Return the object type
99
     *
100
     * @return string Object type
101
     */
102 2
    public function getType()
103
    {
104 2
        return static::TYPE;
105
    }
106
}
107