Skip to content

Commit 999f1f3

Browse files
FilipJaniszewskiFilipJaniszewski
committed
Fixing docs
1 parent 1566c7e commit 999f1f3

File tree

6 files changed

+438
-0
lines changed

6 files changed

+438
-0
lines changed

‎docbook/mysql_xdevapi/baseresult/getwarningscount.xml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
4+
<refentry xml:id="mysql-xdevapi-baseresult.getwarningscount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5+
<refnamediv>
6+
<refname>BaseResult::getWarningsCount</refname>
7+
<refpurpose>Fetch warning count from last operation</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis>
13+
<modifier>abstract</modifier> <modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\BaseResult::getWarningsCount</methodname>
14+
<void />
15+
</methodsynopsis>
16+
<para>
17+
Returns the number of warnings raised by the last operation. Specifically,
18+
these warnings are raised by the MySQL server.
19+
</para>
20+
21+
</refsect1>
22+
23+
<refsect1 role="parameters">
24+
&reftitle.parameters;
25+
&no.function.parameters;
26+
</refsect1>
27+
28+
<refsect1 role="returnvalues">
29+
&reftitle.returnvalues;
30+
<para>
31+
The number of warnings from the last operation.
32+
</para>
33+
</refsect1>
34+
35+
36+
</refentry>
37+
38+
<!-- Keep this comment at the end of the file
39+
Local variables:
40+
mode: sgml
41+
sgml-omittag:t
42+
sgml-shorttag:t
43+
sgml-minimize-attributes:nil
44+
sgml-always-quote-attributes:t
45+
sgml-indent-step:1
46+
sgml-indent-data:t
47+
indent-tabs-mode:nil
48+
sgml-parent-document:nil
49+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
50+
sgml-exposed-tags:nil
51+
sgml-local-catalogs:nil
52+
sgml-local-ecat-files:nil
53+
End:
54+
vim600: syn=xml fen fdm=syntax fdl=2 si
55+
vim: et tw=78 syn=sgml
56+
vi: ts=1 sw=1
57+
-->

‎docbook/mysql_xdevapi/collectionfind/offset.xml

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
4+
<refentry xml:id="mysql-xdevapi-collectionfind.offset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5+
<refnamediv>
6+
<refname>CollectionFind::offset</refname>
7+
<refpurpose>Skip given number of elements to be returned</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis>
13+
<modifier>public</modifier> <type>mysql_xdevapi\CollectionFind</type><methodname>mysql_xdevapi\CollectionFind::offset</methodname>
14+
<methodparam><type>integer</type><parameter>position</parameter></methodparam>
15+
</methodsynopsis>
16+
<para>
17+
For the result set of a find operation, skip the first N elements that would be returned by the find operation.
18+
If the amout of element skipped is bigger than the size of the result set then the find operation will return an empty set.
19+
</para>
20+
21+
</refsect1>
22+
23+
<refsect1 role="parameters">
24+
&reftitle.parameters;
25+
<variablelist>
26+
<varlistentry>
27+
<term><parameter>position</parameter></term>
28+
<listitem>
29+
<para>
30+
Number of elements to skip.
31+
</para>
32+
</listitem>
33+
</varlistentry>
34+
</variablelist>
35+
</refsect1>
36+
37+
<refsect1 role="returnvalues">
38+
&reftitle.returnvalues;
39+
<para>
40+
CollectionFind object that can be used for further processing.
41+
</para>
42+
</refsect1>
43+
44+
<refsect1 role="examples">
45+
&reftitle.examples;
46+
<example>
47+
<title><function>mysql_xdevapi\CollectionFind::offset</function> example</title>
48+
<programlisting role="php">
49+
<![CDATA[
50+
<?php
51+
52+
//Assuming $coll is a valid Collection object
53+
54+
//Find all the documents for which the 'job' field is equal to 'Programmatore', skip the first 3
55+
$res = $coll->find('job like \'Programmatore\'')->offset(3)->execute();
56+
57+
?>
58+
]]>
59+
</programlisting>
60+
</example>
61+
</refsect1>
62+
63+
64+
</refentry>
65+
66+
<!-- Keep this comment at the end of the file
67+
Local variables:
68+
mode: sgml
69+
sgml-omittag:t
70+
sgml-shorttag:t
71+
sgml-minimize-attributes:nil
72+
sgml-always-quote-attributes:t
73+
sgml-indent-step:1
74+
sgml-indent-data:t
75+
indent-tabs-mode:nil
76+
sgml-parent-document:nil
77+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
78+
sgml-exposed-tags:nil
79+
sgml-local-catalogs:nil
80+
sgml-local-ecat-files:nil
81+
End:
82+
vim600: syn=xml fen fdm=syntax fdl=2 si
83+
vim: et tw=78 syn=sgml
84+
vi: ts=1 sw=1
85+
-->

