forked from Skillshare/formatphp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathExtendedDescriptorInterface.php
More file actions
66 lines (57 loc) · 1.83 KB
/
ExtendedDescriptorInterface.php
File metadata and controls
66 lines (57 loc) · 1.83 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
<?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;
/**
* Extended descriptor information
*/
interface ExtendedDescriptorInterface extends DescriptorInterface
{
/**
* Returns the filename where the descriptor appears
*/
public function getSourceFile(): ?string;
/**
* Returns the file code string offset of the first character where the
* descriptor appears
*/
public function getSourceStartOffset(): ?int;
/**
* Returns the file code string offset of the last character where the
* descriptor appears
*/
public function getSourceEndOffset(): ?int;
/**
* Returns the line number on which the descriptor starts
*/
public function getSourceLine(): ?int;
/**
* Sets metadata related to this descriptor
*
* @param array<string, string> $metadata
*/
public function setMetadata(array $metadata): void;
/**
* Returns metadata related to this descriptor
*
* @return array<string, string>
*/
public function getMetadata(): array;
}