DocblockTypeLocation
extends CodeLocation
in package
FinalYes
Tags
Table of Contents
Constants
- CATCH_VAR = 6
- FUNCTION_PARAM_TYPE = 2
- FUNCTION_PARAM_VAR = 5
- FUNCTION_PHPDOC_METHOD = 7
- FUNCTION_PHPDOC_PARAM_TYPE = 4
- FUNCTION_PHPDOC_RETURN_TYPE = 3
- FUNCTION_RETURN_TYPE = 1
- VAR_TYPE = 0
Properties
- $docblock_start : int|null
- $file_name : string
- $file_path : string
- $previous_location : CodeLocation|null
- $raw_file_end : int
- $raw_file_start : int
- $raw_line_number : int
- $docblock_line_number : int|null
- $file_end : int
- $file_start : int
- $preview_start : int
- $single_line : bool
Methods
- __construct() : mixed
- __unserialize() : void
- Suppresses memory usage when unserializing objects.
- getColumn() : int
- getEndColumn() : int
- getEndLineNumber() : int
- getHash() : string
- getLineNumber() : int
- getSelectedText() : string
- getSelectionBounds() : array{0: int, 1: int}
- getShortSummary() : string
- getSnippet() : string
- getSnippetBounds() : array{0: int, 1: int}
- setCommentLine() : static
- __clone() : mixed
Constants
CATCH_VAR
public
mixed
CATCH_VAR
= 6
FUNCTION_PARAM_TYPE
public
mixed
FUNCTION_PARAM_TYPE
= 2
FUNCTION_PARAM_VAR
public
mixed
FUNCTION_PARAM_VAR
= 5
FUNCTION_PHPDOC_METHOD
public
mixed
FUNCTION_PHPDOC_METHOD
= 7
FUNCTION_PHPDOC_PARAM_TYPE
public
mixed
FUNCTION_PHPDOC_PARAM_TYPE
= 4
FUNCTION_PHPDOC_RETURN_TYPE
public
mixed
FUNCTION_PHPDOC_RETURN_TYPE
= 3
FUNCTION_RETURN_TYPE
public
mixed
FUNCTION_RETURN_TYPE
= 1
VAR_TYPE
public
mixed
VAR_TYPE
= 0
Properties
$docblock_start
public
int|null
$docblock_start
= null
$file_name
public
string
$file_name
$file_path
public
string
$file_path
$previous_location
public
CodeLocation|null
$previous_location
= null
$raw_file_end
public
int
$raw_file_end
$raw_file_start
public
int
$raw_file_start
$raw_line_number
public
int
$raw_line_number
$docblock_line_number
protected
int|null
$docblock_line_number
= null
$file_end
protected
int
$file_end
$file_start
protected
int
$file_start
$preview_start
protected
int
$preview_start
$single_line
protected
bool
$single_line
Methods
__construct()
public
__construct(FileSource $file_source, int $file_start, int $file_end, int $line_number) : mixed
Parameters
- $file_source : FileSource
- $file_start : int
- $file_end : int
- $line_number : int
__unserialize()
Suppresses memory usage when unserializing objects.
public
__unserialize(array<string|int, mixed> $properties) : void
Parameters
- $properties : array<string|int, mixed>
Tags
getColumn()
public
getColumn() : int
Return values
intgetEndColumn()
public
getEndColumn() : int
Return values
intgetEndLineNumber()
public
getEndLineNumber() : int
Return values
intgetHash()
public
getHash() : string
Return values
stringgetLineNumber()
public
getLineNumber() : int
Return values
intgetSelectedText()
public
getSelectedText() : string
Return values
stringgetSelectionBounds()
public
getSelectionBounds() : array{0: int, 1: int}
Return values
array{0: int, 1: int}getShortSummary()
public
getShortSummary() : string
Return values
stringgetSnippet()
public
getSnippet() : string
Return values
stringgetSnippetBounds()
public
getSnippetBounds() : array{0: int, 1: int}
Return values
array{0: int, 1: int}setCommentLine()
public
setCommentLine(int|null $line) : static
Parameters
- $line : int|null
Tags
Return values
static__clone()
private
__clone() : mixed