SignatureHelp
in package
implements
JsonSerializable
Signature help represents the signature of something callable. There can be multiple signature but only one active and only one active parameter.
Table of Contents
Interfaces
- JsonSerializable
Properties
- $activeParameter : int|null
- The active parameter of the active signature. If omitted or the value lies outside the range of `signatures[activeSignature].parameters` defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored.
- $activeSignature : int|null
- The active signature. If omitted or the value lies outside the range of `signatures` the value defaults to zero or is ignore if the `SignatureHelp` as no signatures.
- $signatures : array<string|int, SignatureInformation>|null
- One or more signatures. If no signatures are available the signature help request should return `null`.
Methods
- __construct() : mixed
- Create a SignatureHelp
- 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 active parameter of the active signature. If omitted or the value lies outside the range of `signatures[activeSignature].parameters` defaults to 0 if the active signature has parameters. If the active signature has no parameters it is ignored.
public
int|null
$activeParameter
In future version of the protocol this property might become mandatory to better express the active parameter if the active signature does have any.
$activeSignature
The active signature. If omitted or the value lies outside the range of `signatures` the value defaults to zero or is ignore if the `SignatureHelp` as no signatures.
public
int|null
$activeSignature
Whenever possible implementors should make an active decision about the active signature and shouldn't rely on a default value.
In future version of the protocol this property might become mandatory to better express this.
$signatures
One or more signatures. If no signatures are available the signature help request should return `null`.
public
array<string|int, SignatureInformation>|null
$signatures
Methods
__construct()
Create a SignatureHelp
public
__construct([array<string|int, SignatureInformation>|null $signatures = null ][, int|null $activeSignature = null ][, int|null $activeParameter = null ]) : mixed
Parameters
- $signatures : array<string|int, SignatureInformation>|null = null
-
List of signature information
- $activeSignature : int|null = null
-
The active signature, zero based
- $activeParameter : int|null = null
-
The active parameter, zero based
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]