PHP Trait Phan\Language\Element\FunctionTrait

Show file Open project: etsy/phan

Public Methods

Method Description
appendParameter ( Parameter $parameter ) : void
getHasReturn ( ) : boolean
getHasYield ( ) : boolean
getNumberOfOptionalParameters ( ) : integer
getNumberOfParameters ( ) : integer
getNumberOfRequiredParameters ( ) : integer
getParameterForCaller ( integer $i ) : Parameter | null Gets the $ith parameter for the **caller**.
getParameterList ( ) : Parameter[]
getPhanFlags ( ) : integer
isReturnTypeUndefined ( ) : boolean
setHasReturn ( boolean $has_return ) : void
setHasYield ( boolean $has_yield ) : void
setIsReturnTypeUndefined ( boolean $is_return_type_undefined ) : void
setNumberOfOptionalParameters ( integer $number ) : void The number of optional parameters
setNumberOfRequiredParameters ( integer $number ) : void The number of required parameters
setParameterList ( array $parameter_list ) : void
setPhanFlags ( integer $phan_flags ) : void

Method Details

appendParameter() public method

public appendParameter ( Parameter $parameter ) : void
$parameter Parameter A parameter to append to the parameter list
return void

getHasReturn() public method

public getHasReturn ( ) : boolean
return boolean True if this method returns a value (i.e. it has a return with an expression)

getHasYield() public method

public getHasYield ( ) : boolean
return boolean True if this method yields any value(i.e. it is a \Generator)

getNumberOfOptionalParameters() public method

public getNumberOfOptionalParameters ( ) : integer
return integer The number of optional parameters on this method

getNumberOfParameters() public method

public getNumberOfParameters ( ) : integer
return integer The maximum number of parameters to this method

getNumberOfRequiredParameters() public method

public getNumberOfRequiredParameters ( ) : integer
return integer The number of required parameters on this method

getParameterForCaller() public method

In the case of variadic arguments, an infinite number of parameters exist. (The callee would see variadic arguments(T ...$args) as a single variable of type T[], while the caller sees a place expecting an expression of type T.
public getParameterForCaller ( integer $i ) : Parameter | null
$i integer - offset of the parameter.
return Parameter | null The parameter type that the **caller** observes.

getParameterList() public method

public getParameterList ( ) : Parameter[]
return Parameter[] A list of parameters on the method

getPhanFlags() abstract public method

abstract public getPhanFlags ( ) : integer
return integer

isReturnTypeUndefined() public method

public isReturnTypeUndefined ( ) : boolean
return boolean True if this method had no return type defined when it was defined (either in the signature itself or in the docblock).

setHasReturn() public method

public setHasReturn ( boolean $has_return ) : void
$has_return boolean Set to true to mark this method as having a return value
return void

setHasYield() public method

public setHasYield ( boolean $has_yield ) : void
$has_yield boolean Set to true to mark this method as having a yield value
return void

setIsReturnTypeUndefined() public method

public setIsReturnTypeUndefined ( boolean $is_return_type_undefined ) : void
$is_return_type_undefined boolean True if this method had no return type defined when it was defined (either in the signature itself or in the docblock).
return void

setNumberOfOptionalParameters() public method

The number of optional parameters
public setNumberOfOptionalParameters ( integer $number ) : void
$number integer
return void

setNumberOfRequiredParameters() public method

The number of required parameters
public setNumberOfRequiredParameters ( integer $number ) : void
$number integer
return void

setParameterList() public method

public setParameterList ( array $parameter_list ) : void
$parameter_list array A list of parameters to set on this method
return void

setPhanFlags() abstract public method

abstract public setPhanFlags ( integer $phan_flags ) : void
$phan_flags integer
return void