Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:97787
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: pass (pb1.pair.com: domain gmail.com designates 209.85.213.180 as permitted sender)
MIME-Version: 1.0
Sender: jakub.php@gmail.com
In-Reply-To: <DB5PR0101MB17369EA346E27CFB74CBA862917D0@DB5PR0101MB1736.eurprd01.prod.exchangelabs.com>
References: <DB5PR0101MB1736F89440F718E955C7A89491660@DB5PR0101MB1736.eurprd01.prod.exchangelabs.com>
 <CAEKnhAHo4=HhfjnNDJu7M=KHipF9sC4ZZBcUCDjgk7nkUNT+eA@mail.gmail.com> <DB5PR0101MB17369EA346E27CFB74CBA862917D0@DB5PR0101MB1736.eurprd01.prod.exchangelabs.com>
Date: Mon, 16 Jan 2017 12:01:11 +0000
Message-ID: <CAEKnhAFJCj64yRWKX4q=2gAVj-U-nP4xanrdiRUhOVupk7xkmw@mail.gmail.com>
To: Jani Ollikainen <jani.ollikainen@valve.fi>
Cc: "internals@lists.php.net" <internals@lists.php.net>
Content-Type: multipart/alternative; boundary=001a1144047e90dd05054634f084
Subject: Re: [PHP-DEV] Exposing jsonSerialize's depth
From: bukka@php.net (Jakub Zelenka)

--001a1144047e90dd05054634f084
Content-Type: text/plain; charset=UTF-8

On Mon, Jan 16, 2017 at 8:19 AM, Jani Ollikainen <jani.ollikainen@valve.fi>
wrote:

> Hi,
>
> > I don't really like this. The reason is that you don't actually modify
> JsonSerializable interface for the obvious BC break that it would cause it.
> It means that the > function just gets this parameter and it kind of raises
> a question how we should document it? The solution would be to extend
> JsonSerializable with some
> > new interface. However I don't think it's worth it for such thing. Maybe
> you should consider to pre-process your data before passing it to
> json_encode...
>
> What BC break are you talking about? There is no need for using the
> parameter in old codes. Even if we pass that depth to jsonSerialize doing
> something like:
> "public function jsonSerialize() {...}" will still work without any
> problems.
>
> And how would you document it it? Like any other.. if there now is:
> http://php.net/manual/en/jsonserializable.jsonserialize.php
> abstract public mixed JsonSerializable::jsonSerialize ( void )
> This function has no parameters.
> Then it would just be:
> abstract public mixed JsonSerializable::jsonSerialize ( [integer $depth] )
>

That's not what is implemented. You just call jsonSerialize with an extra
parameter and basically create a contract that is not specified by the
interface. As you can see from the example that Niklas sent, you can't just
add an optional parameter to the interface method as it would be a BC break.

Cheers

Jakub

--001a1144047e90dd05054634f084--