Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:112970
To: Rowan Tommins <rowan.collins@gmail.com>, "internals@lists.php.net"
	<internals@lists.php.net>
Thread-Topic: [PHP-DEV] [RFC] var_representation() : readable alternative to
 var_export()
Thread-Index: AQHW8R1wWWGP+37l0kiexDpDbUAmVKo1egmAgAAyURI=
Date: Sat, 23 Jan 2021 21:07:58 +0000
Message-ID:
 <DM6PR07MB661825BCB913F64BB24A1510F9BF9@DM6PR07MB6618.namprd07.prod.outlook.com>
References:
 <DM6PR07MB66184CC05829642BD4E16E3AF9BF9@DM6PR07MB6618.namprd07.prod.outlook.com>,<5ae166a8-378e-b3bc-056a-8ccf4f3a1ddd@gmail.com>
In-Reply-To: <5ae166a8-378e-b3bc-056a-8ccf4f3a1ddd@gmail.com>
Accept-Language: en-CA, en-US
Content-Language: en-CA
x-ms-exchange-messagesentrepresentingtype: 1
x-tmn: [jKx0rW/GYKmn6ETrqweLPfTfcPbW5QBMW3TyXHWjzXIZXXYjO2lGLwFKDyKLBG/J]
x-ms-publictraffictype: Email
x-incomingheadercount: 44
x-eopattributedmessage: 0
x-ms-office365-filtering-correlation-id: a0aec3bb-465c-4241-a5ef-08d8bfe2f683
x-ms-traffictypediagnostic: MW2NAM10HT029:
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info:
 QBDWJk8BTOWne122NK4Ti7GziZlmV3nClfVYsXJxdqSfis56kVwz16Dx8Sd3PBXGjZ+D4GjacDjVopv2fKfPScBOio+p0JOjlTi3HpPjeA/9pNruZpkPkYCQd9pDrWggc76ZulDdrEjZCfkRsINyDSODqbIraHylCtthE00wZCnG+UQfsx1nd9SnsW7Y9CjSxlOEbo5c8wWeX53qBzWtVWXDn1jTjF9u6ZmjcB7erldmw/cPGkJyqR6BVfFq8SZdAzaLLSBUiJk+1ydwvVoPc4kFd5p93Wp4fmRA2VuVCWI=
x-ms-exchange-antispam-messagedata:
 q+Tpl+Eh1MemASpIJbSEdiRHKjK1CMQQu5qKVzxN1p7JDRpTn/YRZmvf5OdkwzzekjspiUMjrZ10GmjhEFnLryX7pSGg5WKeMNqSxIAwsSrqqGRBDyJVDrfS6ADFoFtKk6QKARnztmXeJD2kCvbzk4/xuEU0V5ujc/q+/do7gHM54a6bf4ohxg3AvQK5y6rt368llde0p7uWqK+Mca5rlA==
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: MW2NAM10FT060.eop-nam10.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-CrossTenant-Network-Message-Id: a0aec3bb-465c-4241-a5ef-08d8bfe2f683
X-MS-Exchange-CrossTenant-originalarrivaltime: 23 Jan 2021 21:07:58.8194
 (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: MW2NAM10HT029
Subject: Re: [PHP-DEV] [RFC] var_representation() : readable alternative to
 var_export()
From: tysonandre775@hotmail.com (tyson andre)

Hi Rowan Tommins,=0A=
=0A=
> > Hi internals,=0A=
> >=0A=
> > I've created=A0https://wiki.php.net/rfc/readable_var_representation=A0b=
ased on=0A=
> > my original proposal in https://externals.io/message/112924=0A=
> >=0A=
> > This RFC proposes adding a new function `var_representation(mixed $valu=
e, int $flags=3D0): string`=0A=
>=0A=
> My hesitation remains that this is just duplicating existing =0A=
> functionality with only cosmetic differences.=0A=
> =0A=
> As a user of PHP 8.1, how would I decide whether to use print_r, =0A=
> var_dump, var_export, or var_representation?=0A=
> =0A=
> And under what circumstances would I bother to write =0A=
> "var_representation($var, VAR_REPRESENTATION_SINGLE_LINE);"?=0A=
=0A=
You have a good point on needing to document the circumstances where this w=
ould be useful.=0A=
I meant to write up the reasons where an end user would=0A=
or wouldn't want this functionality - it's useful when reviewing or voting =
on the RFC.=0A=
I've added those to https://wiki.php.net/rfc/readable_var_representation#wh=
en_would_a_user_use_var_representation=0A=
, including when I think the VAR_REPRESENTATION_SINGLE_LINE flag would be u=
seful to users.=0A=
=0A=
var_representation  may be useful to a user when any of the following apply=
:=0A=
=0A=
- You are generating a snippet of code to eval() in a situation where the s=
nippet will occasionally or frequently be read by a human  (If the output n=
ever needs to be read by a human, `return unserialize(' . var_export(serial=
ize($data), true) . ');` can be used)=0A=
- The output is occasionally or frequently read by humans (e.g. CLI or web =
app output, a REPL, unit test output, etc.).=0A=
- The output contains control characters such as newlines, tabs, `\r` or `\=
x00` and may be viewed or edited by other users in a text editor/IDE. Many =
IDEs may convert from windows line endings (`\r\n`) to unix line endings(`\=
n`) automatically.=0A=
- You want to unambiguously see control characters in the raw output regard=
less of how likely they are (e.g. dumping php ini settings, debugging myste=
rious test failures, etc)=0A=
- You are writing unit tests for applications supporting PHP 8.1+ (or a var=
_representation polyfill) that test the exact string representation of the =
output (e.g. phpt tests of php-src and PECL extensions) =0A=
- You need to copy the output into a codebase that's following a modern cod=
ing style guideline such as modern coding guidelines such as PSR-2. It also=
 saves time if you don't have to remove array keys of lists and convert arr=
ay() to [].=0A=
=0A=
(I added that and a section on when/why a user may decide to use VAR_REPRES=
ENTATION_SINGLE_LINE in the RFC)=0A=
=0A=
As for print_r() - https://www.php.net/print_r seems underdocumented - It d=
oesn't mention how booleans, null, and floats are represented (same as prin=
t()) except in user notes.=0A=
=0A=
The online documentation for var_export/var_dump explains what they do but =
not why/when they would be used,=0A=
it may be worthwhile to submit a PR to expand on those.=0A=
=0A=
Regards,=0A=
Tyson=0A=