Skip to content

Commit d571c14

Browse files
GirgiasGirgias
committed
PHP 8.4: Start documenting Pdo\Pgsql class
1 parent a09d866 commit d571c14

22 files changed

+1374
-592
lines changed

‎reference/pdo_pgsql/PDO/pgsqlCopyFromArray.xml‎

Lines changed: 11 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -3,80 +3,25 @@
33
<refentry xml:id="pdo.pgsqlcopyfromarray" xmlns="http://docbook.org/ns/docbook">
44
<refnamediv>
55
<refname>PDO::pgsqlCopyFromArray</refname>
6-
<refpurpose>Copy data from PHP array into table</refpurpose>
6+
<refpurpose>
7+
&Alias; <methodname>Pdo\Pgsql::copyFromArray</methodname>
8+
</refpurpose>
79
</refnamediv>
810
<refsect1 role="description">
911
&reftitle.description;
1012
<methodsynopsis>
11-
<modifier>public</modifier> <type>bool</type> <methodname>PDO::pgsqlCopyFromArray</methodname>
12-
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
13+
<modifier>public</modifier> <type>bool</type><methodname>PDO::pgsqlCopyFromArray</methodname>
14+
<methodparam><type>string</type><parameter>tableName</parameter></methodparam>
1315
<methodparam><type>array</type><parameter>rows</parameter></methodparam>
14-
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter><initializer>"\t"</initializer></methodparam>
15-
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter><initializer>"\\\\N"</initializer></methodparam>
16-
<methodparam choice="opt"><type>string</type><parameter>fields</parameter></methodparam>
16+
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
17+
<methodparam choice="opt"><type>string</type><parameter>nullAs</parameter><initializer>"\\\\N"</initializer></methodparam>
18+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>fields</parameter><initializer>&null;</initializer></methodparam>
1719
</methodsynopsis>
18-
<para>
19-
Copies data from <parameter>rows</parameter> array to table <parameter>table_name</parameter>
20-
using <parameter>delimiter</parameter> as fields delimiter and <parameter>fields</parameter> list
21-
</para>
22-
</refsect1>
23-
24-
<refsect1 role="parameters">
25-
&reftitle.parameters;
26-
<para>
27-
<variablelist>
28-
<varlistentry>
29-
<term><parameter>table_name</parameter></term>
30-
<listitem>
31-
<para>
32-
String containing table name
33-
</para>
34-
</listitem>
35-
</varlistentry>
36-
<varlistentry>
37-
<term><parameter>rows</parameter></term>
38-
<listitem>
39-
<para>
40-
Array of strings with fields separated by <parameter>delimiter</parameter>
41-
</para>
42-
</listitem>
43-
</varlistentry>
44-
<varlistentry>
45-
<term><parameter>delimiter</parameter></term>
46-
<listitem>
47-
<para>
48-
Delimiter used in <parameter>rows</parameter> array
49-
</para>
50-
</listitem>
51-
</varlistentry>
52-
<varlistentry>
53-
<term><parameter>null_as</parameter></term>
54-
<listitem>
55-
<para>
56-
How to interpret null values
57-
</para>
58-
</listitem>
59-
</varlistentry>
60-
<varlistentry>
61-
<term><parameter>fields</parameter></term>
62-
<listitem>
63-
<para>
64-
List of fields to insert
65-
</para>
66-
</listitem>
67-
</varlistentry>
68-
</variablelist>
69-
</para>
70-
</refsect1>
71-
72-
<refsect1 role="returnvalues">
73-
&reftitle.returnvalues;
74-
<para>
75-
Returns &true; on success,&return.falseforfailure;.
76-
</para>
20+
<simpara>
21+
&info.method.alias; <methodname>Pdo\Pgsql::copyFromArray</methodname>.
22+
</simpara>
7723
</refsect1>
7824
</refentry>
79-
8025
<!-- Keep this comment at the end of the file
8126
Local variables:
8227
mode: sgml

‎reference/pdo_pgsql/PDO/pgsqlCopyFromFile.xml‎

