Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:128666
Precedence: list
MIME-Version: 1.0
References: <CAOWwgpk1Z_bns=Z55TqpYOBXvBGpurMfjTGPSgQ6Uf5QXfLOjg@mail.gmail.com>
 <CAEKnhAGq9i9347oYkSsuAjQXKmAPittYZh+964QXwsSVBCKuKA@mail.gmail.com>
In-Reply-To: <CAEKnhAGq9i9347oYkSsuAjQXKmAPittYZh+964QXwsSVBCKuKA@mail.gmail.com>
Date: Wed, 10 Sep 2025 16:09:41 +0200
Message-ID: <CAEKnhAFarPoUNMxYJdEpD9xBgi5gLkzhJsm-CT+4fWZwLaho1w@mail.gmail.com>
Subject: Re: [PHP-DEV] [RFC] Soft-Deprecate __sleep() and __wakeup()
To: PHP Internals List <internals@lists.php.net>
Content-Type: multipart/alternative; boundary="0000000000006df313063e72f98d"
From: bukka@php.net (Jakub Zelenka)

--0000000000006df313063e72f98d
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

Hi,

On Wed, Sep 10, 2025 at 3:23=E2=80=AFPM Jakub Zelenka <bukka@php.net> wrote=
:

> Hi,
>
> On Fri, Sep 5, 2025 at 5:55=E2=80=AFPM Nicolas Grekas <
> nicolas.grekas+php@gmail.com> wrote:
>
>> Hello internals,
>>
>> Following the discussion that started at
>> https://externals.io/message/128226#128456 I wrote this RFC to formalize
>> our consensus on the topic.
>>
>> TL;DR, this is about converting the deprecation of __sleep and __wakeup
>> to a documentation-based soft deprecation:
>> https://wiki.php.net/rfc/soft-deprecate-sleep-wakeup
>>
>>
> We just had a discussion privately about this and I came with one example
> that would be worth to add here. It is about storing the serialized strin=
g
> where application needs to care about working correctly with the old
> format. For example when object is serialized, that string is stored into
> database. So when the application is deployed, it should still work in th=
e
> same way when unserializing the string.
>
> If __sleep is used to serialize private properties (not all but just
> some), then those property names are stored in the mangled format ("\x00"=
 .
> self::class . "\x00" prefix). It means to make it compatible in
> __serialize, the application has to mangle property names - this can be
> done either manually prefixing the name or using get_mangled_object_vars
> and filter the mangled names. Alternatively it could use __serialize with
> the new names but then it will need to deal with new and old (mangled)
> formats in __unserialize. In any case it means that the users will be
> required to deal with the mangled property name and get some understandin=
g
> of mangling.
>

I just had a chat with Nicolas and he asked me to add it and co-author the
RFC so the section added here:
https://wiki.php.net/rfc/soft-deprecate-sleep-wakeup#complex_handling_of_ma=
ngled_property_names_with_persistent_storage

Kind regards,

Jakub

--0000000000006df313063e72f98d
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div>Hi,</div><br><div class=3D"gmail_quote gmail_quote_co=
ntainer"><div dir=3D"ltr" class=3D"gmail_attr">On Wed, Sep 10, 2025 at 3:23=
=E2=80=AFPM Jakub Zelenka &lt;<a href=3D"mailto:bukka@php.net">bukka@php.ne=
t</a>&gt; wrote:<br></div><blockquote class=3D"gmail_quote" style=3D"margin=
:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"=
><div dir=3D"ltr"><div>Hi,</div><div><br></div><div dir=3D"ltr">On Fri, Sep=
 5, 2025 at 5:55=E2=80=AFPM Nicolas Grekas &lt;<a href=3D"mailto:nicolas.gr=
ekas%2Bphp@gmail.com" target=3D"_blank">nicolas.grekas+php@gmail.com</a>&gt=
; wrote:</div><div class=3D"gmail_quote"><blockquote class=3D"gmail_quote" =
style=3D"margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);pa=
dding-left:1ex"><div dir=3D"ltr"><div>Hello internals,</div><div><br></div>=
<div>Following the discussion that started at <a href=3D"https://externals.=
io/message/128226#128456" target=3D"_blank">https://externals.io/message/12=
8226#128456</a> I wrote this RFC to formalize our consensus=C2=A0on the top=
ic.</div><div><br></div><div>TL;DR, this is about converting the deprecatio=
n of __sleep and __wakeup to a documentation-based soft deprecation:</div><=
div><a href=3D"https://wiki.php.net/rfc/soft-deprecate-sleep-wakeup" target=
=3D"_blank">https://wiki.php.net/rfc/soft-deprecate-sleep-wakeup</a></div><=
div><br></div></div></blockquote><div><br></div><div>We just had a discussi=
on privately about this and I came with one example that would be worth to =
add here. It is about storing the serialized string where application needs=
 to care about working correctly with the old format. For example when obje=
ct is serialized, that string is stored into database. So when the applicat=
ion is deployed, it should still work in the same way when unserializing th=
e string.</div><div><br></div><div>If __sleep is used to serialize private =
properties (not all but just some), then those property names are stored in=
 the mangled format (&quot;\x00&quot; . self::class . &quot;\x00&quot; pref=
ix). It means to make it compatible in __serialize, the application has to =
mangle property names - this can be done either manually prefixing the name=
 or using=C2=A0get_mangled_object_vars and filter the mangled names. Altern=
atively it could use=C2=A0__serialize with the new names but then it will n=
eed to deal with new and old (mangled) formats in __unserialize. In any cas=
e it means that the users will be required to deal with the mangled propert=
y name and get some understanding of mangling.</div></div></div></blockquot=
e><div><br></div><div>I just had a chat with Nicolas and he asked me to add=
 it and co-author the RFC so the section added here:=C2=A0=C2=A0<a href=3D"=
https://wiki.php.net/rfc/soft-deprecate-sleep-wakeup#complex_handling_of_ma=
ngled_property_names_with_persistent_storage">https://wiki.php.net/rfc/soft=
-deprecate-sleep-wakeup#complex_handling_of_mangled_property_names_with_per=
sistent_storage</a> </div><div><br></div><div>Kind regards,</div><div><br><=
/div><div>Jakub</div></div></div>

--0000000000006df313063e72f98d--