-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathConfigInterface.php
More file actions
70 lines (62 loc) · 2.12 KB
/
ConfigInterface.php
File metadata and controls
70 lines (62 loc) · 2.12 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
<?php
/**
* This file is part of skillshare/formatphp
*
* skillshare/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>
* @license https://opensource.org/licenses/MIT MIT License
*/
declare(strict_types=1);
namespace FormatPHP;
use FormatPHP\Extractor\IdInterpolator;
use FormatPHP\Intl\LocaleInterface;
/**
* FormatPHP configuration
*/
interface ConfigInterface
{
/**
* Returns default locale to use, if unable to support the requested locale
*/
public function getDefaultLocale(): ?LocaleInterface;
/**
* Returns a map of tag names to rich text formatting functions
*
* This is meant to provide a centralized way to format common tags such as
* `<b>`, `<p>`, or enforcing a certain design system in the codebase
* (e.g., standardized `<a>`, `<button>`, etc.).
*
* The functions should be a callable that accepts a single string parameter
* and returns a string. For example:
*
* ```php
* [
* 'em' => fn (string $text): string => '<em class="bar">' . $text . '</em>',
* 'strong' => fn (string $text): string => '<strong class="foo">' . $text . '</strong>',
* ]
* ```
*
* @return array<string, callable(string):string>
*/
public function getDefaultRichTextElements(): array;
/**
* Returns a pattern that defines how to generate missing message IDs
*
* @see IdInterpolator
*/
public function getIdInterpolatorPattern(): string;
/**
* Returns locale to use for translation and localization
*/
public function getLocale(): LocaleInterface;
}