Skip to content

Update ext/oci8 methodsynopses based on stubs #601

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
Girgias merged 8 commits into from
Sep 23, 2021
Merged

Update ext/oci8 methodsynopses based on stubs #601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ba2fb77
Update ext/oci8 methodsynopses based on stubs
kocsismate May 13, 2021
756c498
Address review comments
kocsismate May 16, 2021
5bf2bdd
Add changelog entries for nullable parameters
kocsismate May 16, 2021
610f3a7
Fix a few issues
kocsismate Aug 30, 2021
1cc65c4
Improve wording of changelog items
kocsismate Sep 14, 2021
964cbcd
A few description fixes
kocsismate Sep 22, 2021
b1a082a
Use XML entities
Girgias Sep 23, 2021
9b3a7bb
Use XML entities
Girgias Sep 23, 2021
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
2 changes: 1 addition & 1 deletion language-snippets.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1357,7 +1357,7 @@ string</link>, or a Connect Name from
the <filename>tnsnames.ora</filename> file, or the name of a local
Oracle instance.
</para>
<para xmlns='http://docbook.org/ns/docbook'>If not specified, PHP uses
<para xmlns='http://docbook.org/ns/docbook'>If not specified or &null;, PHP uses
environment variables such as <constant>TWO_TASK</constant> (on Linux)
or <constant>LOCAL</constant> (on Windows)
and <constant>ORACLE_SID</constant> to determine the
Expand Down
9 changes: 4 additions & 5 deletions reference/oci8/OCI-Collection/append.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<type>bool</type><methodname>OCICollection::append</methodname>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>OCICollection::append</methodname>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
Comment thread
Girgias marked this conversation as resolved.
</methodsynopsis>
<para>
Appends element to the end of the collection.
Expand All @@ -25,7 +25,7 @@
<term><parameter>value</parameter></term>
<listitem>
<para>
The value to be added to the collection. Can be a string or a number.
The value to be added to the collection.
</para>
</listitem>
</varlistentry>
Expand Down Expand Up @@ -67,13 +67,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-collection.assign" /></member>
<member><xref linkend="oci-collection.assign"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
5 changes: 2 additions & 3 deletions reference/oci8/OCI-Collection/assign.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 role="oop">
<type>bool</type><methodname>OCICollection::assign</methodname>
<modifier>public</modifier> <type>bool</type><methodname>OCICollection::assign</methodname>
Copy link
Copy Markdown
Contributor

@cjbj cjbj Aug 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems OCICollection::assignElem wasn't updated.

Copy link
Copy Markdown
Member Author

@kocsismate kocsismate Aug 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohh, I think that must be because of the different capitalization (assignElem vs assignelem). :/

Copy link
Copy Markdown
Member Author

@kocsismate kocsismate Aug 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I created php/php-src#7405 to fix the inconsistency

Copy link
Copy Markdown
Contributor

@cjbj cjbj Aug 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That new PR doesn't seem to add the public modifier to OCICollection::assignElem ?

Copy link
Copy Markdown
Member Author

@kocsismate kocsismate Aug 30, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, the new PR is unrelated from <modifier>public</modifier>. It is only added because the script always generates the access modifier for methods, while OCICollection::assign() didn't have one previously.

Copy link
Copy Markdown
Contributor

@cjbj cjbj Aug 31, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yay for tidy-ups! Will you update this (601) PR with <modifier> for OCICollection::assignElem, Lob::truncate, getBuffering and setBuffering, and writeTemporary?

Copy link
Copy Markdown
Member Author

@kocsismate kocsismate Aug 31, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I've just pushed all the changes. In the meanwhile, I found out why OCILob::truncate() wasn't autogenerated: c3978de#diff-1ef7c5160d41789c5faf14de56219ac73b3039795ebbac6da6ebaa716cdd8d21L12 :D It's fixed now.

<methodparam><type>OCICollection</type><parameter>from</parameter></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -69,13 +69,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-collection.append" /></member>
<member><xref linkend="oci-collection.append"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
7 changes: 3 additions & 4 deletions reference/oci8/OCI-Collection/assignElem.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<type>bool</type><methodname>OCICollection::assignElem</methodname>
<modifier>public</modifier> <type>bool</type><methodname>OCICollection::assignElem</methodname>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Assigns a value to the element with index <parameter>index</parameter>.
Expand Down Expand Up @@ -76,13 +76,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-collection.getelem" /></member>
<member><xref linkend="oci-collection.getelem"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
8 changes: 3 additions & 5 deletions reference/oci8/OCI-Collection/free.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<type>bool</type><methodname>OCICollection::free</methodname>
<void />
<modifier>public</modifier> <type>bool</type><methodname>OCICollection::free</methodname>
<void/>
</methodsynopsis>
<para>
Frees the resources associated with the collection object.
Expand Down Expand Up @@ -56,13 +56,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.oci-new-collection" /></member>
<member><xref linkend="function.oci-new-collection"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand All @@ -83,4 +82,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

