forked from WordPress/phpdoc-parser
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathImportConfig.php
More file actions
131 lines (117 loc) · 2.84 KB
/
ImportConfig.php
File metadata and controls
131 lines (117 loc) · 2.84 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
<?php
namespace Aivec\Plugins\DocParser\Models;
use JsonSerializable;
/**
* Represents an import configuration
*/
class ImportConfig implements JsonSerializable
{
/**
* The sources type (`plugin`, `theme`, or `composer-package`)
*
* @var string
*/
private $source_type;
/**
* The plugin/theme/composer-package name
*
* @var string
*/
private $name;
/**
* The plugin/theme/composer-package version
*
* @var null|string
*/
private $version;
/**
* Array of files/folders to exclude from import
*
* @var array
*/
private $exclude;
/**
* Whether to exclude a file/folder in subdirectories as well
*
* @var bool
*/
private $exclude_strict;
/**
* Initializes an import config
*
* @author Evan D Shaw <evandanielshaw@gmail.com>
* @param string $source_type
* @param string $name
* @param null|string $version
* @param array $exclude
* @param bool $exclude_strict
* @return void
*/
public function __construct($source_type, $name, $version = null, $exclude = [], $exclude_strict = false) {
$this->source_type = $source_type;
$this->name = $name;
$this->version = $version;
$this->exclude = $exclude;
$this->exclude_strict = $exclude_strict;
}
/**
* Serializes instance data for `json_encode`
*
* @author Evan D Shaw <evandanielshaw@gmail.com>
* @return array
*/
public function jsonSerialize() {
return [
'type' => $this->source_type,
'name' => $this->name,
'version' => $this->version,
'exclude' => $this->exclude,
'excludeStrict' => $this->exclude_strict,
];
}
/**
* Getter for `$this->source_type`
*
* @author Evan D Shaw <evandanielshaw@gmail.com>
* @return string
*/
public function getSourceType() {
return $this->source_type;
}
/**
* Getter for `$this->name`
*
* @author Evan D Shaw <evandanielshaw@gmail.com>
* @return string
*/
public function getName() {
return $this->name;
}
/**
* Getter for `$this->version`
*
* @author Evan D Shaw <evandanielshaw@gmail.com>
* @return null|string
*/
public function getVersion() {
return $this->version;
}
/**
* Getter for `$this->exclude`
*
* @author Evan D Shaw <evandanielshaw@gmail.com>
* @return array
*/
public function getExclude() {
return $this->exclude;
}
/**
* Getter for `$this->exclude_strict`
*
* @author Evan D Shaw <evandanielshaw@gmail.com>
* @return bool
*/
public function getExcludeStrict() {
return $this->exclude_strict;
}
}