ReflectionParameter::getDefaultValueConstantName

(PHP 5 >= 5.4.6, PHP 7)

ReflectionParameter::getDefaultValueConstantNameReturns the default value's constant name if default value is constant or null

Description

public string ReflectionParameter::getDefaultValueConstantName ( void )

Returns the default value's constant name of the parameter of a user-defined function or method, if default value is constant or null. If the parameter is not optional a ReflectionException will be thrown.

Parameters

This function has no parameters.

Return Values

Returns string on success or NULL on failure.

Examples

Example #1 Getting default values' constant names of function parameters

<?php
function foo($test$bar PHP_INT_MIN)
{
    echo 
$test $bar;
}

$function = new ReflectionFunction('foo');

foreach (
$function->getParameters() as $param) {
    echo 
'Name: ' $param->getName() . PHP_EOL;
    if (
$param->isOptional()) {
        echo 
'Default value: ' $param->getDefaultValueConstantName() . PHP_EOL;
    }
    echo 
PHP_EOL;
}
?>

The above example will output:

Name: test

Name: bar
Default value: PHP_INT_MIN

Notes

Note:

Due to implementation details, it is not possible to get the default value of built-in functions or methods of built-in classes. Trying to do this will result a ReflectionException being thrown.

See Also

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top