File: DatePeriod.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 (97 lines) | stat: -rw-r--r-- 4,267 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
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="DatePeriod" namespace="" name="DatePeriod">
  <implements name="Traversable" full="Traversable"/>
  <constant name="EXCLUDE_START_DATE" value="1">
    <docblock>
      <var type="integer"/>
    </docblock>
  </constant>
  <member name="recurrences" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The number of recurrences."/>
      <var type="integer"/>
    </docblock>
  </member>
  <member name="include_start_date" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Whether to include the start date in the set of recurring dates or not."/>
      <var type="boolean"/>
    </docblock>
  </member>
  <member name="start" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The start date of the period."/>
      <var type="DateTimeInterface"/>
    </docblock>
  </member>
  <member name="current" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="During iteration this will contain the current date within the period."/>
      <var type="DateTimeInterface"/>
    </docblock>
  </member>
  <member name="end" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The end date of the period."/>
      <var type="DateTimeInterface"/>
    </docblock>
  </member>
  <member name="interval" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="An ISO 8601 repeating interval specification."/>
      <var type="DateInterval"/>
    </docblock>
  </member>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new DatePeriod object"/>
      <return type="void"/>
    </docblock>
    <parameter name="start" optional="false" byreference="false" type="object" class="DateTimeInterface"/>
    <parameter name="interval" optional="false" byreference="false" type="object" class="DateInterval"/>
    <parameter name="recurrences" optional="false" byreference="false" type="int"/>
    <parameter name="options" optional="true" byreference="false" type="int"/>
  </constructor>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new DatePeriod object"/>
      <return type="void"/>
    </docblock>
    <parameter name="start" optional="false" byreference="false" type="object" class="DateTimeInterface"/>
    <parameter name="interval" optional="false" byreference="false" type="object" class="DateInterval"/>
    <parameter name="end" optional="false" byreference="false" type="object" class="DateTimeInterface"/>
    <parameter name="options" optional="true" byreference="false" type="int"/>
  </constructor>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Creates a new DatePeriod object"/>
      <return type="void"/>
    </docblock>
    <parameter name="isostr" optional="false" byreference="false" type="string"/>
    <parameter name="options" optional="true" byreference="false" type="int"/>
  </constructor>
  <method name="getDateInterval" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Gets the interval&#10;  ">Object oriented style</description>
      <return type="DateInterval"/>
    </docblock>
  </method>
  <method name="getEndDate" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Gets the end date&#10;  ">Object oriented style</description>
      <return type="DateTimeInterface"/>
    </docblock>
  </method>
  <method name="getStartDate" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Gets the start date&#10;  ">Object oriented style</description>
      <return type="DateTimeInterface"/>
    </docblock>
  </method>
</class>