IntlCalendar::getActualMaximum

(PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1)

IntlCalendar::getActualMaximum — O valor máximo para um campo, considerando o horário atual do objeto

Descrição

Estilo orientado a objetos

public IntlCalendar::getActualMaximum(int $field): int|false

Estilo procedural

intlcal_get_actual_maximum(IntlCalendar $calendar, int $field): int|false

Retorna o valor máximo relativo de um campo em relação ao horário atual. A semântica exata varia por campo, mas em geral é o valor que seria obtido se fosse definido o valor do campo para o menor máximo relativo para o campo e fosse incrementado até alcançar o máximo global ou até que o valor do campo retorne ao inicial, no qual o valor retornado seria o máximo global ou o valor antes de retornar ao incial, respectivamente.

Por exemplo, no calendário gregoriano, o valor máximo real para o dia do mês pode variar entre 28 e 31, dependendo do mês e do ano do horário atual.

Parâmetros

calendar

Uma instância de IntlCalendar.

field

Uma das constantes de campo de data/horário da classe IntlCalendar. São valores inteiros entre 0 e IntlCalendar::FIELD_COUNT.

Valor Retornado

Um número int representando o valor máximo na unidade associada ao parâmetro field informado ou false em caso de falha.

Exemplos

Example #1 IntlCalendar::getActualMaximum()

<?php
ini_set('date.timezone', 'Europe/Lisbon');

$cal = IntlCalendar::fromDateTime('2013-02-15');
var_dump($cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)); //28

$cal->add(IntlCalendar::FIELD_EXTENDED_YEAR, -1);
var_dump($cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)); //29

O exemplo acima produzirá:

int(28)
int(29)

Veja Também