Skip to content

Commit 1367cac

Browse files
authored
Update the methodsynopsis of some recently changed stubs
Closes GH-625.
1 parent 4ff1517 commit 1367cac

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

reference/session/sessionhandler/read.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<refsect1 role="description">
1010
&reftitle.description;
1111
<methodsynopsis>
12-
<modifier>public</modifier> <type>string</type><methodname>SessionHandler::read</methodname>
12+
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SessionHandler::read</methodname>
1313
<methodparam><type>string</type><parameter>id</parameter></methodparam>
1414
</methodsynopsis>
1515
<para>
@@ -52,7 +52,7 @@
5252
<refsect1 role="returnvalues">
5353
&reftitle.returnvalues;
5454
<para>
55-
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.
55+
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.
5656
</para>
5757
</refsect1>
5858

reference/session/sessionhandlerinterface/read.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<refsect1 role="description">
1010
&reftitle.description;
1111
<methodsynopsis>
12-
<modifier>abstract</modifier> <modifier>public</modifier> <type>string</type><methodname>SessionHandlerInterface::read</methodname>
12+
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SessionHandlerInterface::read</methodname>
1313
<methodparam><type>string</type><parameter>id</parameter></methodparam>
1414
</methodsynopsis>
1515
<para>
@@ -22,7 +22,7 @@
2222
This method should retrieve the session data from storage by the
2323
session ID provided. The string returned by this method must be in the same
2424
serialized format as when originally passed to the <function>SessionHandlerInterface::write</function>
25-
If the record was not found, return an empty string.
25+
If the record was not found, return &false;.
2626
</para>
2727
<para>
2828
The data returned by this method will be decoded internally by PHP using the

reference/simplexml/simplexmlelement/addChild.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<refsect1 role="description">
1111
&reftitle.description;
1212
<methodsynopsis>
13-
<modifier>public</modifier> <type>SimpleXMLElement</type><methodname>SimpleXMLElement::addChild</methodname>
13+
<modifier>public</modifier> <type class="union"><type>SimpleXMLElement</type><type>null</type></type><methodname>SimpleXMLElement::addChild</methodname>
1414
<methodparam><type>string</type><parameter>qualifiedName</parameter></methodparam>
1515
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>value</parameter><initializer>&null;</initializer></methodparam>
1616
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>namespace</parameter><initializer>&null;</initializer></methodparam>
@@ -56,7 +56,7 @@
5656
&reftitle.returnvalues;
5757
<para>
5858
The <literal>addChild</literal> method returns a <type>SimpleXMLElement</type>
59-
object representing the child added to the XML node.
59+
object representing the child added to the XML node on success; &null; on failure.
6060
</para>
6161
</refsect1>
6262

reference/simplexml/simplexmlelement/xpath.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<refsect1 role="description">
1010
&reftitle.description;
1111
<methodsynopsis>
12-
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>SimpleXMLElement::xpath</methodname>
12+
<modifier>public</modifier> <type class="union"><type>array</type><type>null</type><type>false</type></type><methodname>SimpleXMLElement::xpath</methodname>
1313
<methodparam><type>string</type><parameter>expression</parameter></methodparam>
1414
</methodsynopsis>
1515
<para>
@@ -37,7 +37,7 @@
3737
<refsect1 role="returnvalues">
3838
&reftitle.returnvalues;
3939
<para>
40-
Returns an <type>array</type> of SimpleXMLElement objects or &false; in
40+
Returns an <type>array</type> of SimpleXMLElement objects on success; or &null; or &false; in
4141
case of an error.
4242
</para>
4343
</refsect1>

0 commit comments

Comments
 (0)