File: setinfodateattr.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (169 lines) | stat: -rw-r--r-- 4,532 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
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.harudoc-setinfodateattr" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>HaruDoc::setInfoDateAttr</refname>
  <refpurpose>Set the datetime info attributes of the document</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>HaruDoc::setInfoDateAttr</methodname>
   <methodparam><type>int</type><parameter>type</parameter></methodparam>
   <methodparam><type>int</type><parameter>year</parameter></methodparam>
   <methodparam><type>int</type><parameter>month</parameter></methodparam>
   <methodparam><type>int</type><parameter>day</parameter></methodparam>
   <methodparam><type>int</type><parameter>hour</parameter></methodparam>
   <methodparam><type>int</type><parameter>min</parameter></methodparam>
   <methodparam><type>int</type><parameter>sec</parameter></methodparam>
   <methodparam><type>string</type><parameter>ind</parameter></methodparam>
   <methodparam><type>int</type><parameter>off_hour</parameter></methodparam>
   <methodparam><type>int</type><parameter>off_min</parameter></methodparam>
  </methodsynopsis>
  <para>
   Sets the datetime info attributes of the document.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>type</parameter></term>
     <listitem>
      <para>
       The type of the attribute. Can be one of the following:
       <simplelist>
        <member>
         <constant>HaruDoc::INFO_CREATION_DATE</constant> 
        </member>
        <member>
         <constant>HaruDoc::INFO_MOD_DATE</constant> 
        </member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>year</parameter></term>
     <listitem>
      <para>
       
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>month</parameter></term>
     <listitem>
      <para>
       Between 1 and 12.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>day</parameter></term>
     <listitem>
      <para>
       Between 1 and 31, 30, 29 or 28 (different for each month).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>hour</parameter></term>
     <listitem>
      <para>
       Between 0 and 23.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>min</parameter></term>
     <listitem>
      <para>
       Between 0 and 59.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sec</parameter></term>
     <listitem>
      <para>
       Between 0 and 59.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>ind</parameter></term>
     <listitem>
      <para>
       The timezone relation to UTC, can be "", " ", "+", "-" and "Z".
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>off_hour</parameter></term>
     <listitem>
      <para>
       If <parameter>ind</parameter> is not " " or "", values between 0 and
       23 are valid. Otherwise, this parameter is ignored.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>off_min</parameter></term>
     <listitem>
      <para>
       If <parameter>ind</parameter> is not " " or "", values between 0 and
       59 are valid. Otherwise, this parameter is ignored.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; on success.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  &haru.error;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>HaruDoc::setInfoAttr</methodname></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->