IntlCalendar::add

[edit] Last updated: Fri, 28 Jun 2013

The IntlCalendar class

(PHP 5.5.0, PECL >= 3.0.0a1)

Introduction

Class synopsis

IntlCalendar {

/* Constants */

const integer FIELD_ERA = 0 ;

const integer FIELD_YEAR = 1 ;

const integer FIELD_MONTH = 2 ;

const integer FIELD_WEEK_OF_YEAR = 3 ;

const integer FIELD_WEEK_OF_MONTH = 4 ;

const integer FIELD_DATE = 5 ;

const integer FIELD_DAY_OF_YEAR = 6 ;

const integer FIELD_DAY_OF_WEEK = 7 ;

const integer FIELD_DAY_OF_WEEK_IN_MONTH = 8 ;

const integer FIELD_AM_PM = 9 ;

const integer FIELD_HOUR = 10 ;

const integer FIELD_HOUR_OF_DAY = 11 ;

const integer FIELD_MINUTE = 12 ;

const integer FIELD_SECOND = 13 ;

const integer FIELD_MILLISECOND = 14 ;

const integer FIELD_ZONE_OFFSET = 15 ;

const integer FIELD_DST_OFFSET = 16 ;

const integer FIELD_YEAR_WOY = 17 ;

const integer FIELD_DOW_LOCAL = 18 ;

const integer FIELD_EXTENDED_YEAR = 19 ;

const integer FIELD_JULIAN_DAY = 20 ;

const integer FIELD_MILLISECONDS_IN_DAY = 21 ;

const integer FIELD_IS_LEAP_MONTH = 22 ;

const integer FIELD_FIELD_COUNT = 23 ;

const integer FIELD_DAY_OF_MONTH = 5 ;

const integer DOW_SUNDAY = 1 ;

const integer DOW_MONDAY = 2 ;

const integer DOW_TUESDAY = 3 ;

const integer DOW_WEDNESDAY = 4 ;

const integer DOW_THURSDAY = 5 ;

const integer DOW_FRIDAY = 6 ;

const integer DOW_SATURDAY = 7 ;

const integer DOW_TYPE_WEEKDAY = 0 ;

const integer DOW_TYPE_WEEKEND = 1 ;

const integer DOW_TYPE_WEEKEND_OFFSET = 2 ;

const integer DOW_TYPE_WEEKEND_CEASE = 3 ;

const integer WALLTIME_FIRST = 1 ;

const integer WALLTIME_LAST = 0 ;

const integer WALLTIME_NEXT_VALID = 2 ;

/* Methods */

public bool add ( int $field , int $amount )

public bool after ( IntlCalendar $calendar )

public bool before ( IntlCalendar $calendar )

public bool clear ([ int $field = NULL ] )

private __construct ( void )

public static IntlCalendar createInstance ([ mixed $timeZone = NULL [, string $locale = NULL ]] )

public bool equals ( IntlCalendar $calendar )

public int fieldDifference ( float $when , int $field )

public static IntlCalendar fromDateTime ( mixed $dateTime )

public int get ( int $field )

public int getActualMaximum ( int $field )

public int getActualMinimum ( int $field )

public static array getAvailableLocales ( void )

public int getDayOfWeekType ( int $dayOfWeek )

public int getErrorCode ( void )

int intlcal_get_error_code ( IntlCalendar $calendar )

public string getErrorMessage ( void )

string intlcal_get_error_message ( IntlCalendar $calendar )

public int getFirstDayOfWeek ( void )

public int getGreatestMinimum ( int $field )

public static Iterator getKeywordValuesForLocale ( string $key , string $locale , boolean $commonlyUsed )

public int getLeastMaximum ( int $field )

public string getLocale ( int $localeType )

public int getMaximum ( int $field )

public int getMinimalDaysInFirstWeek ( void )

public int getMinimum ( int $field )

public static float getNow ( void )

public int getRepeatedWallTimeOption ( void )

public int getSkippedWallTimeOption ( void )

public float getTime ( void )

public IntlTimeZone getTimeZone ( void )

public string getType ( void )

public int getWeekendTransition ( string $dayOfWeek )

public bool inDaylightTime ( void )

public bool isEquivalentTo ( IntlCalendar $calendar )

public bool isLenient ( void )

public bool isSet ( int $field )

public bool isWeekend ([ float $date = NULL ] )

public bool roll ( int $field , mixed $amountOrUpOrDown = TRUE )

public bool set ( int $field , int $value )

public bool set ( int $year , int $month [, int $dayOfMonth = NULL [, int $hour = NULL [, int $minute = NULL [, int $second = NULL ]]]] )

public bool setFirstDayOfWeek ( int $dayOfWeek )

public ReturnType setLenient ( string $isLenient )

public bool setRepeatedWallTimeOption ( int $wallTimeOption )

public bool setSkippedWallTimeOption ( int $wallTimeOption )

public bool setTime ( float $date )

public bool setTimeZone ( mixed $timeZone )

public DateTime toDateTime ( void )

}

Predefined Constants

