Skip to content

Synchronize manual with stubs for PHP 8.4 - part 4 #4186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 2, 2024
Merged

Synchronize manual with stubs for PHP 8.4 - part 4 #4186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6626e49
Synchronize manual with stubs for PHP 8.4 - part 4
kocsismate Nov 28, 2024
e039147
Remove remaining mentions of resource
kocsismate Nov 29, 2024
1b8ae58
Review fixes
kocsismate Nov 29, 2024
cd07984
Update reference/uodbc/setup.xml
kocsismate Dec 2, 2024
346b9c3
Remove outdated information
kocsismate Dec 2, 2024
5fa973a
Fix punctuation
kocsismate Dec 2, 2024
ccde7cf
Update reference/uodbc/functions/odbc-execute.xml
kocsismate Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 40 additions & 1 deletion language-snippets.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1820,9 +1820,15 @@ that is typically created using <function>fopen</function>.</para>'>
<!ENTITY haru.error '<para xmlns="http://docbook.org/ns/docbook">Throws a <classname>HaruException</classname> on error.</para>'>

<!-- ODBC -->
<!ENTITY odbc.connection.id '<para xmlns="http://docbook.org/ns/docbook">The ODBC connection identifier,
<!ENTITY odbc.connection.id '<para xmlns="http://docbook.org/ns/docbook">The ODBC connection object,
see <function>odbc_connect</function> for details.</para>'>

<!ENTITY odbc.result.object 'The ODBC result object'>

<!ENTITY odbc.result.object-return 'Returns an ODBC result object'>

<!ENTITY odbc.result.object-return-falseforfailure '&odbc.result.object-return;&return.falseforfailure;.'>

<!ENTITY odbc.parameter.catalog 'The catalog (&apos;qualifier&apos; in ODBC 2 parlance).'>

<!ENTITY odbc.parameter.schema 'The schema (&apos;owner&apos; in ODBC 2 parlance).'>
Expand All @@ -1833,6 +1839,39 @@ and <literal xmlns="http://docbook.org/ns/docbook">_</literal> to match a single

<!ENTITY odbc.result.driver-specific 'Drivers can report additional columns.'>

<!ENTITY odbc.changelog.connection-param '<row xmlns="http://docbook.org/ns/docbook">
<entry>8.4.0</entry>
<entry>
<parameter>odbc</parameter> expects an <classname>Odbc\Connection</classname>
instance now; previously, a <type>resource</type> was expected.
</entry>
</row>'>

<!ENTITY odbc.changelog.connection-return '&odbc.changelog.connection-param;
<row xmlns="http://docbook.org/ns/docbook">
<entry>8.4.0</entry>
<entry>
This function returns a <classname>Odbc\Connection</classname> instance now;
previously, a <type>resource</type> was returned.
</entry>
</row>'>

<!ENTITY odbc.changelog.result-param '<row xmlns="http://docbook.org/ns/docbook">
<entry>8.4.0</entry>
<entry>
<parameter>statement</parameter> expects an <classname>Odbc\Result</classname>
instance now; previously, a <type>resource</type> was expected.
</entry>
</row>'>

<!ENTITY odbc.changelog.result-return '<row xmlns="http://docbook.org/ns/docbook">
<entry>8.4.0</entry>
<entry>
This function returns an <classname>Odbc\Result</classname>
instance now; previously, a <type>resource</type> was returned.
</entry>
</row>'>

