[php] Add externs for the date/time classes (#9910)

* [php] Add the `DateInterval` class extern

* [php] Add the `DateTimeZone` class extern

* [php] Add the `DateTimeInterface` interface extern

* [php] Add the `DatePeriod` class extern

* [php] Add the `DateTime` class extern

* [php] Add the `DateTimeImmutable` class extern

* [php] The question mark is not required when a default value is provided

std/php/DateInterval.hx

@@ -0,0 +1,45 @@
+/*
+ * Copyright (C)2005-2020 Haxe Foundation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+package php;
+
+import haxe.extern.EitherType;
+
+/**
+	@see https://www.php.net/manual/en/class.dateinterval.php
+**/
+@:native("DateInterval")
+extern class DateInterval {
+	var y: Int;
+	var m: Int;
+	var d: Int;
+	var h: Int;
+	var i: Int;
+	var s: Int;
+	var f: Float;
+	var invert: Int;
+	var days: EitherType<Int, Bool>;
+
+	function new(duration: String);
+	static function createFromDateString(datetime: String): DateInterval;
+	function format(format: String): String;
+}

std/php/DatePeriod.hx

@@ -0,0 +1,47 @@
+/*
+ * Copyright (C)2005-2020 Haxe Foundation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+package php;
+
+/**
+	@see https://www.php.net/manual/en/class.dateperiod.php
+**/
+@:native("DatePeriod")
+extern class DatePeriod {
+	@:phpClassConst static final EXCLUDE_START_DATE: Int;
+
+	var recurrences: Int;
+	var include_start_date: Bool;
+	var start: DateTimeInterface;
+	var current: DateTimeInterface;
+	var end: Null<DateTimeInterface>;
+	var interval: DateInterval;
+
+	@:overload(function(start: DateTimeInterface, interval: DateInterval, recurrences: Int, ?options: Int): Void {})
+	@:overload(function(start: DateTimeInterface, interval: DateInterval, end: DateTimeInterface, ?options: Int): Void {})
+	function new(isostr: String, ?options: Int);
+
+	function getDateInterval(): DateInterval;
+	function getEndDate(): Null<DateTimeInterface>;
+	function getRecurrences(): Int;
+	function getStartDate(): DateTimeInterface;
+}

std/php/DateTime.hx

@@ -0,0 +1,65 @@
+/*
+ * Copyright (C)2005-2020 Haxe Foundation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+package php;
+
+import haxe.extern.EitherType;
+
+/**
+	@see https://www.php.net/manual/en/class.datetime.php
+**/
+@:native("DateTime")
+extern class DateTime implements DateTimeInterface {
+	@:phpClassConst static final ATOM: Int;
+	@:phpClassConst static final COOKIE: Int;
+	@:phpClassConst static final ISO8601: Int;
+	@:phpClassConst static final RFC822: Int;
+	@:phpClassConst static final RFC850: Int;
+	@:phpClassConst static final RFC1036: Int;
+	@:phpClassConst static final RFC1123: Int;
+	@:phpClassConst static final RFC7231: Int;
+	@:phpClassConst static final RFC2822: Int;
+	@:phpClassConst static final RFC3339: Int;
+	@:phpClassConst static final RFC3339_EXTENDED: Int;
+	@:phpClassConst static final RSS: Int;
+	@:phpClassConst static final W3C: Int;
+
+	function new(datetime: String = "now", ?timezone: DateTimeZone);
+	function add(interval: DateInterval): EitherType<DateTime, Bool>;
+	static function createFromFormat(format : String, datetime: String, ?timezone: DateTimeZone): EitherType<DateTime, Bool>;
+	static function createFromImmutable(object: DateTimeImmutable): DateTime;
+	static function getLastErrors(): NativeAssocArray<Dynamic>;
+	function diff(targetObject: DateTimeInterface, absolute: Bool = false): EitherType<DateInterval, Bool>;
+	function format(format: String): EitherType<String, Bool>;
+	function getOffset(): EitherType<Int, Bool>;
+	function getTimestamp(): Int;
+	function getTimezone(): EitherType<DateTimeZone, Bool>;
+	function modify(modifier: String): EitherType<DateTime, Bool>;
+	function setDate(year: Int, month: Int, day: Int): EitherType<DateTime, Bool>;
+	function setISODate(year: Int, week: Int, dayOfWeek: Int = 1): EitherType<DateTime, Bool>;
+	function setTime(hour: Int, minute: Int, second: Int = 0, microsecond: Int = 0): EitherType<DateTime, Bool>;
+	function setTimestamp(timestamp: Int): EitherType<DateTime, Bool>;
+	function setTimezone(timezone: DateTimeZone): EitherType<DateTime, Bool>;
+	function sub(interval: DateInterval): EitherType<DateTime, Bool>;
+	@:phpMagic static function __set_state(array: NativeAssocArray<Any>): DateTime;
+	@:phpMagic function __wakeup(): Void;
+}

std/php/DateTimeImmutable.hx

@@ -0,0 +1,65 @@
+/*
+ * Copyright (C)2005-2020 Haxe Foundation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+package php;
+
+import haxe.extern.EitherType;
+
+/**
+	@see https://www.php.net/manual/en/class.datetimeimmutable.php
+**/
+@:native("DateTimeImmutable")
+extern class DateTimeImmutable implements DateTimeInterface {
+	@:phpClassConst static final ATOM: Int;
+	@:phpClassConst static final COOKIE: Int;
+	@:phpClassConst static final ISO8601: Int;
+	@:phpClassConst static final RFC822: Int;
+	@:phpClassConst static final RFC850: Int;
+	@:phpClassConst static final RFC1036: Int;
+	@:phpClassConst static final RFC1123: Int;
+	@:phpClassConst static final RFC7231: Int;
+	@:phpClassConst static final RFC2822: Int;
+	@:phpClassConst static final RFC3339: Int;
+	@:phpClassConst static final RFC3339_EXTENDED: Int;
+	@:phpClassConst static final RSS: Int;
+	@:phpClassConst static final W3C: Int;
+
+	function new(datetime: String = "now", ?timezone: DateTimeZone);
+	function add(interval: DateInterval): EitherType<DateTimeImmutable, Bool>;
+	static function createFromFormat(format : String, datetime: String, ?timezone: DateTimeZone): EitherType<DateTimeImmutable, Bool>;
+	static function createFromMutable(object: DateTime): DateTimeImmutable;
+	static function getLastErrors(): NativeAssocArray<Dynamic>;
+	function diff(targetObject: DateTimeInterface, absolute: Bool = false): EitherType<DateInterval, Bool>;
+	function format(format: String): EitherType<String, Bool>;
+	function getOffset(): EitherType<Int, Bool>;
+	function getTimestamp(): Int;
+	function getTimezone(): EitherType<DateTimeZone, Bool>;
+	function modify(modifier: String): EitherType<DateTimeImmutable, Bool>;
+	function setDate(year: Int, month: Int, day: Int): EitherType<DateTimeImmutable, Bool>;
+	function setISODate(year: Int, week: Int, dayOfWeek: Int = 1): EitherType<DateTimeImmutable, Bool>;
+	function setTime(hour: Int, minute: Int, second: Int = 0, microsecond: Int = 0): EitherType<DateTimeImmutable, Bool>;
+	function setTimestamp(timestamp: Int): EitherType<DateTimeImmutable, Bool>;
+	function setTimezone(timezone: DateTimeZone): EitherType<DateTimeImmutable, Bool>;
+	function sub(interval: DateInterval): EitherType<DateTimeImmutable, Bool>;
+	@:phpMagic static function __set_state(array: NativeAssocArray<Any>): DateTimeImmutable;
+	@:phpMagic function __wakeup(): Void;
+}

std/php/DateTimeInterface.hx

@@ -0,0 +1,52 @@
+/*
+ * Copyright (C)2005-2020 Haxe Foundation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+package php;
+
+import haxe.extern.EitherType;
+
+/**
+	@see https://www.php.net/manual/en/class.datetimeinterface.php
+**/
+@:native("DateTimeInterface")
+extern interface DateTimeInterface {
+	@:phpClassConst static final ATOM: Int;
+	@:phpClassConst static final COOKIE: Int;
+	@:phpClassConst static final ISO8601: Int;
+	@:phpClassConst static final RFC822: Int;
+	@:phpClassConst static final RFC850: Int;
+	@:phpClassConst static final RFC1036: Int;
+	@:phpClassConst static final RFC1123: Int;
+	@:phpClassConst static final RFC7231: Int;
+	@:phpClassConst static final RFC2822: Int;
+	@:phpClassConst static final RFC3339: Int;
+	@:phpClassConst static final RFC3339_EXTENDED: Int;
+	@:phpClassConst static final RSS: Int;
+	@:phpClassConst static final W3C: Int;
+
+	function diff(targetObject: DateTimeInterface, absolute: Bool = false): EitherType<DateInterval, Bool>;
+	function format(format: String): EitherType<String, Bool>;
+	function getOffset(): EitherType<Int, Bool>;
+	function getTimestamp(): Int;
+	function getTimezone(): EitherType<DateTimeZone, Bool>;
+	@:phpMagic function __wakeup(): Void;
+}

std/php/DateTimeZone.hx

@@ -0,0 +1,54 @@
+/*
+ * Copyright (C)2005-2020 Haxe Foundation
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+package php;
+
+import haxe.extern.EitherType;
+
+/**
+	@see https://www.php.net/manual/en/class.datetimezone.php
+**/
+@:native("DateTimeZone")
+extern class DateTimeZone {
+	@:phpClassConst static final AFRICA: Int;
+	@:phpClassConst static final AMERICA: Int;
+	@:phpClassConst static final ANTARCTICA: Int;
+	@:phpClassConst static final ARCTIC: Int;
+	@:phpClassConst static final ASIA: Int;
+	@:phpClassConst static final ATLANTIC: Int;
+	@:phpClassConst static final AUSTRALIA: Int;
+	@:phpClassConst static final EUROPE: Int;
+	@:phpClassConst static final INDIAN: Int;
+	@:phpClassConst static final PACIFIC: Int;
+	@:phpClassConst static final UTC: Int;
+	@:phpClassConst static final ALL: Int;
+	@:phpClassConst static final ALL_WITH_BC: Int;
+	@:phpClassConst static final PER_COUNTRY: Int;
+
+	function new(timezone: String);
+	function getLocation(): EitherType<NativeAssocArray<Dynamic>, Bool>;
+	function getName(): String;
+	function getOffset(datetime: DateTimeInterface): EitherType<Int, Bool>;
+	function getTransitions(?timestampBegin: Int, ?timestampEnd: Int): EitherType<NativeIndexedArray<NativeAssocArray<Dynamic>>, Bool>;
+	static function listAbbreviations(): EitherType<NativeAssocArray<NativeIndexedArray<NativeAssocArray<Dynamic>>>, Bool>;
+	static function listIdentifiers(?timezoneGroup: Int, ?countryCode: String): EitherType<NativeIndexedArray<String>, Bool>;
+}