ReflectionFunctionAbstract::getNumberOfRequiredParameters

(PHP 5 >= 5.0.3)

ReflectionFunctionAbstract::getNumberOfRequiredParametersGets number of required parameters

Description

public int ReflectionFunctionAbstract::getNumberOfRequiredParameters ( void )

Get the number of required parameters that a function defines.

Warning

This function is currently not documented; only its argument list is available.

Parameters

This function has no parameters.

Return Values

The number of required parameters.

See Also

add a note add a note

User Contributed Notes 2 notes

up
2
sebastian at sebastian-eiweleit dot de
1 year ago
<?php
namespace ExampleWorld;
// The Class
class helloWorld {
   
/* Method with two required arguments */

   
public function requiredTwoArguments ( $var1, $var2 ) {
       
// Some code ...
   
}

   
/* Method with two arguments, but just one is required */
   
public function requiredOneArgument ( $var1, $var2 = false ) {
       
// Some code ...
   
}
}

$r = new \ReflectionMethod ( 'ExampleWorld\helloWorld', 'requiredTwoArguments' );
echo
$r->getNumberOfRequiredParameters ();

$r = new \ReflectionMethod ( 'ExampleWorld\helloWorld', 'requiredOneArgument' );
echo
$r->getNumberOfRequiredParameters ();

// Output: 2 1
up
1
cesar at magic3w dot com
28 days ago
It's interesting to note that this function will treat optional parameters that come before a required parameter as required too. This is good since it allows you to verify that the function will be receiving enough parameters for the it to work, regardless where they are located.

<?php

class MyTest() {
    public function
test($a = null, $b) {}
    public function
test2($a = null, $b, $c = null) {}
}

//Create the reflection
$r  = new \ReflectionMethod('MyTest', 'test');
$r2 = new \ReflectionMethod('MyTest', 'test2');

//Verify the numbers
echo 'Test: ' . $r->getNumberOfRequiredParameters()); //Output: 2
echo 'Test2: ' . $r->getNumberOfRequiredParameters()); //Output: 2

?>
To Top