PHP Reflexe

Nette\Utils\Reflection je statická třída s užitečnými funkcemi pro PHP reflexi. Jejím úkolem je opravovat nedostatky nativních tříd a sjednocovat chování napříč různými verzemi PHP.

Instalace:

composer require nette/utils

Všechny příklady předpokládají vytvořený alias:

use Nette\Utils\Reflection;

areCommentsAvailable(): bool

Zjistí, zda má reflexe přístup k PHPdoc komentářům. Komentáře mohou být nedostupné kvůli opcode cache, viz třeba direktiva opcache.save-comments.

expandClassName (string $name, ReflectionClass $context): string

Expanduje název třídy $name na její plný název v kontextu třídy $context, tedy v kontextu jejího jmenného prostoru a definovaných aliasů. Tedy vlastně říká, jak by PHP parser $name chápal, kdyby byl zapsaný v těle třídy $context.

namespace Foo;
use Bar;

class DemoClass
{
	// new Bar, new Baz
}

$context = new ReflectionClass(Foo\DemoClass::class);
Reflection::expandClassName('Bar', $context); // 'Bar'
Reflection::expandClassName('Baz', $context); // 'Foo\Baz'

getMethodDeclaringMethod (ReflectionMethod $method): ReflectionMethod

Vrací reflexi metody, která obsahuje deklaraci metody $method. Obvykle je každá metoda svou vlastní deklarací, ale tělo metody se může nacházet i v traitě a pod jiným názvem.

Protože PHP neposkytuje dostatečné informace, pomocí kterých lze skutečnou deklaraci zjistit, využívá Nette vlastní heuristiku, která by měla být spolehlivá.

trait DemoTrait
{
	function foo()
	{
	}
}


class DemoClass
{
	use DemoTrait {
		DemoTrait::foo as foo2;
	}
}


$method = new ReflectionMethod('DemoClass::foo2');
Reflection::getMethodDeclaringMethod($method); // ReflectionMethod('DemoTrait::foo')

getPropertyDeclaringClass (ReflectionProperty $prop): ReflectionClass

Vrací reflexi třídy či traity, která obsahuje deklaraci property $prop. Property totiž může být deklarovaná i v traitě.

Protože PHP neposkytuje dostatečné informace, pomocí kterých lze skutečnou deklaraci zjistit, využívá Nette vlastní heuristiku, která není spolehlivá.

trait DemoTrait
{
	public $foo;
}


class DemoClass
{
	use DemoTrait;
}

$prop = new ReflectionProperty(DemoClass::class, 'foo');
Reflection::getPropertyDeclaringClass($prop); // ReflectionClass('DemoTrait')

isBuiltinType (string $type): bool

Zjistí, zda je $type vestavěný typ PHP. V opačném případě jde o název třídy.

Reflection::isBuiltinType('string'); // true
Reflection::isBuiltinType('Foo');    // false

Použijte Nette\Utils\Validator::isBuiltinType().

toString ($reflection): string

Převede reflexi na lidsky srozumitelný řetězec.

$func = new ReflectionFunction('func');
echo Reflection::toString($func); // 'func()'

$class = new ReflectionClass('DemoClass');
echo Reflection::toString($class); // 'DemoClass'

$method = new ReflectionMethod('DemoClass', 'foo');
echo Reflection::toString($method); // 'DemoClass::foo()'

$param = new ReflectionParameter(['DemoClass', 'foo'], 'param');
echo Reflection::toString($param); // '$param in DemoClass::foo()'

$prop = new ReflectionProperty('DemoClass', 'foo');
echo Reflection::toString($prop); // 'DemoClass::$foo'