Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:101298
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: error (pb1.pair.com: domain dqxtech.net from 209.85.215.50 cause and error)
MIME-Version: 1.0
Date: Mon, 11 Dec 2017 01:51:53 +0100
Message-ID: <CAH0Uv3G7YZHHaifKGyjTs3_HUbqEZ6wStZvSgDmKf14z3y7xpw@mail.gmail.com>
To: PHP internals <internals@lists.php.net>
Content-Type: text/plain; charset="UTF-8"
Subject: Reflection API: Add ->getTerminatedNamespace() method
From: andreas@dqxtech.net (Andreas Hennings)

## Background / motivation

Currently a number of reflection classes have a method ->getNamespaceName().

The namespace comes in a format that is not straightforward to work with.
It requires the root namespace to be treated in a special way.

$namespace = $relfClass->getNamespaceName();
$shortname = $reflClass->getShortName();
$class = $reflClass->getName();

if ('' === $namespace) {
  assert($class === $namespace . $shortname);
  assert($class === $shortname);
  assert($class !== $namespace . '\\' . $shortname);
}
else {
  assert($class === $namespace . '\\' . $shortname;
  assert($class !== $namespace . $shortname);
}

Code that deals with namespaces therefore always needs a special case
for the root namespace.


## Proposal

I propose that reflection components that currently have a
->getNamespaceName() method get another method
->getTerminatedNamespace().
This comes with ending namespace separator, unless it is the root namespace.

namespace Acme\Animal;
class Cat {}

assert('Acme\Animal\\' === (new
\ReflectionClass(Cat::class))->getTerminatedNamespace());
assert('Acme\Animal' === (new
\ReflectionClass(Cat::class))->getNamespaceName());

assert('' === (new
\ReflectionClass(\stdClass::class))->getTerminatedNamespace());
assert('' === (new \ReflectionClass(\stdClass::class))->getNamespaceName());

foreach ([Cat::class, \stdClass::class] as $class) {
  $reflClass = new \ReflectionClass($class);
  assert($reflClass->getName() ===
$reflClass->getTerminatedNamespace() . $reflClass->getShortName());
}

This would allow all cases to be covered by the same logic.