IntlCalendar::getLeastMaximum

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

IntlCalendar::getLeastMaximumGet the smallest local maximum for a field

Description

Object-oriented style

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

Procedural style

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

Returns the smallest local maximumw for a field. This should be a value smaller or equal to that returned by IntlCalendar::getActualMaxmimum(), which is in its turn smaller or equal to that returned by IntlCalendar::getMaximum().

Parameters

calendar

An IntlCalendar instance.

field

One of the IntlCalendar date/time field constants. These are integer values between 0 and IntlCalendar::FIELD_COUNT.

Return Values

An int representing a field value in the fieldʼs unit or false on failure.

Examples

Example #1 Maxima examples

<?php
ini_set
('date.timezone''UTC');
ini_set('intl.default_locale''it_IT');

$cal = new IntlGregorianCalendar(2013/* April */6);
var_dump(
    
$cal->getLeastMaximum(IntlCalendar::FIELD_DAY_OF_MONTH),  // 28
    
$cal->getActualMaximum(IntlCalendar::FIELD_DAY_OF_MONTH), // 30
    
$cal->getMaximum(IntlCalendar::FIELD_DAY_OF_MONTH)        // 31
);

The above example will output:

int(28)
int(30)
int(31)

See Also