File: DateInterval.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 (87 lines) | stat: -rw-r--r-- 3,384 bytes parent folder | download | duplicates (3)
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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="DateInterval" namespace="" name="DateInterval">
  <member name="y" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Number of years."/>
      <var type="integer"/>
    </docblock>
  </member>
  <member name="m" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Number of months."/>
      <var type="integer"/>
    </docblock>
  </member>
  <member name="d" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Number of days."/>
      <var type="integer"/>
    </docblock>
  </member>
  <member name="h" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Number of hours."/>
      <var type="integer"/>
    </docblock>
  </member>
  <member name="i" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Number of minutes."/>
      <var type="integer"/>
    </docblock>
  </member>
  <member name="s" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Number of seconds."/>
      <var type="integer"/>
    </docblock>
  </member>
  <member name="f" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Number of microseconds, as a fraction of a second."/>
      <var type="float"/>
    </docblock>
  </member>
  <member name="invert" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Is 1 if the interval represents a negative time period and 0 otherwise. See DateInterval::format."/>
      <var type="integer"/>
    </docblock>
  </member>
  <member name="days" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="If the DateInterval object was created by DateTime::diff, then this is the total number of days between the start and end dates. Otherwise, days will be FALSE.">If the DateInterval object was created by DateTime::diff, then this is the total number of days between the start and end dates. Otherwise, days will be FALSE.</description>
      <var type="mixed"/>
    </docblock>
  </member>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new DateInterval object"/>
      <return type="void"/>
    </docblock>
    <parameter name="interval_spec" optional="false" byreference="false" type="string"/>
  </constructor>
  <method name="createFromDateString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets up a DateInterval from the relative parts of the string"/>
      <return type="DateInterval"/>
    </docblock>
    <parameter name="time" optional="false" byreference="false" type="string"/>
  </method>
  <method name="format" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Formats the interval"/>
      <return type="string"/>
    </docblock>
    <parameter name="format" optional="false" byreference="false" type="string"/>
  </method>
</class>