La clase ReflectionParameter

(PHP 5, PHP 7, PHP 8)

Introducción

La clase ReflectionParameter recupera las informaciones sobre los argumentos de las funciones o de los métodos.

Para realizar una introspección sobre los argumentos de las funciones, primero se crea una instancia de la clase ReflectionFunction o de la clase ReflectionMethod y luego se utiliza el método ReflectionFunctionAbstract::getParameters() para recuperar un array de los argumentos.

Sinopsis de la clase

class ReflectionParameter implements Reflector {

/* Propiedades */

public string $name ;

/* Métodos */

public function __construct (string |array |object $function, int |string $param)

public function allowsNull (): bool

public function canBePassedByValue (): bool

private function __clone (): void

public static function export (string $function, string $parameter, bool $return = ?): string

public function getAttributes (? string $name = null , int $flags = 0): array

#[\Deprecated]
public function getClass (): ? ReflectionClass

public function getDeclaringClass (): ? ReflectionClass

public function getDeclaringFunction (): ReflectionFunctionAbstract

public function getDefaultValue (): mixed

public function getDefaultValueConstantName (): ? string

public function getName (): string

public function getPosition (): int

public function getType (): ? ReflectionType

public function hasType (): bool

#[\Deprecated]
public function isArray (): bool

#[\Deprecated]
public function isCallable (): bool

public function isDefaultValueAvailable (): bool

public function isDefaultValueConstant (): bool

public function isOptional (): bool

public function isPassedByReference (): bool

public function isPromoted (): bool

public function isVariadic (): bool

public function __toString (): string

}

Propiedades

name: Nombre del argumento. Solo lectura, genera ReflectionException al intentar escribir.

Historial de cambios

Versión	Descripción
8.0.0	ReflectionParameter::export() ha sido eliminado.

Tabla de contenidos

ReflectionParameter::allowsNull — Verifica si el valor null está permitido como valor del argumento
ReflectionParameter::canBePassedByValue — Verifica si el parámetro puede ser pasado por valor
ReflectionParameter::__clone — Clonación
ReflectionParameter::__construct — Constructor
ReflectionParameter::export — Exportación
ReflectionParameter::getAttributes — Devuelve los atributos
ReflectionParameter::getClass — Obtiene un objeto ReflectionClass para el parámetro que se está reflejando o null
ReflectionParameter::getDeclaringClass — Obtiene la clase declarante
ReflectionParameter::getDeclaringFunction — Obtiene la función declarante
ReflectionParameter::getDefaultValue — Obtiene el valor por defecto del argumento
ReflectionParameter::getDefaultValueConstantName — Devuelve el nombre de la constante del valor por defecto si el valor es una constante o null
ReflectionParameter::getName — Obtiene el nombre del argumento
ReflectionParameter::getPosition — Obtiene la posición de un argumento
ReflectionParameter::getType — Obtiene el tipo del parámetro
ReflectionParameter::hasType — Verifica si un parámetro tiene un tipo
ReflectionParameter::isArray — Verifica si el parámetro espera un array
ReflectionParameter::isCallable — Verifica si el parámetro es de tipo callable
ReflectionParameter::isDefaultValueAvailable — Verifica si un valor por defecto está disponible para el parámetro
ReflectionParameter::isDefaultValueConstant — Verifica si el valor por defecto del argumento es una constante
ReflectionParameter::isOptional — Verifica si el parámetro es opcional
ReflectionParameter::isPassedByReference — Verifica si el parámetro es pasado por referencia
ReflectionParameter::isPromoted — Verifica si un parámetro es promovido como propiedad
ReflectionParameter::isVariadic — Verifica si el parámetro es variádico
ReflectionParameter::__toString — Obtiene una representación textual

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

+add a note

User Contributed Notes 4 notes

down

fgm at riff dot org ¶

18 years ago

The note about the signature of the ReflectionParameter constructor is actually incomplete, at least in 5.2.5: it is possible to use an integer for the second parameter, and the constructor will use it to return the n-th parameter.
This allows you to obtain proper ReflectionParameter objects even when documenting code from extensions which (strangely enough) define several parameters with the same name. The string-based constructor always returns the first parameter with the matching name, whereas the integer-based constructor correctly returns the n-th parameter.
So, in short, this works:
<?php
// supposing the extension defined something like:
// Some_Class::someMethod($a, $x, $y, $x, $y)
$p = new ReflectionParameter(array('Some_Class', 'someMethod'), 4);
// returns the last parameter, whereas
$p = new ReflectionParameter(array('Some_Class', 'someMethod'), 'y');
// always returns the first $y at position 2
?>

down

killgecNOFSPAM at gmail dot com ¶

19 years ago

Signature of constructor of ReflectionParameter correctly is:
public function __construct(array/string $function, string $name);
where $function is either a name of a global function, or a class/method name pair.

down

massimo at mmware dot it ¶

19 years ago

I found these limitations using class ReflectionParameter from ReflectionFunction with INTERNAL FUNCTIONS (eg print_r, str_replace, ... ) :
1. parameter names don't match with manual: (try example 19.35 with arg "call_user_func" )
2. some functions (eg PCRE function, preg_match etc) have EMPTY parameter names 
3. calling getDefaultValue on Parameters will result in Exception "Cannot determine default value for internal functions"

down

rasmus at mindplay dot dk ¶

2 years ago

There are so many parameter modes now, and I needed to know exactly what `ReflectionParameter` is going to return, so I wrote a little test-script - you can find the script and results in a table here:
https://gist.github.com/mindplay-dk/082458088988e32256a827f9b7491e17

+add a note