forked from Skillshare/formatphp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDescriptor.php
More file actions
148 lines (130 loc) · 4.22 KB
/
Descriptor.php
File metadata and controls
148 lines (130 loc) · 4.22 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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?php
/**
* This file is part of formatphp/formatphp
*
* formatphp/formatphp is open source software: you can distribute
* it and/or modify it under the terms of the MIT License
* (the "License"). You may not use this file except in
* compliance with the License.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License.
*
* @copyright Copyright (c) Skillshare, Inc. <https://www.skillshare.com>
* @copyright Copyright (c) FormatPHP Contributors <https://formatphp.dev>
* @license https://opensource.org/licenses/MIT MIT License
*/
declare(strict_types=1);
namespace FormatPHP;
/**
* FormatPHP descriptor
*/
class Descriptor implements ExtendedDescriptorInterface
{
private ?string $defaultMessage;
private ?string $description;
private ?string $id;
private ?string $sourceFile;
private ?int $sourceStartOffset;
private ?int $sourceEndOffset;
private ?int $sourceLine;
/**
* @var array<string, string>
*/
private array $metadata = [];
/**
* @param string | null $id The descriptor identifier
* @param string | null $defaultMessage The default message for the descriptor
* @param string | null $description A description to give translators more context/information about this message
* @param string | null $sourceFile The source file in which the descriptor appears
* @param int | null $sourceStartOffset The string offset in the source file where the descriptor begins
* @param int | null $sourceEndOffset The string offset in the source file where the descriptor ends
* @param int | null $sourceLine The line number in the source file where the descriptor begins
*/
public function __construct(
?string $id = null,
?string $defaultMessage = null,
?string $description = null,
?string $sourceFile = null,
?int $sourceStartOffset = null,
?int $sourceEndOffset = null,
?int $sourceLine = null
) {
$this->id = $id;
$this->defaultMessage = $defaultMessage;
$this->description = $description;
$this->sourceFile = $sourceFile;
$this->sourceStartOffset = $sourceStartOffset;
$this->sourceEndOffset = $sourceEndOffset;
$this->sourceLine = $sourceLine;
}
public function getDefaultMessage(): ?string
{
return $this->defaultMessage;
}
public function setDefaultMessage(string $defaultMessage): void
{
$this->defaultMessage = $defaultMessage;
}
public function getDescription(): ?string
{
return $this->description;
}
public function getId(): ?string
{
return $this->id;
}
public function setId(string $id): void
{
$this->id = $id;
}
public function getSourceFile(): ?string
{
return $this->sourceFile;
}
public function getSourceStartOffset(): ?int
{
return $this->sourceStartOffset;
}
public function getSourceEndOffset(): ?int
{
return $this->sourceEndOffset;
}
public function getSourceLine(): ?int
{
return $this->sourceLine;
}
/**
* @return array{defaultMessage: string | null, description: string | null, end: int | null, file: string | null, id: string | null, line: int | null, meta: array<string, string>, start: int | null}
*/
public function toArray(): array
{
return [
'defaultMessage' => $this->defaultMessage,
'description' => $this->description,
'end' => $this->sourceEndOffset,
'file' => $this->sourceFile,
'id' => $this->id,
'line' => $this->sourceLine,
'meta' => $this->metadata,
'start' => $this->sourceStartOffset,
];
}
/**
* @inheritdoc
*/
public function setMetadata(array $metadata): void
{
$this->metadata = $metadata;
}
/**
* @inheritdoc
*/
public function getMetadata(): array
{
return $this->metadata;
}
}