hphp/runtime/ext/icu/ext_icu_timezone.php

   1 <?hh
   2
   3 <<__NativeData("IntlTimeZone")>>
   4 class IntlTimeZone {
   5
   6   /**
   7    * Objects are only created wit the static create functions
   8    */
   9   public final function __construct() {
  10     throw new Exception("An object of this type cannot be created ".
  11                         "with the new operator");
  12   }
  13
  14   /**
  15    * Get the number of IDs in the equivalency group that includes the given
  16    * ID
  17    *
  18    * @param string $zoneId -
  19    *
  20    * @return integer -
  21    */
  22   <<__Native>>
  23   public static function countEquivalentIDs(string $zoneId): mixed;
  24
  25   <<__Native>>
  26   public static
  27   function createTimeZoneIDEnumeration(int $zonetype,
  28                                        string $region = "",
  29                                        ?int $offset = null): mixed;
  30
  31   /**
  32    * Create a new copy of the default timezone for this host
  33    *
  34    * @return IntlTimeZone -
  35    */
  36   <<__Native>>
  37   public static function createDefault(): IntlTimeZone;
  38
  39   /**
  40    * Get an enumeration over time zone IDs associated with the
  41    *   given country or offset
  42    *
  43    * @param mixed $countryOrRawOffset -
  44    *
  45    * @return IntlIterator -
  46    */
  47   <<__Native>>
  48   public static
  49   function createEnumeration(mixed $countryOrRawOffset = null): mixed;
  50
  51   /**
  52    * Create a timezone object for the given ID
  53    *
  54    * @param string $zoneId -
  55    *
  56    * @return IntlTimeZone -
  57    */
  58   <<__Native>>
  59   public static
  60   function createTimeZone(string $zoneId): IntlTimeZone;
  61
  62   /**
  63    * Create a timezone object from
  64    *
  65    * @param DateTimeZone $zoneId -
  66    *
  67    * @return IntlTimeZone -
  68    */
  69   public static
  70   function fromDateTimeZone(DateTimeZone $zoneId): IntlTimeZone {
  71     return self::createTimeZone($zoneId->name());
  72   }
  73
  74   /**
  75    * Get the canonical system timezone ID or the normalized custom time zone
  76    * ID for the given time zone ID
  77    *
  78    * @param string $zoneId -
  79    * @param bool $isSystemID -
  80    *
  81    * @return string -
  82    */
  83   <<__Native>>
  84   public static
  85   function getCanonicalID(string $zoneId, mixed &$isSystemID = null): mixed;
  86
  87
  88   <<__Native>>
  89   public static function getRegion(string $str): mixed;
  90
  91   /**
  92    * Get a name of this time zone suitable for presentation to the user
  93    *
  94    * @param bool $isDaylight -
  95    * @param integer $style -
  96    * @param string $locale -
  97    *
  98    * @return string -
  99    */
 100   <<__Native>>
 101   public function getDisplayName(bool $isDaylight = false,
 102                                  int $style = IntlTimeZone::DISPLAY_LONG,
 103                                  string $locale = ""): mixed;
 104
 105   /**
 106    * Get the amount of time to be added to local standard time to get local
 107    * wall clock time
 108    *
 109    * @return integer -
 110    */
 111   <<__Native>>
 112   public function getDSTSavings(): int;
 113
 114   /**
 115    * Get an ID in the equivalency group that includes the given ID
 116    *
 117    * @param string $zoneId -
 118    * @param integer $index -
 119    *
 120    * @return string -
 121    */
 122   <<__Native>>
 123   public static function getEquivalentID(string $zoneId,
 124                                          int $index): mixed;
 125
 126   /**
 127    * Get last error code on the object
 128    *
 129    * @return integer -
 130    */
 131   <<__Native>>
 132   public function getErrorCode(): int;
 133
 134   /**
 135    * Get last error message on the object
 136    *
 137    * @return string -
 138    */
 139   <<__Native>>
 140   public function getErrorMessage(): string;
 141
 142   /**
 143    * Create GMT (UTC) timezone
 144    *
 145    * @return IntlTimeZone -
 146    */
 147   <<__Native>>
 148   public static function getGMT(): IntlTimeZone;
 149
 150   <<__Native>>
 151   public static function getUnknown(): IntlTimeZone;
 152
 153   /**
 154    * Get timezone ID
 155    *
 156    * @return string -
 157    */
 158   <<__Native>>
 159   public function getID(): mixed;
 160
 161   /**
 162    * Get the time zone raw and GMT offset for the given moment in time
 163    *
 164    * @param float $date -
 165    * @param bool $local -
 166    * @param integer $rawOffset -
 167    * @param integer $dstOffset -
 168    *
 169    * @return integer -
 170    */
 171   <<__Native>>
 172   public function getOffset(float $date,
 173                             bool $local,
 174                             int &$rawOffset,
 175                             int &$dstOffset): bool;
 176
 177   /**
 178    * Get the raw GMT offset (before taking daylight savings time into
 179    * account
 180    *
 181    * @return integer -
 182    */
 183   <<__Native>>
 184   public function getRawOffset(): mixed;
 185
 186   /**
 187    * Get the timezone data version currently used by ICU
 188    *
 189    * @return string -
 190    */
 191   <<__Native>>
 192   public static function getTZDataVersion(): mixed;
 193
 194   /**
 195    * Check if this zone has the same rules and offset as another zone
 196    *
 197    * @param IntlTimeZone $otherTimeZone -
 198    *
 199    * @return bool -
 200    */
 201   <<__Native>>
 202   public function hasSameRules(IntlTimeZone $otherTimeZone): bool;
 203
 204   /**
 205    * Convert to  object
 206    *
 207    * @return DateTimeZone -
 208    */
 209   public function toDateTimeZone(): DateTimeZone {
 210     $id = $this->getID();
 211     if (!strncmp($id, "GMT", 3)) {
 212       throw new Exception("Converting IntlTimeZone to DateTimeZone ".
 213                           "is not currently supported for GMT offsets");
 214     }
 215     return new DateTimeZone($id);
 216   }
 217
 218   /**
 219    * Check if this time zone uses daylight savings time
 220    *
 221    * @return bool -
 222    */
 223   <<__Native>>
 224   public function useDaylightTime(): bool;
 225 }
 226
 227 /**
 228  * Get the number of IDs in the equivalency group that includes the given
 229  * ID
 230  *
 231  * @param string $zoneId -
 232  *
 233  * @return integer -
 234  */
 235 function intltz_count_equivalent_ids(string $zoneId): mixed {
 236   return IntlTimeZone::countEquivalentIDs($zoneId);
 237 }
 238
 239 function intltz_create_time_zone_id_enumeration(
 240                                          int $zonetype,
 241                                          string $region = "",
 242                                          ?int $offset = null): mixed {
 243   return IntlTimeZone::createTimeZoneIDEnumeration($zonetype,
 244                                                    $region, $offset);
 245 }
 246
 247 /**
 248  * Create a new copy of the default timezone for this host
 249  *
 250  * @return IntlTimeZone -
 251  */
 252 function intltz_create_default(): IntlTimeZone {
 253   return IntlTimeZone::createDefault();
 254 }
 255
 256 /**
 257  * Get an enumeration over time zone IDs associated with the
 258  *   given country or offset
 259  *
 260  * @param mixed $countryOrRawOffset -
 261  *
 262  * @return IntlIterator -
 263  */
 264 function intltz_create_enumeration(mixed $countryOrRawOffset = null): mixed {
 265   return IntlTimeZone::createEnumeration($countryOrRawOffset);
 266 }
 267
 268 /**
 269  * Create a timezone object for the given ID
 270  *
 271  * @param string $zoneId -
 272  *
 273  * @return IntlTimeZone -
 274  */
 275 function intltz_create_time_zone(string $zoneId): IntlTimeZone {
 276   return IntlTimeZone::createTimeZone($zoneId);
 277 }
 278
 279 /**
 280  * Create a timezone object from
 281  *
 282  * @param DateTimeZone $zoneId -
 283  *
 284  * @return IntlTimeZone -
 285  */
 286 function intltz_from_date_time_zone(DateTimeZone $zoneId): IntlTimeZone {
 287   return IntlTimeZone::fromDateTimeZone($zoneId);
 288 }
 289
 290 /**
 291  * Get the canonical system timezone ID or the normalized custom time zone
 292  * ID for the given time zone ID
 293  *
 294  * @param string $zoneId -
 295  * @param bool $isSystemID -
 296  *
 297  * @return string -
 298  */
 299 function intltz_get_canonical_id(string $zoneId,
 300                                  mixed &$isSystemID = null): mixed {
 301   return IntlTimeZone::getCanonicalID($zoneId, $isSystemID);
 302 }
 303
 304 function intltz_get_region(string $str): mixed {
 305   return IntlTimeZone::getRegion($str);
 306 }
 307
 308 /**
 309  * Get a name of this time zone suitable for presentation to the user
 310  *
 311  * @param bool $isDaylight -
 312  * @param integer $style -
 313  * @param string $locale -
 314  *
 315  * @return string -
 316  */
 317 function intltz_get_display_name(IntlTimeZone $obj,
 318                                  bool $isDaylight = false,
 319                                  int $style = IntlTimeZone::DISPLAY_LONG,
 320                                  string $locale = ""): mixed {
 321   return $obj->getDisplayName($isDaylight, $style, $locale);
 322 }
 323
 324 /**
 325  * Get the amount of time to be added to local standard time to get local
 326  * wall clock time
 327  *
 328  * @return integer -
 329  */
 330 function intltz_get_dst_savings(IntlTimeZone $obj): int {
 331   return $obj->getDSTSavings();
 332 }
 333
 334 /**
 335  * Get an ID in the equivalency group that includes the given ID
 336  *
 337  * @param string $zoneId -
 338  * @param integer $index -
 339  *
 340  * @return string -
 341  */
 342 function intltz_get_equivalent_id(string $zoneId,
 343                                   int $index): mixed {
 344   return IntlTimeZone::getEquivalentID($zoneId, $index);
 345 }
 346
 347 /**
 348  * Get last error code on the object
 349  *
 350  * @return integer -
 351  */
 352 function intltz_get_error_code(IntlTimeZone $obj): int {
 353   return $obj->getErrorCode();
 354 }
 355
 356 /**
 357  * Get last error message on the object
 358  *
 359  * @return string -
 360  */
 361 function intltz_get_error_message(IntlTimeZone $obj): string {
 362   return $obj->getErrorMessage();
 363 }
 364
 365 /**
 366  * Create GMT (UTC) timezone
 367  *
 368  * @return IntlTimeZone -
 369  */
 370 function intltz_get_gmt(): IntlTimeZone {
 371   return IntlTimeZone::getGMT();
 372 }
 373
 374 function intltz_get_unknown(): IntlTimeZone {
 375   return IntlTimeZone::getUnknown();
 376 }
 377
 378 /**
 379  * Get timezone ID
 380  *
 381  * @return string -
 382  */
 383 function intltz_get_id(IntlTimeZone $obj): string {
 384   return $obj->getID();
 385 }
 386
 387 /**
 388  * Get the time zone raw and GMT offset for the given moment in time
 389  *
 390  * @param float $date -
 391  * @param bool $local -
 392  * @param integer $rawOffset -
 393  * @param integer $dstOffset -
 394  *
 395  * @return integer -
 396  */
 397 function intltz_get_offset(IntlTimeZone $obj,
 398                            float $date,
 399                            bool $local,
 400                            int &$rawOffset,
 401                            int &$dstOffset): bool {
 402   return $obj->getOffset($date, $local, $rawOffset, $dstOffset);
 403 }
 404
 405 /**
 406  * Get the raw GMT offset (before taking daylight savings time into
 407  * account
 408  *
 409  * @return integer -
 410  */
 411 function intltz_get_raw_offset(IntlTimeZone $obj): mixed {
 412   return $obj->getRawOffset();
 413 }
 414
 415 /**
 416  * Get the timezone data version currently used by ICU
 417  *
 418  * @return string -
 419  */
 420 function intltz_get_tz_data_version(): mixed {
 421   return IntlTimeZone::getTZDataVersion();
 422 }
 423
 424 /**
 425  * Check if this zone has the same rules and offset as another zone
 426  *
 427  * @param IntlTimeZone $otherTimeZone -
 428  *
 429  * @return bool -
 430  */
 431 function intltz_has_same_rules(IntlTimeZone $obj,
 432                                IntlTimeZone $otherTimeZone): bool {
 433   return $obj->hasSameRules($otherTimeZone);
 434 }
 435
 436 /**
 437  * Convert to  object
 438  *
 439  * @return DateTimeZone -
 440  */
 441 function intltz_to_date_time_zone(IntlTimeZone $obj): DateTimeZone {
 442   return $obj->toDateTimeZone();
 443 }
 444
 445 /**
 446  * Check if this time zone uses daylight savings time
 447  *
 448  * @return bool -
 449  */
 450 function intltz_use_daylight_time(IntlTimeZone $obj): bool {
 451   return $obj->useDaylightTime();
 452 }