Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:126081
Precedence: bulk
MIME-Version: 1.0
Date: Fri, 29 Nov 2024 13:28:20 +0100
To: =?UTF-8?Q?M=C3=A1t=C3=A9_Kocsis?= <kocsismate90@gmail.com>
Cc: Larry Garfield <larry@garfieldtech.com>, php internals
 <internals@lists.php.net>
Subject: Re: [PHP-DEV] [RFC] [Discussion] Add WHATWG compliant URL parsing API
In-Reply-To: <CAH5C8xW7sObyaU4=RwQvfdU0ogiWiKr_rDLgGchKkP7K8frAOg@mail.gmail.com>
References: <CAH5C8xUb1O20ZDrOQNC=ckFxHUUWSK7sw_njQQzFBd0qgQqoww@mail.gmail.com>
 <dd61999c-1ebd-4765-9add-cd8065968965@gmail.com>
 <CAOV5rgYZ_s1of-igLFEK7oqqh6=3HeYv0=JvvKvvjkcp0F6Q9Q@mail.gmail.com>
 <CAH5C8xV67frqOBCvLt73RM7QO86_pu40sHP5h71_kDRbKPtA8Q@mail.gmail.com>
 <f8e1d610-f8c5-460a-a73d-68dd37ab4636@app.fastmail.com>
 <CAH5C8xW7sObyaU4=RwQvfdU0ogiWiKr_rDLgGchKkP7K8frAOg@mail.gmail.com>
Message-ID: <66cdd51cc77ce4be73801c4f0735f440@bastelstu.be>
Content-Type: text/plain; charset=UTF-8;
 format=flowed
Content-Transfer-Encoding: 8bit
From: tim@bastelstu.be (=?UTF-8?Q?Tim_D=C3=BCsterhus?=)

Hi

Am 2024-11-24 21:40, schrieb Máté Kocsis:
>> It took me a while to realize that, I think, the fromWhatWg() method 
>> is
>> using an in/out parameter for error handling.  That is an insta-no on 
>> my
>> part.  in/out reference parameters make sense in C, maybe C++, and
>> basically nowhere else.  I view them as a code smell everywhere 
>> they're
>> used in PHP.  Better alternatives include exceptions or union returns.
>> 
> 
> Yes, originally the RFC used a reference parameter to return the error
> during parsing. I knew it was controversial, but that's what was a
> consistent choice with other internal functions/methods.
> After your feedback, I changed this behavior to an union type return 
> type:
> 
> public static function parse(string $uri, ?string $baseUrl = null):
> static|array {}
> 
> So that in case of failure, an array of Uri\WhatWgError objects are
> returned. This practice is not really idiomatic with PHP, so personally 
> I'm
> not sure I like it, but neither did I particularly like passing a 
> parameter
> by reference...

I disagree with this change and believe that with the current 
capabilities of PHP the out-parameter is the correct API design choice, 
because then the “failure” case would be returning a falsy value, which 
IMO is pretty idiomatic PHP:

     if (($uri = WhatWgUri::parse($someUri, errors: $errors)) !== null) {
         printf("Your URI '%s' is valid. Here it is: %s", $someUri, 
$uri);
     } else {
         printf("Your URI '%s' is invalid, there were %d errors.\n", 
$someUri, $errors);
     }

It would also unify the API between Rfc3986Uri and WhatWgUri.

Best regards
Tim Düsterhus