Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:113075
To: "internals@lists.php.net" <internals@lists.php.net>
Thread-Topic: [RFC] var_representation() : readable alternative to
 var_export()
Thread-Index: AQHW8R1wWWGP+37l0kiexDpDbUAmVKpIIyDY
Date: Thu, 4 Feb 2021 14:36:05 +0000
Message-ID:
 <DM6PR07MB66189F7D092F98F05BE7AEA2F9B39@DM6PR07MB6618.namprd07.prod.outlook.com>
References:
 <DM6PR07MB66184CC05829642BD4E16E3AF9BF9@DM6PR07MB6618.namprd07.prod.outlook.com>
In-Reply-To:
 <DM6PR07MB66184CC05829642BD4E16E3AF9BF9@DM6PR07MB6618.namprd07.prod.outlook.com>
Accept-Language: en-CA, en-US
Content-Language: en-CA
x-ms-exchange-messagesentrepresentingtype: 1
x-tmn: [+sKbFNKdF3SPQJ052WOrpNBx0l4dtb0ooIAq66CxLOOcThd2kXEEDM++BblGarGP]
x-ms-publictraffictype: Email
x-incomingheadercount: 44
x-eopattributedmessage: 0
x-ms-office365-filtering-correlation-id: 5999d41d-8560-4d73-08bc-08d8c91a3437
x-ms-traffictypediagnostic: BN7NAM10HT181:
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info:
 8dGgOD56APMeQT029e5gcjw//S6kpas/K4x2ZZEWdKrNrIGZ2lLXIp4rfX9XueTxGeiRagilzxhiVLSGFyzz5tLto9pRdC0eNQIxATYHgglex/mIr6WSj/ANYPKjuUCjMw7LotMXplUTGm60NdB5hX56/mwSbmFl6WVQrjLIztE+wVXZ0/hOWy86kBY11m9VfSq+N1V0GxrWxLaZqZg6qbOVLuCurBmKlwB4nRXHsY/98F3mNWZBLm6iWXFJNcgLralJQpvaizOxZbKwAjl1aidUDrGcNUZAshO+5RV82v4ESqxjlPya7iVV43zQhxYFUVI5Dcg9UFpTBDVNr1MEt19m2KtPeo51HYOfH3WJJUZysREJwMt98YAaznrHS59VErjLyWVUgcY2u6liMN1L5CYk+cO8X4bL4HLLnu+o/OU=
x-ms-exchange-antispam-messagedata:
 hHLAvtj7ZaOqVYMdtLoFUG+JVsIRKCSdplPKpgN2cLv0r42n20vmK37fYID5OHp8YLhymSka9/9mWvnuI1TEsuTgTACCbNuKiAFMcWxnX6zZIRSgpEnaeGWouquJwbe1BbGCSfzoEeAqUJ0zWnFL4aF9vauvNisscGL45Ay5+4TQMvJXzYpwpyiIW9I+FUnAJJ+cOnp190VxSvqnkIn5eQ==
x-ms-exchange-transport-forked: True
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: hotmail.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-AuthSource: BN7NAM10FT047.eop-nam10.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-CrossTenant-Network-Message-Id: 5999d41d-8560-4d73-08bc-08d8c91a3437
X-MS-Exchange-CrossTenant-originalarrivaltime: 04 Feb 2021 14:36:05.4460
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Internet
X-MS-Exchange-CrossTenant-id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa
X-MS-Exchange-CrossTenant-rms-persistedconsumerorg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN7NAM10HT181
Subject: Re: [RFC] var_representation() : readable alternative to var_export()
From: tysonandre775@hotmail.com (tyson andre)

Hi internals,=0A=
=0A=
> I've created=A0https://wiki.php.net/rfc/readable_var_representation=A0bas=
ed on=0A=
> my original proposal in https://externals.io/message/112924=0A=
> =0A=
> This RFC proposes adding a new function `var_representation(mixed $value,=
 int $flags=3D0): string`=0A=
> with the following differences from var_export:=0A=
> =0A=
> 1. var_representation() unconditionally returns a string=0A=
> 2. Use `null` instead of `NULL` - lowercase is recommended by more coding=
=0A=
> =A0=A0 guidelines (https://www.php-fig.org/psr/psr-2/).=0A=
> 3. Change the way indentation is done for arrays/objects.=0A=
> =A0=A0 See ext/standard/tests/general_functions/short_var_export1.phpt=0A=
> =A0=A0 (e.g. always add 2 spaces, never 3 in objects, and put the array s=
tart on the=0A=
> =A0=A0 same line as the key)=0A=
> 4. Render lists as `"['item1']"` rather than `"array(\n=A0 0 =3D> 'item1'=
,\n)"`=0A=
> =0A=
> =A0=A0 Always render empty lists on a single line, render multiline by de=
fault when there are 1 or more elements=0A=
> 5. Prepend `\` to class names so that generated code snippets can be used=
 in=0A=
> =A0=A0 namespaces without any issues.=0A=
> 6. Support `VAR_REPRESENTATION_SINGLE_LINE` in `$flags`.=0A=
> =A0=A0 This will use a single-line representation for arrays/objects, tho=
ugh=0A=
> =A0=A0 strings with embedded newlines will still cause newlines in the ou=
tput.=0A=
> 7. If a string contains control characters("\x00"-"\x1f" and "\x7f"(backs=
pace)),=0A=
> =A0=A0 then represent the entire string as a double quoted string=0A=
> =A0=A0 escaping `\r`, `\n`, `\t`, `\$`, `\\`, and `\"`, in addition to es=
caping remaining control characters=0A=
> =A0=A0 with hexadecimal encoding (\x00, \x7f, etc)=0A=
> =0A=
> This is different from my original proposal in two ways:=0A=
> 1. The function signature and name changed from my previous proposal.=0A=
> =A0=A0=A0 It now always returns a string.=0A=
> 2. Backspace control characters (\x7f) are now also escaped.=0A=
=0A=
A reminder that voting on the var_representation RFC starts in a day.=0A=
This RFC proposes adding a new function `var_representation(mixed $value, i=
nt $flags=3D0): string` with multiple improvements on `var_export()`.=0A=
=0A=
Any other feedback?=0A=
=0A=
Thanks,=0A=
- Tyson=