File: IntlTimeZone.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (180 lines) | stat: -rw-r--r-- 8,718 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="IntlTimeZone" namespace="" name="IntlTimeZone">
  <constant name="DISPLAY_SHORT" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <constant name="DISPLAY_LONG" value="2">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <method name="countEquivalentIDs" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the number of IDs in the equivalency group that includes the given ID"/>
      <return type="int"/>
    </docblock>
    <parameter name="zoneId" optional="false" byreference="false" type="string"/>
  </method>
  <method name="createDefault" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a new copy of the default timezone for this host"/>
      <return type="IntlTimeZone"/>
    </docblock>
  </method>
  <method name="createEnumeration" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get an enumeration over time zone IDs associated with the&#10;  given country or offset"/>
      <return type="IntlIterator"/>
    </docblock>
    <parameter name="countryOrRawOffset" optional="true" byreference="false" type="object" class="mixed"/>
  </method>
  <method name="createTimeZone" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a timezone object for the given ID"/>
      <return type="IntlTimeZone"/>
    </docblock>
    <parameter name="zoneId" optional="false" byreference="false" type="string"/>
  </method>
  <method name="createTimeZoneIDEnumeration" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get an enumeration over system time zone IDs with the given filter conditions"/>
      <return type="IntlIterator"/>
    </docblock>
    <parameter name="zoneType" optional="false" byreference="false" type="int"/>
    <parameter name="region" optional="true" byreference="false" type="string"/>
    <parameter name="rawOffset" optional="true" byreference="false" type="int"/>
  </method>
  <method name="fromDateTimeZone" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a timezone object from DateTimeZone"/>
      <return type="IntlTimeZone"/>
    </docblock>
    <parameter name="zoneId" optional="false" byreference="false" type="object" class="DateTimeZone"/>
  </method>
  <method name="getCanonicalID" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID"/>
      <return type="string"/>
    </docblock>
    <parameter name="zoneId" optional="false" byreference="false" type="string"/>
    <parameter name="isSystemID" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="getDisplayName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get a name of this time zone suitable for presentation to the user"/>
      <return type="string"/>
    </docblock>
    <parameter name="isDaylight" optional="true" byreference="false" type="object" class="bool"/>
    <parameter name="style" optional="true" byreference="false" type="int"/>
    <parameter name="locale" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getDSTSavings" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the amount of time to be added to local standard time to get local wall clock time"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getEquivalentID" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get an ID in the equivalency group that includes the given ID"/>
      <return type="string"/>
    </docblock>
    <parameter name="zoneId" optional="false" byreference="false" type="string"/>
    <parameter name="index" optional="false" byreference="false" type="int"/>
  </method>
  <method name="getErrorCode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get last error code on the object">Object oriented style (method):</description>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getErrorMessage" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get last error message on the object">Object oriented style (method):</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getGMT" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create GMT (UTC) timezone"/>
      <return type="IntlTimeZone"/>
    </docblock>
  </method>
  <method name="getID" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get timezone ID"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getIDForWindowsID" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Translate a Windows timezone into a system timezone"/>
      <return type="string"/>
    </docblock>
    <parameter name="timezone" optional="false" byreference="false" type="string"/>
    <parameter name="region" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getOffset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the time zone raw and GMT offset for the given moment in time"/>
      <return type="int"/>
    </docblock>
    <parameter name="date" optional="false" byreference="false" type="object" class="float"/>
    <parameter name="local" optional="false" byreference="false" type="object" class="bool"/>
    <parameter name="rawOffset" optional="false" byreference="false" type="int"/>
    <parameter name="dstOffset" optional="false" byreference="false" type="int"/>
  </method>
  <method name="getRawOffset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the raw GMT offset (before taking daylight savings time into account"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getRegion" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the region code associated with the given system time zone ID"/>
      <return type="string"/>
    </docblock>
    <parameter name="zoneId" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getTZDataVersion" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the timezone data version currently used by ICU"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getUnknown" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the &quot;unknown&quot; time zone"/>
      <return type="IntlTimeZone"/>
    </docblock>
  </method>
  <method name="getWindowsID" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Translate a system timezone into a Windows timezone"/>
      <return type="string"/>
    </docblock>
    <parameter name="timezone" optional="false" byreference="false" type="string"/>
  </method>
  <method name="hasSameRules" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check if this zone has the same rules and offset as another zone"/>
      <return type="bool"/>
    </docblock>
    <parameter name="otherTimeZone" optional="false" byreference="false" type="object" class="IntlTimeZone"/>
  </method>
  <method name="toDateTimeZone" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Convert to DateTimeZone object"/>
      <return type="DateTimeZone"/>
    </docblock>
  </method>
  <method name="useDaylightTime" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check if this time zone uses daylight savings time"/>
      <return type="bool"/>
    </docblock>
  </method>
</class>