Completed
Push — 16.x ( 776597...a8b74e )
by Tim
01:56
created

VendorDir::isRelative()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
1
<?php
2
3
/**
4
 * TechDivision\Import\Configuration\VendorDir
5
 *
6
 * NOTICE OF LICENSE
7
 *
8
 * This source file is subject to the Open Software License (OSL 3.0)
9
 * that is available through the world-wide-web at this URL:
10
 * http://opensource.org/licenses/osl-3.0.php
11
 *
12
 * PHP version 5
13
 *
14
 * @author    Tim Wagner <[email protected]>
15
 * @copyright 2016 TechDivision GmbH <[email protected]>
16
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17
 * @link      https://github.com/techdivision/import-configuration-jms
18
 * @link      http://www.techdivision.com
19
 */
20
21
namespace TechDivision\Import\Configuration\Jms\Configuration;
22
23
use JMS\Serializer\Annotation\Type;
24
use JMS\Serializer\Annotation\SerializedName;
25
use TechDivision\Import\Configuration\VendorDirConfigurationInterface;
26
27
/**
28
 * The vendor dir configuration.
29
 *
30
 * @author    Tim Wagner <[email protected]>
31
 * @copyright 2016 TechDivision GmbH <[email protected]>
32
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
33
 * @link      https://github.com/techdivision/import-configuration-jms
34
 * @link      http://www.techdivision.com
35
 */
36
class VendorDir implements VendorDirConfigurationInterface
37
{
38
39
    /**
40
     * The path to the additional vendor directory.
41
     *
42
     * @var string
43
     * @Type("string")
44
     * @SerializedName("vendor-dir")
45
     */
46
    protected $vendorDir;
47
48
    /**
49
     * The array with the paths to the extension libraries.
50
     *
51
     * @var array
52
     * @Type("array")
53
     */
54
    protected $libraries = array();
55
56
    /**
57
     * Whether or the vendor directory is relative to the installation directory.
58
     *
59
     * @var boolean
60
     * @Type("boolean")
61
     */
62
    protected $relative = true;
63
64
    /**
65
     * Return's the path to the additional vendor directory.
66
     *
67
     * @return string The path to the additional vendor directory
68
     */
69
    public function getVendorDir()
70
    {
71
        return $this->vendorDir;
72
    }
73
74
    /**
75
     * Return's an array with the path to additional extension libraries.
76
     *
77
     * @return array The paths to additional extension libraries
78
     */
79
    public function getLibraries()
80
    {
81
        return $this->libraries;
82
    }
83
84
    /**
85
     * Query's whether or not the vendor directory is relative to the installation directory.
86
     *
87
     * @return boolean TRUE if the vendor dir is relative to the installation directory, else FALSE
88
     */
89
    public function isRelative()
90
    {
91
        return $this->relative;
92
    }
93
}
94