Skip to content

Update the methodsynopsis of some recently changed stubs #625

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 2 commits into from
May 24, 2021
+8 −8
Merged

Update the methodsynopsis of some recently changed stubs #625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f1bbd57
Update the methodsynopsis of some recently changed stubs
kocsismate May 23, 2021
db88bee
Address review comments
kocsismate May 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
4 changes: 2 additions & 2 deletions reference/session/sessionhandler/read.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>
<modifier>public</modifier> <type>string</type><methodname>SessionHandler::read</methodname>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SessionHandler::read</methodname>
<methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -52,7 +52,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an encoded string of the read data. If nothing was read, it must return an empty string. Note this value is returned internally to PHP for processing.
Returns an encoded string of the read data. If nothing was read, it must return &false;. Note this value is returned internally to PHP for processing.
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/session/sessionhandlerinterface/read.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>
<modifier>abstract</modifier> <modifier>public</modifier> <type>string</type><methodname>SessionHandlerInterface::read</methodname>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SessionHandlerInterface::read</methodname>
<methodparam><type>string</type><parameter>id</parameter></methodparam>
</methodsynopsis>
<para>
Expand All @@ -22,7 +22,7 @@
This method should retrieve the session data from storage by the
session ID provided. The string returned by this method must be in the same
serialized format as when originally passed to the <function>SessionHandlerInterface::write</function>
If the record was not found, return an empty string.
If the record was not found, return &false;.
</para>
<para>
The data returned by this method will be decoded internally by PHP using the
Expand Down
4 changes: 2 additions & 2 deletions reference/simplexml/simplexmlelement/addChild.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>SimpleXMLElement</type><methodname>SimpleXMLElement::addChild</methodname>
<modifier>public</modifier> <type class="union"><type>SimpleXMLElement</type><type>null</type></type><methodname>SimpleXMLElement::addChild</methodname>
<methodparam><type>string</type><parameter>qualifiedName</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>namespace</parameter><initializer>&null;</initializer></methodparam>
Expand Down Expand Up @@ -56,7 +56,7 @@
&reftitle.returnvalues;
<para>
The <literal>addChild</literal> method returns a <type>SimpleXMLElement</type>
object representing the child added to the XML node.
object representing the child added to the XML node on success; &null; on failure.
</para>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions reference/simplexml/simplexmlelement/xpath.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>
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>SimpleXMLElement::xpath</methodname>
<modifier>public</modifier> <type class="union"><type>array</type><type>null</type><type>false</type></type><methodname>SimpleXMLElement::xpath</methodname>
<methodparam><type>string</type><parameter>expression</parameter></methodparam>
</methodsynopsis>
<para>
Expand Down Expand Up @@ -37,7 +37,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <type>array</type> of SimpleXMLElement objects or &false; in
Returns an <type>array</type> of SimpleXMLElement objects on success; or &null; or &false; in
case of an error.
</para>
</refsect1>
Expand Down