The ReflectionParameter class

Einführung

The ReflectionParameter class retrieves information about a function's or method's parameters.

To introspect function parameters, first create an instance of the ReflectionFunction or ReflectionMethod classes and then use their ReflectionFunctionAbstract::getParameters() method to retrieve an array of parameters.

Klassenbeschreibung

ReflectionParameter implements Reflector {

/* Eigenschaften */

public $name ;

/* Methoden */

public bool allowsNull ( void )

final private void __clone ( void )

__construct ( string $function , string $parameter )

public static string export ( string $function , string $parameter [, bool $return ] )

public ReflectionClass getClass ( void )

public ReflectionClass getDeclaringClass ( void )

public ReflectionFunction getDeclaringFunction ( void )

public mixed getDefaultValue ( void )

public string getName ( void )

public int getPosition ( void )

public bool isArray ( void )

public bool isDefaultValueAvailable ( void )

public bool isOptional ( void )

public bool isPassedByReference ( void )

public string __toString ( void )

}

Eigenschaften

name: Prop description

Inhaltsverzeichnis

ReflectionParameter::allowsNull — Checks if null is allowed
ReflectionParameter::__clone — Clone
ReflectionParameter::__construct — Construct
ReflectionParameter::export — Exports
ReflectionParameter::getClass — Get class
ReflectionParameter::getDeclaringClass — Gets declaring class
ReflectionParameter::getDeclaringFunction — Gets declaring function
ReflectionParameter::getDefaultValue — Gets default parameter value
ReflectionParameter::getName — Gets parameter name
ReflectionParameter::getPosition — Gets parameter position
ReflectionParameter::isArray — Checks if parameter expects an array
ReflectionParameter::isDefaultValueAvailable — Checks if a default value is available
ReflectionParameter::isOptional — Checks if optional
ReflectionParameter::isPassedByReference — Checks if passed by reference
ReflectionParameter::__toString — To string

3 BenutzerBeiträge:
- Beiträge aktualisieren...

fgm at riff dot org
11.05.2008 21:44


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


?>

killgecNOFSPAM at gmail dot com
25.07.2007 14:53


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.

massimo at mmware dot it
18.07.2007 17:58


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"

Ein Service von Reinhard Neidl - Webprogrammierung.

The ReflectionParameter class

Einführung

Klassenbeschreibung

Eigenschaften

Inhaltsverzeichnis