File: DateTimeImmutable.xml

package info (click to toggle)
phpdox 0.11.2-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 6,476 kB
  • sloc: xml: 66,377; php: 9,049; makefile: 18
file content (142 lines) | stat: -rw-r--r-- 6,854 bytes parent folder | download
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="DateTimeImmutable" namespace="" name="DateTimeImmutable">
  <implements name="DateTimeInterface" full="DateTimeInterface"/>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns new DateTimeImmutable object">Object oriented style</description>
      <return type="void"/>
    </docblock>
    <parameter name="time" optional="true" byreference="false" type="string"/>
    <parameter name="timezone" optional="true" byreference="false" type="object" class="DateTimeZone"/>
  </constructor>
  <method name="add" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Adds an amount of days, months, years, hours, minutes and seconds&#10;  "/>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="interval" optional="false" byreference="false" type="object" class="DateInterval"/>
  </method>
  <method name="createFromFormat" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Parses a time string according to a specified format">Object oriented style</description>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="format" optional="false" byreference="false" type="string"/>
    <parameter name="time" optional="false" byreference="false" type="string"/>
    <parameter name="timezone" optional="true" byreference="false" type="object" class="DateTimeZone"/>
  </method>
  <method name="createFromMutable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns new DateTimeImmutable object encapsulating the given DateTime object"/>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="datetime" optional="false" byreference="false" type="object" class="DateTime"/>
  </method>
  <method name="getLastErrors" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the warnings and errors"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="modify" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new object with modified timestamp"/>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="modify" optional="false" byreference="false" type="string"/>
  </method>
  <method name="__set_state" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="The __set_state handler"/>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="array" optional="false" byreference="false" type="object" class="array"/>
  </method>
  <method name="setDate" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the date"/>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="year" optional="false" byreference="false" type="int"/>
    <parameter name="month" optional="false" byreference="false" type="int"/>
    <parameter name="day" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setISODate" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the ISO date"/>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="year" optional="false" byreference="false" type="int"/>
    <parameter name="week" optional="false" byreference="false" type="int"/>
    <parameter name="day" optional="true" byreference="false" type="int"/>
  </method>
  <method name="setTime" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the time"/>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="hour" optional="false" byreference="false" type="int"/>
    <parameter name="minute" optional="false" byreference="false" type="int"/>
    <parameter name="second" optional="true" byreference="false" type="int"/>
  </method>
  <method name="setTimestamp" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the date and time based on an Unix timestamp"/>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="unixtimestamp" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setTimezone" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the time zone"/>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="timezone" optional="false" byreference="false" type="object" class="DateTimeZone"/>
  </method>
  <method name="sub" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Subtracts an amount of days, months, years, hours, minutes and seconds&#10;  "/>
      <return type="DateTimeImmutable"/>
    </docblock>
    <parameter name="interval" optional="false" byreference="false" type="object" class="DateInterval"/>
  </method>
  <method name="diff" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="DateInterval"/>
    </docblock>
    <parameter name="datetime2" optional="false" byreference="false" type="object" class="DateTimeInterface"/>
    <parameter name="absolute" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="format" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="string"/>
    </docblock>
    <parameter name="format" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getOffset" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getTimestamp" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getTimezone" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="DateTimeZone"/>
    </docblock>
  </method>
  <method name="__wakeup" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact=""/>
      <return type="void"/>
    </docblock>
  </method>
</class>