forked from Skillshare/formatphp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDescriptorParserInterface.php
More file actions
53 lines (48 loc) · 1.93 KB
/
DescriptorParserInterface.php
File metadata and controls
53 lines (48 loc) · 1.93 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
<?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\Extractor\Parser;
use FormatPHP\DescriptorCollection;
use FormatPHP\Exception\UnableToProcessFileException;
use FormatPHP\Extractor\MessageExtractorOptions;
/**
* Parses message descriptors from application source code files
*
* @phpstan-type DescriptorParserCallable callable(string,MessageExtractorOptions,ParserErrorCollection):DescriptorCollection
* @phpstan-type DescriptorParserType DescriptorParserInterface | DescriptorParserCallable
*/
interface DescriptorParserInterface
{
/**
* Returns a collection of descriptors parsed from a source code file
*
* @param string $filePath The path to the source code file to parse
* @param MessageExtractorOptions $options Options to apply to message extraction
* @param ParserErrorCollection $errors Errors encountered during extraction
* (add any additional errors that occur to this collection)
*
* @throws UnableToProcessFileException
*/
public function __invoke(
string $filePath,
MessageExtractorOptions $options,
ParserErrorCollection $errors
): DescriptorCollection;
}