Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:128665
Precedence: list
MIME-Version: 1.0
References: <CAOWwgpk1Z_bns=Z55TqpYOBXvBGpurMfjTGPSgQ6Uf5QXfLOjg@mail.gmail.com>
In-Reply-To: <CAOWwgpk1Z_bns=Z55TqpYOBXvBGpurMfjTGPSgQ6Uf5QXfLOjg@mail.gmail.com>
Date: Wed, 10 Sep 2025 15:23:15 +0200
Message-ID: <CAEKnhAGq9i9347oYkSsuAjQXKmAPittYZh+964QXwsSVBCKuKA@mail.gmail.com>
Subject: Re: [PHP-DEV] [RFC] Soft-Deprecate __sleep() and __wakeup()
To: Nicolas Grekas <nicolas.grekas+php@gmail.com>
Cc: PHP Internals List <internals@lists.php.net>
Content-Type: multipart/alternative; boundary="000000000000696bf5063e7253ba"
From: bukka@php.net (Jakub Zelenka)

--000000000000696bf5063e7253ba
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

Hi,

On Fri, Sep 5, 2025 at 5:55=E2=80=AFPM Nicolas Grekas <nicolas.grekas+php@g=
mail.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 t=
o
> 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 string
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 the
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 understanding
of mangling.

Kind regards,

Jakub

--000000000000696bf5063e7253ba
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

<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.gre=
kas%2Bphp@gmail.com">nicolas.grekas+php@gmail.com</a>&gt; wrote:</div><div =
class=3D"gmail_quote gmail_quote_container"><blockquote class=3D"gmail_quot=
e" style=3D"margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204)=
;padding-left:1ex"><div dir=3D"ltr"><div>Hello internals,</div><div><br></d=
iv><div>Following the discussion that started at <a href=3D"https://externa=
ls.io/message/128226#128456" target=3D"_blank">https://externals.io/message=
/128226#128456</a> I wrote this RFC to formalize our consensus=C2=A0on the =
topic.</div><div><br></div><div>TL;DR, this is about converting the depreca=
tion of __sleep and __wakeup to a documentation-based soft deprecation:</di=
v><div><a href=3D"https://wiki.php.net/rfc/soft-deprecate-sleep-wakeup" tar=
get=3D"_blank">https://wiki.php.net/rfc/soft-deprecate-sleep-wakeup</a></di=
v><div><br></div></div></blockquote><div><br></div><div>We just had a discu=
ssion 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 ne=
eds to care about working correctly with the old format. For example when o=
bject is serialized, that string is stored into database. So when the appli=
cation is deployed, it should still work in the same way when unserializing=
 the string.</div><div><br></div><div>If __sleep is used to serialize priva=
te properties (not all but just some), then those property names are stored=
 in the mangled format (&quot;\x00&quot; . self::class . &quot;\x00&quot; p=
refix). It means to make it compatible in __serialize, the application has =
to mangle property names - this can be done either manually prefixing the n=
ame or using=C2=A0get_mangled_object_vars and filter the mangled names. Alt=
ernatively it could use=C2=A0__serialize with the new names but then it wil=
l 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 prop=
erty name and get some understanding of mangling.</div><div><br></div><div>=
Kind regards,</div><div><br></div><div>Jakub</div></div></div>

--000000000000696bf5063e7253ba--