Class Calendar

$value

A Unix timestamp, a \DateTimeInterface instance or a string accepted by strtotime.

$toTimezone

the timezone to set; leave empty to use the value of $fromTimezone (if it's empty we'll use the default timezone or the timezone associated to $value if it's already a \DateTimeInterface)

$fromTimezone

the original timezone of $value; leave empty to use the default timezone (or the timezone associated to $value if it's already a \DateTimeInterface)

Convert a Unix timestamp to a \DateTime instance with the current time zone:

\Punic\Calendar::toDateTime(1409648286);

Convert a Unix timestamp to a \DateTime instance with a specific time zone:

\Punic\Calendar::toDateTime(1409648286, 'Europe/Rome');
\Punic\Calendar::toDateTime(1409648286, new \DateTimeZone('Europe/Rome'));

Convert a string to a \DateTime instance with the current time zone:

\Punic\Calendar::toDateTime('2014-03-07 13:30');

Convert a string to a \DateTime instance with a specific time zone:

\Punic\Calendar::toDateTime('2014-03-07 13:30', 'Europe/Rome');

Please remark that in this case '2014-03-07 13:30' is converted to a \DateTime instance with the current timezone, and after we change the timezone. So, if your system default timezone is 'America/Los_Angeles' (GMT -8), the resulting date/time will be '2014-03-07 22:30 GMT+1' since it'll be converted to 'Europe/Rome' (GMT +1)

$format

the PHP date/time format string to convert

$isoDateTimeFormat

The PHP date/time format

$value

the year number or the \DateTimeInterface instance for which you want the name of the era

$width

the format name; it can be 'wide' (eg 'Before Christ'), 'abbreviated' (eg 'BC') or 'narrow' (eg 'B')

$locale

The locale to use. If empty we'll use the default locale set with \Punic\Data::setDefaultLocale().

$value

the month number (1-12) or a \DateTimeInterface instance for which you want the name of the month

$width

the format name; it can be 'wide' (eg 'January'), 'abbreviated' (eg 'Jan') or 'narrow' (eg 'J')

$locale

The locale to use. If empty we'll use the default locale set with \Punic\Data::setDefaultLocale().

$standAlone

set to true to return the form used independently (such as in calendar header), set to false if the month name will be part of a date

$value

a week day number (from 0-Sunday to 6-Saturnday) or a \DateTimeInterface instance for which you want the name of the day of the week

$width

the format name; it can be 'wide' (eg 'Sunday'), 'abbreviated' (eg 'Sun'), 'short' (eg 'Su') or 'narrow' (eg 'S')

$locale

The locale to use. If empty we'll use the default locale set with \Punic\Data::setDefaultLocale().

$standAlone

set to true to return the form used independently (such as in calendar header), set to false if the week day name will be part of a date

$value

a quarter number (from 1 to 4) or a \DateTimeInterface instance for which you want the name of the day of the quarter

$width

the format name; it can be 'wide' (eg '1st quarter'), 'abbreviated' (eg 'Q1') or 'narrow' (eg '1')

$locale

The locale to use. If empty we'll use the default locale set with \Punic\Data::setDefaultLocale().

$standAlone

set to true to return the form used independently (such as in calendar header), set to false if the quarter name will be part of a date

$value

an hour (from 0 to 23), a standard period name ('am' or 'pm', lower or upper case) a \DateTimeInterface instance for which you want the name of the day period

$width

the format name; it can be 'wide' (eg 'AM'), 'abbreviated' (eg 'AM') or 'narrow' (eg 'a')

$locale

The locale to use. If empty we'll use the default locale set with \Punic\Data::setDefaultLocale().

$standAlone

set to true to return the form used independently (such as in calendar header), set to false if the day period name will be part of a date

$value

an hour (from 0 to 23), a \DateTimeInterface instance for which you want the name of the day period

$width

the format name; it can be 'wide', 'abbreviated' or 'narrow'

$locale

The locale to use. If empty we'll use the default locale set with \Punic\Data::setDefaultLocale().

$standAlone

set to true to return the form used independently (e.g. "morning"), set to false if the day period name will be part of a date (e.g. "in the morning")

$value

the PHP name of a timezone, a \DateTimeInterface instance or a \DateTimeZone instance for which you want the localized timezone name

$width

the format name; it can be 'long' (eg 'Greenwich Mean Time') or 'short' (eg 'GMT')

$kind

set to 'daylight' to retrieve the daylight saving time name, set to 'standard' to retrieve the standard time, set to 'generic' to retrieve the generic name, set to '' to determine automatically the dst (if $value is \DateTime) or the generic (otherwise)

$locale

The locale to use. If empty we'll use the default locale set with \Punic\Data::setDefaultLocale().

$value

the php name of a timezone, or a \DateTime instance or a \DateTimeZone instance for which you want the localized timezone name

$locale

The locale to use. If empty we'll use the default locale set with \Punic\Data::setDefaultLocale().

$value

The PHP name of a timezone, a \DateTimeInterface instance or a \DateTimeZone instance

$returnUnknownIfNotFound

true If the exemplar city is not found, shall we return the translation of 'Unknown City'?

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$namesWidth

If false you'll get only the list of weekday identifiers (for instance: [0, 1, 2, 3, 4, 5, 6]), If it's a string it must be one accepted by Punic\Calendar::getWeekdayName(), and you'll get an array like this: [{id: 0, name: 'Monday', ..., {id: 6, name: 'Sunday'}]

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$width

The format name; it can be 'full' (eg 'EEEE, MMMM d, y' - 'Wednesday, August 20, 2014'), 'long' (eg 'MMMM d, y' - 'August 20, 2014'), 'medium' (eg 'MMM d, y' - 'August 20, 2014') or 'short' (eg 'M/d/yy' - '8/20/14'), or a skeleton pattern prefixed by '~', e.g. '~yMd'.

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$width

The format name; it can be 'full' (eg 'h:mm:ss a zzzz' - '11:42:13 AM GMT+2:00'), 'long' (eg 'h:mm:ss a z' - '11:42:13 AM GMT+2:00'), 'medium' (eg 'h:mm:ss a' - '11:42:13 AM') or 'short' (eg 'h:mm a' - '11:42 AM'), or a skeleton pattern prefixed by '~', e.g. '~Hm'.

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$width

The format name; it can be 'full', 'long', 'medium', 'short' or a combination for date+time like 'full|short' or a combination for format+date+time like 'full|full|short', or a skeleton pattern prefixed by '~', e.g. '~yMd'.

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$skeleton

The locale-independent skeleton, e.g. "yMMMd" or "Hm".

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$skeleton

The locale-independent skeleton, e.g. "yMMMd" or "Hm".

$greatestDifference

The calendar field with the greatest distance between the two dates. Must be one of the fields mentioned in $differenceFields.

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data.

an array with two entries: - string: The ISO interval format - bool|null: Whether the earliest date is the first of the two dates in the pattern, or null if the dates are identical within the granularity specified by the skeleton

$dateEnd

The first date

$dateStart

The final date (if it has a timezone different than $dateEnd, we'll use the one of $dateEnd)

$dateEnd

The first date

$dateStart

The final date (if it has a timezone different than $dateEnd, we'll use the one of $dateEnd)

$maxParts

The maximim parts (eg with 2 you may have '2 days and 4 hours', with 3 '2 days, 4 hours and 24 minutes')

$width

The format name; it can be 'long' (eg '3 seconds'), 'short' (eg '3 s') or 'narrow' (eg '3s')

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$value

The \DateTimeInterface instance for which you want the localized textual representation

$width

The format name; it can be 'full' (eg 'EEEE, MMMM d, y' - 'Wednesday, August 20, 2014'), 'long' (eg 'MMMM d, y' - 'August 20, 2014'), 'medium' (eg 'MMM d, y' - 'August 20, 2014') or 'short' (eg 'M/d/yy' - '8/20/14'), or a skeleton pattern prefixed by '~', e.g. '~yMd'. You can also append a caret ('^') or an asterisk ('') to $width. If so, special day names may be used (like 'Today', 'Yesterday', 'Tomorrow' with '^' and 'today', 'yesterday', 'tomorrow' width '') instead of the date.

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$value

A Unix timestamp, a \DateTimeInterface instance or a string accepted by strtotime.

$width

The format name; it can be 'full' (eg 'EEEE, MMMM d, y' - 'Wednesday, August 20, 2014'), 'long' (eg 'MMMM d, y' - 'August 20, 2014'), 'medium' (eg 'MMM d, y' - 'August 20, 2014') or 'short' (eg 'M/d/yy' - '8/20/14'), or a skeleton pattern prefixed by '~', e.g. '~yMd'. You can also append a caret ('^') or an asterisk ('') to $width. If so, special day names may be used (like 'Today', 'Yesterday', 'Tomorrow' with '^' and 'today', 'yesterday', 'tomorrow' width '') instead of the date.

$toTimezone

The timezone to set; leave empty to use the default timezone (or the timezone associated to $value if it's already a \DateTime)

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$value

The \DateTimeInterface instance for which you want the localized textual representation

$width

The format name; it can be 'full' (eg 'h:mm:ss a zzzz' - '11:42:13 AM GMT+2:00'), 'long' (eg 'h:mm:ss a z' - '11:42:13 AM GMT+2:00'), 'medium' (eg 'h:mm:ss a' - '11:42:13 AM') or 'short' (eg 'h:mm a' - '11:42 AM'), or a skeleton pattern prefixed by '~', e.g. '~Hm'.

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$value

A Unix timestamp, a \DateTimeInterface instance or a string accepted by strtotime.

$width

The format name; it can be 'full' (eg 'h:mm:ss a zzzz' - '11:42:13 AM GMT+2:00'), 'long' (eg 'h:mm:ss a z' - '11:42:13 AM GMT+2:00'), 'medium' (eg 'h:mm:ss a' - '11:42:13 AM') or 'short' (eg 'h:mm a' - '11:42 AM'), or a skeleton pattern prefixed by '~', e.g. '~Hm'.

$toTimezone

The timezone to set; leave empty to use the default timezone (or the timezone associated to $value if it's already a \DateTime)

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$value

The \DateTimeInterface instance for which you want the localized textual representation

$width

The format name; it can be 'full', 'long', 'medium', 'short' or a skeleton pattern prefixed by '~', or a combination for date+time like 'full|short' or a combination for format+date+time like 'full|full|short' You can also append an asterisk ('*') to the date parh of $width. If so, special day names may be used (like 'Today', 'Yesterday', 'Tomorrow') instead of the date part.

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$value

A Unix timestamp, a \DateTimeInterface instance or a string accepted by strtotime.

$width

The format name; it can be 'full', 'long', 'medium', 'short' or a combination for date+time like 'full|short' or a combination for format+date+time like 'full|full|short' You can also append an asterisk ('*') to the date parh of $width. If so, special day names may be used (like 'Today', 'Yesterday', 'Tomorrow') instead of the date part.

$toTimezone

The timezone to set; leave empty to use the default timezone (or the timezone associated to $value if it's already a \DateTime)

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$earliest

the first date of the interval

$latest

The last date of the

$skeleton

The locale-independent skeleton, e.g. "yMMMd" or "Hm".

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data.

$earliest

An Unix timestamp, a \DateTime instance or a string accepted by strtotime.

$latest

An Unix timestamp, a \DateTime instance or a string accepted by strtotime.

$skeleton

The locale-independent skeleton, e.g. "yMMMd" or "Hm".

$toTimezone

The timezone to set; leave empty to use the default timezone (or the timezone associated to $value if it's already a \DateTime)

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data.

$value

The \DateTimeInterface instance for which you want the localized textual representation

$format

The ISO format that specify how to render the date/time. The following extra format chunks are available: - 'P': ISO-8601 numeric representation of the day of the week (same as 'e' but not locale dependent) - 'PP': Numeric representation of the day of the week, from 0 (for Sunday) to 6 (for Saturday) - 'PPP': English ordinal suffix for the day of the month - 'PPPP': The day of the year (starting from 0) - 'PPPPP': Number of days in the given month - 'PPPPPP': Whether it's a leap year: 1 if it is a leap year, 0 otherwise. - 'PPPPPPP': Lowercase Ante meridiem and Post meridiem (English only, for other locales it's the same as 'a') - 'PPPPPPPP': Swatch Internet time - 'PPPPPPPPP': Microseconds - 'PPPPPPPPPP': Whether or not the date is in daylight saving time 1 if Daylight Saving Time, 0 otherwise. - 'PPPPPPPPPPP': Timezone offset in seconds - 'PPPPPPPPPPPP': RFC 2822 formatted date (Example: 'Thu, 21 Dec 2000 16:01:07 +0200') - 'PPPPPPPPPPPPP': Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$value

A Unix timestamp, a \DateTimeInterface instance or a string accepted by strtotime.

$format

The ISO format that specify how to render the date/time. The following extra format chunks are valid: - 'P': ISO-8601 numeric representation of the day of the week (same as 'e' but not locale dependent) - 'PP': Numeric representation of the day of the week, from 0 (for Sunday) to 6 (for Saturday) - 'PPP': English ordinal suffix for the day of the month - 'PPPP': The day of the year (starting from 0) - 'PPPPP': Number of days in the given month - 'PPPPPP': Whether it's a leap year: 1 if it is a leap year, 0 otherwise. - 'PPPPPPP': Lowercase Ante meridiem and Post meridiem (English only, for other locales it's the same as 'a') - 'PPPPPPPP': Swatch Internet time - 'PPPPPPPPP': Microseconds - 'PPPPPPPPPP': Whether or not the date is in daylight saving time 1 if Daylight Saving Time, 0 otherwise. - 'PPPPPPPPPPP': Timezone offset in seconds - 'PPPPPPPPPPPP': RFC 2822 formatted date (Example: 'Thu, 21 Dec 2000 16:01:07 +0200') - 'PPPPPPPPPPPPP': Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)

$toTimezone

The timezone to set; leave empty to use the default timezone (or the timezone associated to $value if it's already a \DateTime)

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data

$datetime

The date for which you want the relative day name

$ucFirst

Force first letter to be upper case?

$locale

The locale to use. If empty we'll use the default locale set in \Punic\Data