Lines changed: 11 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -3,80 +3,25 @@
33
<refentry xml:id="pdo.pgsqlcopyfromfile" xmlns="http://docbook.org/ns/docbook">
44
<refnamediv>
55
<refname>PDO::pgsqlCopyFromFile</refname>
6-
<refpurpose>Copy data from file into table</refpurpose>
6+
<refpurpose>
7+
&Alias; <methodname>Pdo\Pgsql::copyFromFile</methodname>
8+
</refpurpose>
79
</refnamediv>
810
<refsect1 role="description">
911
&reftitle.description;
1012
<methodsynopsis>
11-
<modifier>public</modifier> <type>bool</type> <methodname>PDO::pgsqlCopyFromFile</methodname>
12-
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
13+
<modifier>public</modifier> <type>bool</type><methodname>PDO::pgsqlCopyFromFile</methodname>
14+
<methodparam><type>string</type><parameter>tableName</parameter></methodparam>
1315
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
14-
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter><initializer>"\t"</initializer></methodparam>
15-
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter><initializer>"\\\\N"</initializer></methodparam>
16-
<methodparam choice="opt"><type>string</type><parameter>fields</parameter></methodparam>
16+
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
17+
<methodparam choice="opt"><type>string</type><parameter>nullAs</parameter><initializer>"\\\\N"</initializer></methodparam>
18+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>fields</parameter><initializer>&null;</initializer></methodparam>
1719
</methodsynopsis>
18-
<para>
19-
Copies data from file specified by <parameter>filename</parameter> into table <parameter>table_name</parameter>
20-
using <parameter>delimiter</parameter> as fields delimiter and <parameter>fields</parameter> list
21-
</para>
22-
</refsect1>
23-
24-
<refsect1 role="parameters">
25-
&reftitle.parameters;
26-
<para>
27-
<variablelist>
28-
<varlistentry>
29-
<term><parameter>table_name</parameter></term>
30-
<listitem>
31-
<para>
32-
String containing table name
33-
</para>
34-
</listitem>
35-
</varlistentry>
36-
<varlistentry>
37-
<term><parameter>filename</parameter></term>
38-
<listitem>
39-
<para>
40-
Filename containing data to import
41-
</para>
42-
</listitem>
43-
</varlistentry>
44-
<varlistentry>
45-
<term><parameter>delimiter</parameter></term>
46-
<listitem>
47-
<para>
48-
Delimiter used in file specified by <parameter>filename</parameter>
49-
</para>
50-
</listitem>
51-
</varlistentry>
52-
<varlistentry>
53-
<term><parameter>null_as</parameter></term>
54-
<listitem>
55-
<para>
56-
How to interpret null values
57-
</para>
58-
</listitem>
59-
</varlistentry>
60-
<varlistentry>
61-
<term><parameter>fields</parameter></term>
62-
<listitem>
63-
<para>
64-
List of fields to insert
65-
</para>
66-
</listitem>
67-
</varlistentry>
68-
</variablelist>
69-
</para>
70-
</refsect1>
71-
72-
<refsect1 role="returnvalues">
73-
&reftitle.returnvalues;
74-
<para>
75-
Returns &true; on success,&return.falseforfailure;.
76-
</para>
20+
<simpara>
21+
&info.method.alias; <methodname>Pdo\Pgsql::copyFromFile</methodname>.
22+
</simpara>
7723
</refsect1>
7824
</refentry>
79-
8025
<!-- Keep this comment at the end of the file
8126
Local variables:
8227
mode: sgml

‎reference/pdo_pgsql/PDO/pgsqlCopyToArray.xml‎

Lines changed: 11 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -3,70 +3,24 @@
33
<refentry xml:id="pdo.pgsqlcopytoarray" xmlns="http://docbook.org/ns/docbook">
44
<refnamediv>
55
<refname>PDO::pgsqlCopyToArray</refname>
6-
<refpurpose>Copy data from database table into PHP array</refpurpose>
6+
<refpurpose>
7+
&Alias; <methodname>Pdo\Pgsql::copyToArray</methodname>
8+
</refpurpose>
79
</refnamediv>
810
<refsect1 role="description">
911
&reftitle.description;
1012
<methodsynopsis>
11-
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type> <methodname>PDO::pgsqlCopyToArray</methodname>
12-
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
13-
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter><initializer>"\t"</initializer></methodparam>
14-
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter><initializer>"\\\\N"</initializer></methodparam>
15-
<methodparam choice="opt"><type>string</type><parameter>fields</parameter></methodparam>
13+
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>PDO::pgsqlCopyToArray</methodname>
14+
<methodparam><type>string</type><parameter>tableName</parameter></methodparam>
15+
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
16+
<methodparam choice="opt"><type>string</type><parameter>nullAs</parameter><initializer>"\\\\N"</initializer></methodparam>
17+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>fields</parameter><initializer>&null;</initializer></methodparam>
1618
</methodsynopsis>
17-
<para>
18-
Copies data from <parameter>table</parameter> into array using <parameter>delimiter</parameter> as fields delimiter and <parameter>fields</parameter> list
19-
</para>
20-
</refsect1>
21-
22-
<refsect1 role="parameters">
23-
&reftitle.parameters;
24-
<para>
25-
<variablelist>
26-
<varlistentry>
27-
<term><parameter>table_name</parameter></term>
28-
<listitem>
29-
<para>
30-
String containing table name
31-
</para>
32-
</listitem>
33-
</varlistentry>
34-
<varlistentry>
35-
<term><parameter>delimiter</parameter></term>
36-
<listitem>
37-
<para>
38-
Delimiter used in rows
39-
</para>
40-
</listitem>
41-
</varlistentry>
42-
<varlistentry>
43-
<term><parameter>null_as</parameter></term>
44-
<listitem>
45-
<para>
46-
How to interpret null values
47-
</para>
48-
</listitem>
49-
</varlistentry>
50-
<varlistentry>
51-
<term><parameter>fields</parameter></term>
52-
<listitem>
53-
<para>
54-
List of fields to export
55-
</para>
56-
</listitem>
57-
</varlistentry>
58-
</variablelist>
59-
</para>
60-
</refsect1>
61-
62-
<refsect1 role="returnvalues">
63-
&reftitle.returnvalues;
64-
<para>
65-
Returns an array of rows,&return.falseforfailure;.
66-
</para>
19+
<simpara>
20+
&info.method.alias; <methodname>Pdo\Pgsql::copyToArray</methodname>.
21+
</simpara>
6722
</refsect1>
6823
</refentry>
69-
7024
<!-- Keep this comment at the end of the file
7125
Local variables:
7226
mode: sgml

