forked from Skillshare/formatphp
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDateTimeFormatInterface.php
More file actions
47 lines (42 loc) · 1.57 KB
/
DateTimeFormatInterface.php
File metadata and controls
47 lines (42 loc) · 1.57 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
<?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\Intl;
use DateTimeInterface;
use FormatPHP\Exception\UnableToFormatDateTimeException;
/**
* A date formatter designed to fit within the style and function of
* ECMA-402 formatters
*
* @link https://unicode-org.github.io/icu/userguide/format_parse/datetime/
* @link https://www.php.net/IntlDateFormatter
* @link https://tc39.es/ecma402/#datetimeformat-objects
* @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat
*/
interface DateTimeFormatInterface
{
/**
* Formats a date or time, using a locale configured with the date/time
* format instance
*
* @throws UnableToFormatDateTimeException
*/
public function format(DateTimeInterface $date): string;
}