Refleksja PHP

Nette\Utils\Reflection to klasa statyczna udostępniająca przydatne funkcje do refleksji PHP. Jej zadaniem jest nadrobienie braków natywnych klas refleksji i ujednolicenie zachowania w różnych wersjach PHP.

Instalacja:

composer require nette/utils

Wszystkie przykłady zakładają, że zdefiniowany jest następujący alias klasy:

use Nette\Utils\Reflection;

areCommentsAvailable(): bool

Sprawdza, czy refleksja ma dostęp do komentarzy PHPdoc. Komentarze mogą być niedostępne z powodu cachowania opcode'ów, zobacz na przykład dyrektywę opcache.save-comments.

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

Rozwija nazwę klasy $name do jej w pełni kwalifikowanej postaci w kontekście klasy $context, uwzględniając jej przestrzeń nazw i zdefiniowane aliasy. W istocie ustala, jak parser PHP zinterpretowałby $name, gdyby zostało zapisane wewnątrz ciała klasy $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

Zwraca refleksję metody zawierającej faktyczną deklarację $method. Zwykle metoda jest własną deklaracją, ale jej ciało może pochodzić z traitu i to potencjalnie pod inną nazwą.

Ponieważ PHP nie dostarcza informacji wystarczających do niezawodnego ustalenia prawdziwej deklaracji, Nette używa własnej heurystyki, która powinna być niezawodna.

trait DemoTrait
{
	function foo()
	{
	}
}


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


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

getParameterDefaultValue (\ReflectionParameter $param): mixed

Zwraca wartość domyślną parametru funkcji albo metody. W odróżnieniu od natywnej ReflectionParameter::getDefaultValue() poprawnie rozwiązuje także stałe i stałe klasowe użyte jako wartość domyślna. Jeśli stałej nie da się rozwiązać, zgłasza \ReflectionException.

class DemoClass
{
	const DefaultValue = 123;
}

function demo($param = DemoClass::DefaultValue)
{
}

$param = new ReflectionParameter('demo', 'param');
echo Reflection::getParameterDefaultValue($param); // 123

getPropertyDeclaringClass (ReflectionProperty $prop): ReflectionClass

Zwraca refleksję klasy albo traitu zawierającego deklarację właściwości $prop. Właściwość może być zadeklarowana wewnątrz traitu.

Ponieważ PHP nie dostarcza informacji wystarczających do niezawodnego ustalenia prawdziwej deklaracji, Nette używa własnej heurystyki, która nie jest w pełni niezawodna.

trait DemoTrait
{
	public $foo;
}


class DemoClass
{
	use DemoTrait;
}

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

getUseStatements (ReflectionClass $class): array

Zwraca tablicę deklaracji use (aliasów) z pliku, w którym zdefiniowana jest klasa $class. Kluczami są aliasy, wartościami w pełni kwalifikowane nazwy klas. Wymaga rozszerzenia PHP tokenizer.

namespace Foo;

use Nette\Utils\Strings;
use Nette\Utils\Arrays as Arr;

class DemoClass
{
}

$class = new ReflectionClass(Foo\DemoClass::class);
Reflection::getUseStatements($class);
// ['Strings' => 'Nette\Utils\Strings', 'Arr' => 'Nette\Utils\Arrays']

isBuiltinType (string $type): bool

Sprawdza, czy $type jest wbudowanym typem PHP. W przeciwnym razie uznawany jest za nazwę klasy.

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

Użyj Nette\Utils\Validators::isBuiltinType().

toString ($reflection): string

Konwertuje obiekt refleksji na string czytelny dla człowieka.

$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'