PHP Reflexe
***********
.[perex]
[api: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:
```shell
composer require nette/utils
```
Všechny příklady předpokládají vytvořený alias:
```php
use Nette\Utils\Reflection;
```
areCommentsAvailable(): bool .[method]
--------------------------------------
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|https://www.php.net/manual/en/opcache.configuration.php#ini.opcache.save-comments].
expandClassName(string $name, ReflectionClass $context): string .[method]
-------------------------------------------------------------------------
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`.
```php
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 .[method]
------------------------------------------------------------------------------
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á.
```php
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 .[method]
----------------------------------------------------------------------
Vrací výchozí hodnotu parametru funkce nebo metody. Na rozdíl od nativní `ReflectionParameter::getDefaultValue()` správně vyhodnotí i konstanty a konstanty tříd použité jako výchozí hodnota. Pokud konstantu nelze vyhodnotit, vyhodí `\ReflectionException`.
```php
class DemoClass
{
const DefaultValue = 123;
}
function demo($param = DemoClass::DefaultValue)
{
}
$param = new ReflectionParameter('demo', 'param');
echo Reflection::getParameterDefaultValue($param); // 123
```
getPropertyDeclaringClass(ReflectionProperty $prop): ReflectionClass .[method]
------------------------------------------------------------------------------
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á.
```php
trait DemoTrait
{
public $foo;
}
class DemoClass
{
use DemoTrait;
}
$prop = new ReflectionProperty(DemoClass::class, 'foo');
Reflection::getPropertyDeclaringClass($prop); // ReflectionClass('DemoTrait')
```
getUseStatements(ReflectionClass $class): array .[method]
---------------------------------------------------------
Vrací pole use (aliasů) ze souboru, ve kterém je definována třída `$class`. Klíče jsou aliasy, hodnoty jsou plné názvy tříd. Vyžaduje PHP rozšíření `tokenizer`.
```php
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 .[method deprecated]
------------------------------------------------------
Zjistí, zda je `$type` vestavěný typ PHP. V opačném případě jde o název třídy.
```php
Reflection::isBuiltinType('string'); // true
Reflection::isBuiltinType('Foo'); // false
```
.[note]
Použijte [Nette\Utils\Validators::isBuiltinType() |validators#isBuiltinType].
toString($reflection): string .[method]
---------------------------------------
Převede reflexi na lidsky srozumitelný řetězec.
```php
$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'
```
{{maintitle: PHP reflexe v Nette Utils: pomocné funkce a klauzule use}}
{{description: Funkce, které doplňují nativní reflexi PHP a sjednocují ji napříč verzemi: rozvinutí názvů tříd, čtení klauzulí use a dohledání deklarace metody či property.}}
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;
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')
getParameterDefaultValue (\ReflectionParameter $param): mixed
Vrací výchozí hodnotu parametru funkce nebo metody. Na rozdíl od nativní
ReflectionParameter::getDefaultValue() správně vyhodnotí i konstanty a konstanty tříd použité jako výchozí
hodnota. Pokud konstantu nelze vyhodnotit, vyhodí \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
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')
getUseStatements (ReflectionClass
$class): array
Vrací pole use (aliasů) ze souboru, ve kterém je definována třída $class. Klíče jsou aliasy, hodnoty jsou
plné názvy tříd. Vyžaduje PHP rozšíření 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
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\Validators::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'