IntlCalendar::FIELD_ERA
IntlCalendar::FIELD_YEAR
IntlCalendar::FIELD_MONTH
IntlCalendar::FIELD_WEEK_OF_YEAR
IntlCalendar::FIELD_WEEK_OF_MONTH
IntlCalendar::FIELD_DATE
IntlCalendar::FIELD_DAY_OF_YEAR
IntlCalendar::FIELD_DAY_OF_WEEK
IntlCalendar::FIELD_DAY_OF_WEEK_IN_MONTH
IntlCalendar::FIELD_AM_PM
IntlCalendar::FIELD_HOUR
IntlCalendar::FIELD_HOUR_OF_DAY
IntlCalendar::FIELD_MINUTE
IntlCalendar::FIELD_SECOND
IntlCalendar::FIELD_MILLISECOND
IntlCalendar::FIELD_ZONE_OFFSET
IntlCalendar::FIELD_DST_OFFSET
IntlCalendar::FIELD_YEAR_WOY
IntlCalendar::FIELD_DOW_LOCAL
IntlCalendar::FIELD_EXTENDED_YEAR
IntlCalendar::FIELD_JULIAN_DAY
IntlCalendar::FIELD_MILLISECONDS_IN_DAY
IntlCalendar::FIELD_IS_LEAP_MONTH
IntlCalendar::FIELD_FIELD_COUNT
IntlCalendar::FIELD_DAY_OF_MONTH
IntlCalendar::DOW_SUNDAY
IntlCalendar::DOW_MONDAY
IntlCalendar::DOW_TUESDAY
IntlCalendar::DOW_WEDNESDAY
IntlCalendar::DOW_THURSDAY
IntlCalendar::DOW_FRIDAY
IntlCalendar::DOW_SATURDAY
IntlCalendar::DOW_TYPE_WEEKDAY
IntlCalendar::DOW_TYPE_WEEKEND
IntlCalendar::DOW_TYPE_WEEKEND_OFFSET
IntlCalendar::DOW_TYPE_WEEKEND_CEASE
IntlCalendar::WALLTIME_FIRST
IntlCalendar::WALLTIME_LAST
IntlCalendar::WALLTIME_NEXT_VALID

IntlCalendar::add — Add a (signed) amount of time to a field
IntlCalendar::after — Whether this objectʼs time is after that of the passed object
IntlCalendar::before — Whether this objectʼs time is before that of the passed object
IntlCalendar::clear — Clear a field or all fields
IntlCalendar::__construct — Private constructor for disallowing instantiation
IntlCalendar::createInstance — Create a new IntlCalendar
IntlCalendar::equals — Compare time of two IntlCalendar objects for equality
IntlCalendar::fieldDifference — Calculate difference between given time and this objectʼs time
IntlCalendar::fromDateTime — Create an IntlCalendar from a DateTime object or string
IntlCalendar::get — Get the value for a field
IntlCalendar::getActualMaximum — The maximum value for a field, considering the objectʼs current time
IntlCalendar::getActualMinimum — The minimum value for a field, considering the objectʼs current time
IntlCalendar::getAvailableLocales — Get array of locales for which there is data
IntlCalendar::getDayOfWeekType — Tell whether a day is a weekday, weekend or a day that has a transition between the two
IntlCalendar::getErrorCode — Get last error code on the object
IntlCalendar::getErrorMessage — Get last error message on the object
IntlCalendar::getFirstDayOfWeek — Get the first day of the week for the calendarʼs locale
IntlCalendar::getGreatestMinimum — Get the largest local minimum value for a field
IntlCalendar::getKeywordValuesForLocale — Get set of locale keyword values
IntlCalendar::getLeastMaximum — Get the smallest local maximum for a field
IntlCalendar::getLocale — Get the locale associated with the object
IntlCalendar::getMaximum — Get the global maximum value for a field
IntlCalendar::getMinimalDaysInFirstWeek — Get minimal number of days the first week in a year can have
IntlCalendar::getMinimum — Get the global minimum value for a field
IntlCalendar::getNow — Get number representing the current time
IntlCalendar::getRepeatedWallTimeOption — Get behavior for handling repeating wall time
IntlCalendar::getSkippedWallTimeOption — Get behavior for handling skipped wall time
IntlCalendar::getTime — Get time currently represented by the object
IntlCalendar::getTimeZone — Get the objectʼs timezone
IntlCalendar::getType — Get the calendar type
IntlCalendar::getWeekendTransition — Get time of the day at which weekend begins or ends
IntlCalendar::inDaylightTime — Whether the objectʼs time is in Daylight Savings Time
IntlCalendar::isEquivalentTo — Whether another calendar is equal but for a different time
IntlCalendar::isLenient — Whether date/time interpretation is in lenient mode
IntlCalendar::isSet — Whether a field is set
IntlCalendar::isWeekend — Whether a certain date/time is in the weekend
IntlCalendar::roll — Add value to field without carrying into more significant fields
IntlCalendar::set — Set a time field or several common fields at once
IntlCalendar::setFirstDayOfWeek — Set the day on which the week is deemed to start
IntlCalendar::setLenient — Set whether date/time interpretation is to be lenient
IntlCalendar::setRepeatedWallTimeOption — Set behavior for handling repeating wall times at negative timezone offset transitions
IntlCalendar::setSkippedWallTimeOption — Set behavior for handling skipped wall times at positive timezone offset transitions
IntlCalendar::setTime — Set the calendar time in milliseconds since the epoch
IntlCalendar::setTimeZone — Set the timezone used by this calendar
IntlCalendar::toDateTime — Convert an IntlCalendar into a DateTime object

add a note User Contributed Notes IntlCalendar - [0 notes]

There are no user contributed notes for this page.

The IntlCalendar class

Introduction

Class synopsis

Predefined Constants

Table of Contents