‎docbook/mysql_xdevapi/docresult/getwarningscount.xml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
4+
<refentry xml:id="mysql-xdevapi-docresult.getwarningcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5+
<refnamediv>
6+
<refname>DocResult::getWarningsCount</refname>
7+
<refpurpose>Get warning count from last operation</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis>
13+
<modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\DocResult::getWarningsCount</methodname>
14+
<void />
15+
</methodsynopsis>
16+
<para>
17+
18+
</para>
19+
20+
&warn.undocumented.func;
21+
22+
</refsect1>
23+
24+
<refsect1 role="parameters">
25+
&reftitle.parameters;
26+
&no.function.parameters;
27+
</refsect1>
28+
29+
<refsect1 role="returnvalues">
30+
&reftitle.returnvalues;
31+
<para>
32+
33+
</para>
34+
</refsect1>
35+
36+
<refsect1 role="examples">
37+
&reftitle.examples;
38+
<example>
39+
<title><function>mysql_xdevapi\DocResult::getWarningsCount</function> example</title>
40+
<programlisting role="php">
41+
<![CDATA[
42+
<?php
43+
44+
/* ... */
45+
46+
?>
47+
]]>
48+
</programlisting>
49+
</example>
50+
</refsect1>
51+
52+
53+
</refentry>
54+
55+
<!-- Keep this comment at the end of the file
56+
Local variables:
57+
mode: sgml
58+
sgml-omittag:t
59+
sgml-shorttag:t
60+
sgml-minimize-attributes:nil
61+
sgml-always-quote-attributes:t
62+
sgml-indent-step:1
63+
sgml-indent-data:t
64+
indent-tabs-mode:nil
65+
sgml-parent-document:nil
66+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
67+
sgml-exposed-tags:nil
68+
sgml-local-catalogs:nil
69+
sgml-local-ecat-files:nil
70+
End:
71+
vim600: syn=xml fen fdm=syntax fdl=2 si
72+
vim: et tw=78 syn=sgml
73+
vi: ts=1 sw=1
74+
-->

‎docbook/mysql_xdevapi/result/getwarningscount.xml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
4+
<refentry xml:id="mysql-xdevapi-result.getwarningcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5+
<refnamediv>
6+
<refname>Result::getWarningsCount</refname>
7+
<refpurpose>Get warning count from last operation</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis>
13+
<modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\Result::getWarningsCount</methodname>
14+
<void />
15+
</methodsynopsis>
16+
<para>
17+
18+
</para>
19+
20+
&warn.undocumented.func;
21+
22+
</refsect1>
23+
24+
<refsect1 role="parameters">
25+
&reftitle.parameters;
26+
&no.function.parameters;
27+
</refsect1>
28+
29+
<refsect1 role="returnvalues">
30+
&reftitle.returnvalues;
31+
<para>
32+
The number of warnings generated by the last operation.
33+
</para>
34+
</refsect1>
35+
36+
<refsect1 role="examples">
37+
&reftitle.examples;
38+
<example>
39+
<title><function>mysql_xdevapi\Result::getWarningsCount</function> example</title>
40+
<programlisting role="php">
41+
<![CDATA[
42+
<?php
43+
44+
/* ... */
45+
46+
?>
47+
]]>
48+
</programlisting>
49+
</example>
50+
</refsect1>
51+
52+
53+
</refentry>
54+
55+
<!-- Keep this comment at the end of the file
56+
Local variables:
57+
mode: sgml
58+
sgml-omittag:t
59+
sgml-shorttag:t
60+
sgml-minimize-attributes:nil
61+
sgml-always-quote-attributes:t
62+
sgml-indent-step:1
63+
sgml-indent-data:t
64+
indent-tabs-mode:nil
65+
sgml-parent-document:nil
66+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
67+
sgml-exposed-tags:nil
68+
sgml-local-catalogs:nil
69+
sgml-local-ecat-files:nil
70+
End:
71+
vim600: syn=xml fen fdm=syntax fdl=2 si
72+
vim: et tw=78 syn=sgml
73+
vi: ts=1 sw=1
74+
-->

‎docbook/mysql_xdevapi/rowresult/getwarningscount.xml

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!-- $Revision$ -->
3+
4+
<refentry xml:id="mysql-xdevapi-rowresult.getwarningcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5+
<refnamediv>
6+
<refname>RowResult::getWarningsCount</refname>
7+
<refpurpose>Get warning count from last operation</refpurpose>
8+
</refnamediv>
9+
10+
<refsect1 role="description">
11+
&reftitle.description;
12+
<methodsynopsis>
13+
<modifier>public</modifier> <type>integer</type><methodname>mysql_xdevapi\RowResult::getWarningsCount</methodname>
14+
<void />
15+
</methodsynopsis>
16+
<para>
17+
18+
</para>
19+
20+
&warn.undocumented.func;
21+
22+
</refsect1>
23+
24+
<refsect1 role="parameters">
25+
&reftitle.parameters;
26+
&no.function.parameters;
27+
</refsect1>
28+
29+
<refsect1 role="returnvalues">
30+
&reftitle.returnvalues;
31+
<para>
32+
The number of warnings generated by the last operation.
33+
</para>
34+
</refsect1>
35+
36+
<refsect1 role="examples">
37+
&reftitle.examples;
38+
<example>
39+
<title><function>mysql_xdevapi\RowResult::getWarningsCount</function> example</title>
40+
<programlisting role="php">
41+
<![CDATA[
42+
<?php
43+
44+
/* ... */
45+
46+
?>
47+
]]>
48+
</programlisting>
49+
</example>
50+
</refsect1>
51+
52+
53+
</refentry>
54+
55+
<!-- Keep this comment at the end of the file
56+
Local variables:
57+
mode: sgml
58+
sgml-omittag:t
59+
sgml-shorttag:t
60+
sgml-minimize-attributes:nil
61+
sgml-always-quote-attributes:t
62+
sgml-indent-step:1
63+
sgml-indent-data:t
64+
indent-tabs-mode:nil
65+
sgml-parent-document:nil
66+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
67+
sgml-exposed-tags:nil
68+
sgml-local-catalogs:nil
69+
sgml-local-ecat-files:nil
70+
End:
71+
vim600: syn=xml fen fdm=syntax fdl=2 si
72+
vim: et tw=78 syn=sgml
73+
vi: ts=1 sw=1
74+
-->

0 commit comments

Comments
 (0)