Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:123196
Message-ID: <AE135481-7ECE-41E8-AC43-B92D355D71F3@gmail.com>
Content-Type: multipart/alternative;
	boundary="Apple-Mail=_D5B0441D-AFC4-4189-82F6-0F29E29403D9"
Precedence: bulk
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3774.500.171.1.1\))
Subject: Re: [PHP-DEV] [RFC] [Discussion] Add openStream() to
 XML{Reader,Writer}
Date: Wed, 24 Apr 2024 10:22:47 +0200
In-Reply-To: <1deaa188-3b2c-4527-b3c3-fd5df1ee1757@gmail.com>
Cc: internals@lists.php.net
To: Niels Dossche <dossche.niels@gmail.com>
References: <b8513546-294d-482e-bd1c-292b455e66a8@gmail.com>
 <056a0e77-688e-40a9-86de-0bf71548c933@app.fastmail.com>
 <1deaa188-3b2c-4527-b3c3-fd5df1ee1757@gmail.com>
From: claude.pache@gmail.com (Claude Pache)


--Apple-Mail=_D5B0441D-AFC4-4189-82F6-0F29E29403D9
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain;
	charset=utf-8



> Le 23 avr. 2024 =C3=A0 21:23, Niels Dossche <dossche.niels@gmail.com> =
a =C3=A9crit :
>=20
> On 22/04/2024 21:53, Larry Garfield wrote:
>> On Mon, Apr 22, 2024, at 6:41 PM, Niels Dossche wrote:
>>> Hi internals
>>>=20
>>> I'm opening the discussion for my RFC "Add openStream() to =
XML{Reader,Writer}".
>>> RFC link: https://wiki.php.net/rfc/xmlreader_writer_streams
>>>=20
>>> Kind regards
>>> Niels
>>=20
>> This seems quite reasonable to me overall.  My one question is =
regarding the writer version.  Why is that not a static method, too?  I =
would have expected that to be a "named constructor" just like the =
reader.
>>=20
>> --Larry Garfield
>=20
> Hi Larry
>=20
> XMLReader already had these static methods that act as named =
constructors, but XMLWriter has no named constructors at the moment.
> The XMLWriter::openMemory() and XMLWriter::openUri() functions are =
instance methods that must be called after doing "new XMLWriter".
> If these two existing functions were static methods instead, I =
would've made XMLWriter::openStream() static too.
> So IOW, for consistency I followed the model of the existing XMLWriter =
methods.
>=20
> While it is possible to do the magic trick that XMLReader uses to have =
the open methods on XMLWriter both static and non-static, this is quite =
hacky and was only done to XMLReader for BC reasons.

That=E2=80=99s odd. The inconsistency was introduced (or at least =
sanctioned) in PHP 8.0. In PHP 7, XMLReader::open() and XMLReader::XML() =
already worked when used both as static and non-static methods, but =
triggered a deprecation warning when called statically. The deprecation =
warning was removed in 8.0, regardless of the differing semantics when =
called statically and non-statically, and regardless of the the =
inconsistency with corresponding XMLWriter methods.

Another point: when called statically on a subclass, both =
`XMLReader::open()` and `XMLReader::XML()` return an object of type =
`XMLReader`, not of the subclass: https://3v4l.org/lCOAvJ
For that reason, they are unusable as static methods on a subclass. The =
new `openStream()` method should work on instances, so that it will be =
usable on subclasses. (And for the same reason, I think it was a mistake =
to undeprecate `XMLReader::{open,XML}()` as static methods in 8.0.)

=E2=80=94Claude


--Apple-Mail=_D5B0441D-AFC4-4189-82F6-0F29E29403D9
Content-Transfer-Encoding: quoted-printable
Content-Type: text/html;
	charset=utf-8

<html><head><meta http-equiv=3D"content-type" content=3D"text/html; =
charset=3Dutf-8"></head><body style=3D"overflow-wrap: break-word; =
-webkit-nbsp-mode: space; line-break: after-white-space;"><br =
id=3D"lineBreakAtBeginningOfMessage"><div><br><blockquote =
type=3D"cite"><div>Le 23 avr. 2024 =C3=A0 21:23, Niels Dossche =
&lt;dossche.niels@gmail.com&gt; a =C3=A9crit :</div><br =
class=3D"Apple-interchange-newline"><div><div>On 22/04/2024 21:53, Larry =
Garfield wrote:<br><blockquote type=3D"cite">On Mon, Apr 22, 2024, at =
6:41 PM, Niels Dossche wrote:<br><blockquote type=3D"cite">Hi =
internals<br><br>I'm opening the discussion for my RFC "Add openStream() =
to XML{Reader,Writer}".<br>RFC link: =
https://wiki.php.net/rfc/xmlreader_writer_streams<br><br>Kind =
regards<br>Niels<br></blockquote><br>This seems quite reasonable to me =
overall. &nbsp;My one question is regarding the writer version. =
&nbsp;Why is that not a static method, too? &nbsp;I would have expected =
that to be a "named constructor" just like the reader.<br><br>--Larry =
Garfield<br></blockquote><br>Hi Larry<br><br>XMLReader already had these =
static methods that act as named constructors, but XMLWriter has no =
named constructors at the moment.<br>The XMLWriter::openMemory() and =
XMLWriter::openUri() functions are instance methods that must be called =
after doing "new XMLWriter".<br>If these two existing functions were =
static methods instead, I would've made XMLWriter::openStream() static =
too.<br>So IOW, for consistency I followed the model of the existing =
XMLWriter methods.</div></div></blockquote><blockquote =
type=3D"cite"><div><div><br>While it is possible to do the magic trick =
that XMLReader uses to have the open methods on XMLWriter both static =
and non-static, this is quite hacky and was only done to XMLReader for =
BC reasons.<br></div></div></blockquote><div><br></div>That=E2=80=99s =
odd. The inconsistency was introduced (or at least sanctioned) in PHP =
8.0. In PHP 7, XMLReader::open() and XMLReader::XML() already worked =
when used both as static and non-static methods, but triggered a =
deprecation warning when called statically. The deprecation warning was =
removed in 8.0, regardless of the differing semantics when called =
statically and non-statically, and regardless of the the inconsistency =
with corresponding XMLWriter methods.</div><div><br></div><div>Another =
point: when called statically on a subclass, both `XMLReader::open()` =
and `XMLReader::XML()` return an object of type `XMLReader`, not of the =
subclass:&nbsp;<a =
href=3D"https://3v4l.org/lCOAvJ">https://3v4l.org/lCOAvJ</a></div><div>For=
 that reason, they are unusable as static methods on a subclass. The new =
`openStream()` method should work on instances, so that it will be =
usable on subclasses. (And for the same reason, I think it was a mistake =
to undeprecate `XMLReader::{open,XML}()` as static methods in =
8.0.)</div><div><br></div><div>=E2=80=94Claude</div><div><br></div></body>=
</html>=

--Apple-Mail=_D5B0441D-AFC4-4189-82F6-0F29E29403D9--