‎reference/pdo_pgsql/PDO/pgsqlCopyToFile.xml‎

Lines changed: 11 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -3,80 +3,25 @@
33
<refentry xml:id="pdo.pgsqlcopytofile" xmlns="http://docbook.org/ns/docbook">
44
<refnamediv>
55
<refname>PDO::pgsqlCopyToFile</refname>
6-
<refpurpose>Copy data from table into file</refpurpose>
6+
<refpurpose>
7+
&Alias; <methodname>Pdo\Pgsql::copyToFile</methodname>
8+
</refpurpose>
79
</refnamediv>
810
<refsect1 role="description">
911
&reftitle.description;
1012
<methodsynopsis>
11-
<modifier>public</modifier> <type>bool</type> <methodname>PDO::pgsqlCopyToFile</methodname>
12-
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
13+
<modifier>public</modifier> <type>bool</type><methodname>PDO::pgsqlCopyToFile</methodname>
14+
<methodparam><type>string</type><parameter>tableName</parameter></methodparam>
1315
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
14-
<methodparam choice="opt"><type>string</type><parameter>delimiter</parameter><initializer>"\t"</initializer></methodparam>
15-
<methodparam choice="opt"><type>string</type><parameter>null_as</parameter><initializer>"\\\\N"</initializer></methodparam>
16-
<methodparam choice="opt"><type>string</type><parameter>fields</parameter></methodparam>
16+
<methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>"\t"</initializer></methodparam>
17+
<methodparam choice="opt"><type>string</type><parameter>nullAs</parameter><initializer>"\\\\N"</initializer></methodparam>
18+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>fields</parameter><initializer>&null;</initializer></methodparam>
1719
</methodsynopsis>
18-
<para>
19-
Copies data from table into file specified by <parameter>filename</parameter>
20-
using <parameter>delimiter</parameter> as fields delimiter and <parameter>fields</parameter> list
21-
</para>
22-
</refsect1>
23-
24-
<refsect1 role="parameters">
25-
&reftitle.parameters;
26-
<para>
27-
<variablelist>
28-
<varlistentry>
29-
<term><parameter>table_name</parameter></term>
30-
<listitem>
31-
<para>
32-
String containing table name
33-
</para>
34-
</listitem>
35-
</varlistentry>
36-
<varlistentry>
37-
<term><parameter>filename</parameter></term>
38-
<listitem>
39-
<para>
40-
Filename to export data
41-
</para>
42-
</listitem>
43-
</varlistentry>
44-
<varlistentry>
45-
<term><parameter>delimiter</parameter></term>
46-
<listitem>
47-
<para>
48-
Delimiter used in file specified by <parameter>filename</parameter>
49-
</para>
50-
</listitem>
51-
</varlistentry>
52-
<varlistentry>
53-
<term><parameter>null_as</parameter></term>
54-
<listitem>
55-
<para>
56-
How to interpret null values
57-
</para>
58-
</listitem>
59-
</varlistentry>
60-
<varlistentry>
61-
<term><parameter>fields</parameter></term>
62-
<listitem>
63-
<para>
64-
List of fields to insert
65-
</para>
66-
</listitem>
67-
</varlistentry>
68-
</variablelist>
69-
</para>
70-
</refsect1>
71-
72-
<refsect1 role="returnvalues">
73-
&reftitle.returnvalues;
74-
<para>
75-
Returns &true; on success,&return.falseforfailure;.
76-
</para>
20+
<simpara>
21+
&info.method.alias; <methodname>Pdo\Pgsql::copyToFile</methodname>.
22+
</simpara>
7723
</refsect1>
7824
</refentry>
79-
8025
<!-- Keep this comment at the end of the file
8126
Local variables:
8227
mode: sgml

0 commit comments

Comments
 (0)