SignatureInformation
in package
implements
JsonSerializable
Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $activeParameter : int|null
- The index of the active parameter.
- $documentation : MarkupContent|string|null
- The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
- $label : string
- The label of this signature. Will be shown in the UI.
- $parameters : array<string|int, ParameterInformation>|null
- The parameters of this signature.
Methods
- __construct() : mixed
- Create a SignatureInformation
- jsonSerialize() : mixed
- This is needed because VSCode Does not like nulls meaning if a null is sent then this will not compute
Properties
$activeParameter
The index of the active parameter.
public
int|null
$activeParameter
If provided, this is used in place of SignatureHelp.activeParameter.
Tags
$documentation
The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
public
MarkupContent|string|null
$documentation
$label
The label of this signature. Will be shown in the UI.
public
string
$label
$parameters
The parameters of this signature.
public
array<string|int, ParameterInformation>|null
$parameters
Methods
__construct()
Create a SignatureInformation
public
__construct(string $label[, array<string|int, ParameterInformation>|null $parameters = null ][, MarkupContent|string|null $documentation = null ][, int|null $activeParameter = null ]) : mixed
Parameters
- $label : string
-
The label of this signature. Will be shown in the UI.
- $parameters : array<string|int, ParameterInformation>|null = null
-
The parameters of this signature
- $documentation : MarkupContent|string|null = null
-
The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
- $activeParameter : int|null = null
-
The index of the active parameter.
jsonSerialize()
This is needed because VSCode Does not like nulls meaning if a null is sent then this will not compute
public
jsonSerialize() : mixed
Attributes
- #[ReturnTypeWillChange]