类 RelativeTimeFormatter
用于格式化相对日期和时间的辅助类。
命名空间： Cake\I18n
方法摘要
-
_diffData() protected
计算格式化相对差值字符串所需的数据。
-
_options() protected
构建用于相对日期格式化的选项。
-
dateAgoInWords() public
将日期格式化为相对日期字符串。
-
diffForHumans() public
以人类可读的格式获取差异。
-
timeAgoInWords() public
将日期格式化为相对时间字符串。
方法详情
_diffData() ¶ protected
_diffData(string|int $futureTime, string|int $pastTime, bool $backwards, array<string, mixed> $options): array计算格式化相对差值字符串所需的数据。
参数
-
string|int$futureTime 未来的时间戳。
-
string|int$pastTime 过去的时间戳。
-
bool$backwards 差异是否为反向。
-
array<string, mixed>$options 选项数组。
返回
array_options() ¶ protected
_options(array<string, mixed> $options, string $class): array<string, mixed>构建用于相对日期格式化的选项。
参数
-
array<string, mixed>$options 用户提供的选项。
-
string$class 用于默认值的类名。
返回
array<string, mixed>dateAgoInWords() ¶ public
dateAgoInWords(Cake\I18n\DateTimeCake\I18n\Date $date, array<string, mixed> $options = []): string将日期格式化为相对日期字符串。
参数
-
Cake\I18n\DateTimeCake\I18n\Date$date 要格式化的日期。
-
array<string, mixed>$options optional 选项数组。
返回
string另请参阅
\Cake\I18n\Date::timeAgoInWords()
diffForHumans() ¶ public
diffForHumans(Cake\Chronos\ChronosDateDateTimeInterface $first, Cake\Chronos\ChronosDateDateTimeInterface|null $second = null, bool $absolute = false): string以人类可读的格式获取差异。
参数
-
Cake\Chronos\ChronosDateDateTimeInterface$first 要开始的日期时间。
-
Cake\Chronos\ChronosDateDateTimeInterface|null$second optional 要比较的日期时间。
-
bool$absolute optional 移除时间差修饰符 ago、after 等。
返回
string另请参阅
\Cake\Chronos\Chronos::diffForHumans
timeAgoInWords() ¶ public
timeAgoInWords(Cake\I18n\DateTimeCake\I18n\Date $time, array<string, mixed> $options = []): string将日期格式化为相对时间字符串。
参数
-
Cake\I18n\DateTimeCake\I18n\Date$time 要格式化的时间实例。
-
array<string, mixed>$options optional 选项数组。
返回
string另请参阅
\Cake\I18n\Time::timeAgoInWords()