Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:101312
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: pass (pb1.pair.com: domain gmail.com designates 209.85.128.175 as permitted sender)
MIME-Version: 1.0
In-Reply-To: <CAH0Uv3Hf_uTgHo5bg5x_A5DUfkB7bjSXzPZ5yXGS3JDdDJWW+A@mail.gmail.com>
References: <CAH0Uv3Hf_uTgHo5bg5x_A5DUfkB7bjSXzPZ5yXGS3JDdDJWW+A@mail.gmail.com>
Date: Mon, 11 Dec 2017 09:16:49 +0100
Message-ID: <CADyq6sKLc=7tUt_bffXsmvvc2nBBp4mHiwzR_F=O3y85vUJCdA@mail.gmail.com>
To: Andreas Hennings <andreas@dqxtech.net>
Cc: PHP Internals List <internals@lists.php.net>
Content-Type: multipart/alternative; boundary="f403045e756602d97705600c28c2"
Subject: Re: [PHP-DEV] Reflection API: Add ::getFullName() method.
From: ocramius@gmail.com (Marco Pivetta)

--f403045e756602d97705600c28c2
Content-Type: text/plain; charset="UTF-8"

If you really want to expose a symbol's FQN, I suggest exposing the
internal name as per `(array)` cast semantics.

namespace A {
    class B {
        public $c;
        private $d;
        private $e;
    }
}

That would be:

"A\B#\$c"
"A\B#\0*\0\$d"
"A\B#\0A\\B\0\$e"

Obviously, the `\0` is horrible and can probably be improved: depends on
whether the API is intended for human or machine consumption. If it is
machine consumption, strings are the wrong approach anyway.

I'd also add that this would be (fucking finally!) a good way to fix PHP's
documentation horrible usage of `::` for both instance and static members.

On 11 Dec 2017 04:00, "Andreas Hennings" <andreas@dqxtech.net> wrote:

I propose a new method ::getFullName() for all methods that implement
\Reflector.
(I would add it to the \Reflector interface, but this would be a BC break.)

The full name would be, depending on the type:

function: "str_replace()", "Acme\foo()".
class: "Acme\Animal\Cat", "stdClass".
method: "Acme\Animal\Cat::meow()".
property: "Acme\Animal\Cat::$color".
etc.

I don't know if we can cover all reflection API classes in a meaningful way.
E.g. for ReflectionObject, the full name would be the same as for the
class, otherwise it would get complicated.

Currently the ::__toString() and ::export() return something else,
which is not really useful.

The goal is to have something that is different for different items.
E.g. a class and a function with the same name need to have a
different "full name", hence the added "()" for functions and methods.

As a rule of thumb, the "full name" is what one would put after a @see
tag in phpDoc, but without the leading "\\".
For consistency with the rest of PHP and reflection API, we should use
QN and not FQN as return value.


Related: I started another thread proposing a ::getHash() method.
I originally though to propose the two things in the same thread, but
I now think they should be discussed independently.

--
PHP Internals - PHP Runtime Development Mailing List
To unsubscribe, visit: http://www.php.net/unsub.php

--f403045e756602d97705600c28c2--