6 changes: 2 additions & 4 deletions reference/oci8/OCI-Collection/getElem.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 role="oop">
<type>mixed</type><methodname>OCICollection::getElem</methodname>
<modifier>public</modifier> <type class="union"><type>string</type><type>float</type><type>null</type><type>false</type></type><methodname>OCICollection::getElem</methodname>
Comment thread
kocsismate marked this conversation as resolved.
<methodparam><type>int</type><parameter>index</parameter></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -69,13 +69,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-collection.assignelem" /></member>
<member><xref linkend="oci-collection.assignelem"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand All @@ -96,4 +95,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

7 changes: 3 additions & 4 deletions reference/oci8/OCI-Collection/max.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<type>int</type><methodname>OCICollection::max</methodname>
<void />
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>OCICollection::max</methodname>
<void/>
</methodsynopsis>
<para>
Returns the maximum number of elements in the collection.
Expand Down Expand Up @@ -59,13 +59,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-collection.size" /></member>
<member><xref linkend="oci-collection.size"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
7 changes: 3 additions & 4 deletions reference/oci8/OCI-Collection/size.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<type>int</type><methodname>OCICollection::size</methodname>
<void />
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>OCICollection::size</methodname>
<void/>
</methodsynopsis>
<para>
Returns the size of the collection.
Expand Down Expand Up @@ -56,13 +56,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-collection.max" /></member>
<member><xref linkend="oci-collection.max"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
5 changes: 2 additions & 3 deletions reference/oci8/OCI-Collection/trim.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 role="oop">
<type>bool</type><methodname>OCICollection::trim</methodname>
<modifier>public</modifier> <type>bool</type><methodname>OCICollection::trim</methodname>
<methodparam><type>int</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -68,13 +68,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-collection.size" /></member>
<member><xref linkend="oci-collection.size"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
14 changes: 6 additions & 8 deletions reference/oci8/OCI-Lob/append.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<type>bool</type><methodname>OCILob::append</methodname>
<methodparam><type>OCILob</type><parameter>lob_from</parameter></methodparam>
<modifier>public</modifier> <type>bool</type><methodname>OCILob::append</methodname>
<methodparam><type>OCILob</type><parameter>from</parameter></methodparam>
</methodsynopsis>
<para>
Appends data from the large object to the end of another large object.
Expand All @@ -28,7 +28,7 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>lob_from</parameter></term>
<term><parameter>from</parameter></term>
<listitem>
<para>
The copied LOB.
Expand Down Expand Up @@ -73,15 +73,14 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-lob.flush" /></member>
<member><xref linkend="oci-lob.setbuffering" /></member>
<member><xref linkend="oci-lob.getbuffering" /></member>
<member><xref linkend="oci-lob.flush"/></member>
<member><xref linkend="oci-lob.setbuffering"/></member>
<member><xref linkend="oci-lob.getbuffering"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand All @@ -102,4 +101,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

9 changes: 4 additions & 5 deletions reference/oci8/OCI-Lob/close.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
Comment thread
kocsismate marked this conversation as resolved.
<type>bool</type><methodname>OCILob::close</methodname>
<void />
<modifier>public</modifier> <type>bool</type><methodname>OCILob::close</methodname>
<void/>
</methodsynopsis>
<para>
Closes descriptor of LOB or FILE. This function should be used only with
<xref linkend="oci-lob.writetemporary" />.
<xref linkend="oci-lob.writetemporary"/>.
Copy link
Copy Markdown
Contributor

@cjbj cjbj Aug 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The API for writeTemporary doesn't seem to have been updated.

</para>
</refsect1>

Expand Down Expand Up @@ -57,13 +57,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-lob.writetemporary" /></member>
<member><xref linkend="oci-lob.writetemporary"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
7 changes: 3 additions & 4 deletions reference/oci8/OCI-Lob/eof.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<type>bool</type><methodname>OCILob::eof</methodname>
<void />
<modifier>public</modifier> <type>bool</type><methodname>OCILob::eof</methodname>
<void/>
</methodsynopsis>
<para>
Tells whether the internal pointer of large object is at the end of LOB.
Expand Down Expand Up @@ -66,13 +66,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-lob.size" /></member>
<member><xref linkend="oci-lob.size"/></member>
</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
16 changes: 10 additions & 6 deletions reference/oci8/OCI-Lob/erase.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<type class="union"><type>int</type><type>false</type></type><methodname>OCILob::erase</methodname>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>OCILob::erase</methodname>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>offset</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Erases a specified portion of the internal LOB data starting at a
Expand Down Expand Up @@ -64,6 +64,12 @@
</row>
</thead>
<tbody>
<row>
<entry>8.0.0, PECL OCI8 3.0.0</entry>
<entry>
<parameter>offset</parameter> and <parameter>length</parameter> are now nullable.
</entry>
</row>
<row>
<entry>8.0.0, PECL OCI8 3.0.0</entry>
<entry>
Expand All @@ -80,13 +86,12 @@
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-lob.truncate" /></member>
<member><xref linkend="oci-lob.truncate"/></member>
Copy link
Copy Markdown
Contributor

@cjbj cjbj Aug 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the prototype for Lob::truncate itself hasn't been updated.

Copy link
Copy Markdown
Member Author

@kocsismate kocsismate Aug 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you miss from Lob::truncate()? It looks good for me.

</simplelist>
</para>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand All @@ -107,4 +112,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

Loading