PHP Интерфейс Phan\Language\Element\FunctionInterface

Наследование: extends Phan\Language\Element\AddressableElementInterface
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
alternateGenerator ( CodeBase $code_base ) : Generator
analyze ( Context $context, CodeBase $code_base ) : Context
appendParameter ( Parameter $parameter ) : void
getFQSEN ( ) : FullyQualifiedMethodName | FullyQualifiedFunctionName
getHasReturn ( ) : boolean
getInternalScope ( ) : Phan\Language\Scope\ClosedScope
getNumberOfOptionalParameters ( ) : integer
getNumberOfParameters ( ) : integer
getNumberOfRequiredParameters ( ) : integer
getParameterForCaller ( integer $i ) : Parameter | null Gets the $ith parameter for the **caller**.
getParameterList ( ) : Parameter[]
isReturnTypeUndefined ( ) : boolean
setHasReturn ( boolean $has_return ) : void
setHasYield ( boolean $has_return ) : void
setInternalScope ( Phan\Language\Scope\ClosedScope $internal_scope ) : 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

Описание методов

alternateGenerator() публичный Метод

public alternateGenerator ( CodeBase $code_base ) : Generator
$code_base Phan\CodeBase
Результат Generator The set of all alternates to this function

analyze() публичный Метод

public analyze ( Context $context, CodeBase $code_base ) : Context
$context Phan\Language\Context
$code_base Phan\CodeBase
Результат Phan\Language\Context Analyze the node associated with this object in the given context

appendParameter() публичный Метод

public appendParameter ( Parameter $parameter ) : void
$parameter Parameter A parameter to append to the parameter list
Результат void

getFQSEN() публичный Метод

public getFQSEN ( ) : FullyQualifiedMethodName | FullyQualifiedFunctionName
Результат Phan\Language\FQSEN\FullyQualifiedMethodName | Phan\Language\FQSEN\FullyQualifiedFunctionName The fully-qualified structural element name of this structural element

getHasReturn() публичный Метод

public getHasReturn ( ) : boolean
Результат boolean True if this method returns a value

getInternalScope() публичный Метод

public getInternalScope ( ) : Phan\Language\Scope\ClosedScope
Результат Phan\Language\Scope\ClosedScope The internal scope of this closed scope element

getNumberOfOptionalParameters() публичный Метод

public getNumberOfOptionalParameters ( ) : integer
Результат integer The number of optional parameters on this method

getNumberOfParameters() публичный Метод

public getNumberOfParameters ( ) : integer
Результат integer The maximum number of parameters to this method

getNumberOfRequiredParameters() публичный Метод

public getNumberOfRequiredParameters ( ) : integer
Результат integer The number of required parameters on this method

getParameterForCaller() публичный Метод

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.
Результат Parameter | null The parameter type that the **caller** observes.

getParameterList() публичный Метод

public getParameterList ( ) : Parameter[]
Результат Parameter[] A list of parameters on the method

isReturnTypeUndefined() публичный Метод

public isReturnTypeUndefined ( ) : boolean
Результат 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 setHasReturn ( boolean $has_return ) : void
$has_return boolean Set to true to mark this method as having a return value (Only through `return`)
Результат void

setHasYield() публичный Метод

public setHasYield ( boolean $has_return ) : void
$has_return boolean
Результат void

setInternalScope() публичный Метод

public setInternalScope ( Phan\Language\Scope\ClosedScope $internal_scope ) : void
$internal_scope Phan\Language\Scope\ClosedScope
Результат void

setIsReturnTypeUndefined() публичный Метод

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).
Результат void

setNumberOfOptionalParameters() публичный Метод

The number of optional parameters
public setNumberOfOptionalParameters ( integer $number ) : void
$number integer
Результат void

setNumberOfRequiredParameters() публичный Метод

The number of required parameters
public setNumberOfRequiredParameters ( integer $number ) : void
$number integer
Результат void

setParameterList() публичный Метод

public setParameterList ( array $parameter_list ) : void
$parameter_list array A list of parameters to set on this method
Результат void