<!-- OAUTH -->
<!ENTITY oauth.callback.error 'Emits an <constant xmlns="http://docbook.org/ns/docbook">E_ERROR</constant> level
error if the callback function cannot be called, or was not specified.'>
Expand Down
3 changes: 2 additions & 1 deletion reference/uodbc/functions/odbc-autocommit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>bool</type></type><methodname>odbc_autocommit</methodname>
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>enable</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -69,6 +69,7 @@
</row>
</thead>
<tbody>
&odbc.changelog.connection-param;
<row>
<entry>8.3.0</entry>
<entry>
Expand Down
25 changes: 19 additions & 6 deletions reference/uodbc/functions/odbc-binmode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>true</type><methodname>odbc_binmode</methodname>
<methodparam><type>resource</type><parameter>statement</parameter></methodparam>
<methodparam><type>Odbc\Result</type><parameter>statement</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -92,11 +92,7 @@
<term><parameter>statement</parameter></term>
<listitem>
<para>
The result identifier.
</para>
<para>
If <parameter>statement</parameter> is <literal>0</literal>, the
settings apply as default for new results.
&odbc.result.object;.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -140,6 +136,23 @@
&return.true.always;
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&odbc.changelog.result-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
20 changes: 19 additions & 1 deletion reference/uodbc/functions/odbc-close.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>odbc_close</methodname>
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
</methodsynopsis>
<para>
Closes down the connection to the database server.
Expand All @@ -34,6 +34,24 @@
&return.void;
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&odbc.changelog.connection-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="notes">
&reftitle.notes;
<note>
Expand Down
25 changes: 21 additions & 4 deletions reference/uodbc/functions/odbc-columnprivileges.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_columnprivileges</methodname>
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
<type class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_columnprivileges</methodname>
<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter></methodparam>
<methodparam><type>string</type><parameter>schema</parameter></methodparam>
<methodparam><type>string</type><parameter>table</parameter></methodparam>
Expand Down Expand Up @@ -70,8 +70,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an ODBC result identifier&return.falseforfailure;.
This result identifier can be used to fetch a list of columns and
&odbc.result.object-return-falseforfailure;
This result object can be used to fetch a list of columns and
associated privileges.
</para>
<para>
Expand All @@ -94,6 +94,23 @@
</simpara>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&odbc.changelog.connection-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example xml:id="odbc-columnprivileges.example.basic">
Expand Down
7 changes: 4 additions & 3 deletions reference/uodbc/functions/odbc-columns.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_columns</methodname>
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
<type class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_columns</methodname>
<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>schema</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>table</parameter><initializer>&null;</initializer></methodparam>
Expand Down Expand Up @@ -70,7 +70,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an ODBC result identifier&return.falseforfailure;.
&odbc.result.object-return-falseforfailure;
</para>
<para>
The result set has the following columns:
Expand Down Expand Up @@ -113,6 +113,7 @@
</row>
</thead>
<tbody>
&odbc.changelog.connection-param;
<row>
<entry>8.0.0</entry>
<entry>
Expand Down
19 changes: 18 additions & 1 deletion reference/uodbc/functions/odbc-commit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>odbc_commit</methodname>
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
</methodsynopsis>
<para>
Commits all pending transactions on the connection.
Expand All @@ -34,6 +34,23 @@
&return.success;
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&odbc.changelog.connection-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
19 changes: 18 additions & 1 deletion reference/uodbc/functions/odbc-connect.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_connect</methodname>
<type class="union"><type>Odbc\Connection</type><type>false</type></type><methodname>odbc_connect</methodname>
<methodparam><type>string</type><parameter>dsn</parameter></methodparam>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
Expand Down Expand Up @@ -103,6 +103,23 @@
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&odbc.changelog.connection-return;
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
21 changes: 19 additions & 2 deletions reference/uodbc/functions/odbc-cursor.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>odbc_cursor</methodname>
<methodparam><type>resource</type><parameter>statement</parameter></methodparam>
<methodparam><type>Odbc\Result</type><parameter>statement</parameter></methodparam>
</methodsynopsis>
<para>
Gets the cursorname for the given result_id.
Expand All @@ -23,7 +23,7 @@
<term><parameter>statement</parameter></term>
<listitem>
<para>
The result identifier.
&odbc.result.object;.
</para>
</listitem>
</varlistentry>
Expand All @@ -36,6 +36,23 @@
Returns the cursor name, as a string, &return.falseforfailure;.
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&odbc.changelog.result-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
19 changes: 18 additions & 1 deletion reference/uodbc/functions/odbc-data-source.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>null</type><type>false</type></type><methodname>odbc_data_source</methodname>
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
<methodparam><type>int</type><parameter>fetch_type</parameter></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -49,6 +49,23 @@
</para>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&odbc.changelog.connection-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example xml:id="odbc-data-source.example.basic">
Expand Down
5 changes: 3 additions & 2 deletions reference/uodbc/functions/odbc-error.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>odbc_error</methodname>
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>odbc</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>Odbc\Connection</type><type>null</type></type><parameter>odbc</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Returns a six-digit ODBC state, or an empty string if there has been no
Expand Down Expand Up @@ -53,10 +53,11 @@
</row>
</thead>
<tbody>
&odbc.changelog.connection-param;
<row>
<entry>8.0.0</entry>
<entry>
<parameter>odbc</parameter> is nullable now.
<parameter>odbc</parameter> is now nullable.
</entry>
</row>
</tbody>
Expand Down
Loading