The ReflectionParameter class

Introduction

The ReflectionParameter class retrieves information about 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.

Class synopsis

ReflectionParameter

implements Reflector

/* Properties */

public string $name;

/* Methods */

public __construct(stringarrayobject $function, intstring $param)

public bool allowsNull()

public bool canBePassedByValue()

private void __clone()

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

public array getAttributes(stringnull $name = null, int $flags = 0)

public ReflectionClassnull getClass()

public ReflectionClassnull getDeclaringClass()

public ReflectionFunctionAbstract getDeclaringFunction()

public mixed getDefaultValue()

public stringnull getDefaultValueConstantName()

public string getName()

public int getPosition()

public ReflectionTypenull getType()

public bool hasType()

public bool isArray()

public bool isCallable()

public bool isDefaultValueAvailable()

public bool isDefaultValueConstant()

public bool isOptional()

public bool isPassedByReference()

public bool isVariadic()

public string __toString()

Properties

name: Name of the parameter. Read-only, throws ReflectionException in attempt to write.

Changelog

Version	Description
8.0.0	ReflectionParameter::export was removed.

Table of Contents

ReflectionParameter::allowsNull — Checks if null is allowed
ReflectionParameter::canBePassedByValue — Returns whether this parameter can be passed by value
ReflectionParameter::__clone — Clone
ReflectionParameter::__construct — Construct
ReflectionParameter::export — Exports
ReflectionParameter::getAttributes — Gets Attributes
ReflectionParameter::getClass — Get a ReflectionClass object for the parameter being reflected or null
ReflectionParameter::getDeclaringClass — Gets declaring class
ReflectionParameter::getDeclaringFunction — Gets declaring function
ReflectionParameter::getDefaultValue — Gets default parameter value
ReflectionParameter::getDefaultValueConstantName — Returns the default value's constant name if default value is constant or null
ReflectionParameter::getName — Gets parameter name
ReflectionParameter::getPosition — Gets parameter position
ReflectionParameter::getType — Gets a parameter's type
ReflectionParameter::hasType — Checks if parameter has a type
ReflectionParameter::isArray — Checks if parameter expects an array
ReflectionParameter::isCallable — Returns whether parameter MUST be callable
ReflectionParameter::isDefaultValueAvailable — Checks if a default value is available
ReflectionParameter::isDefaultValueConstant — Returns whether the default value of this parameter is a constant
ReflectionParameter::isOptional — Checks if optional
ReflectionParameter::isPassedByReference — Checks if passed by reference
ReflectionParameter::isVariadic — Checks if the parameter is variadic
ReflectionParameter::__toString — To string