Documentation

DocblockTypeLocation extends CodeLocation
in package

FinalYes
Tags
psalm-immutable

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

FUNCTION_PARAM_TYPE

public mixed FUNCTION_PARAM_TYPE = 2

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

Properties

$docblock_line_number

protected int|null $docblock_line_number = null

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

getEndColumn()

public getEndColumn() : int
Return values
int

getEndLineNumber()

public getEndLineNumber() : int
Return values
int

getHash()

public getHash() : string
Return values
string

getLineNumber()

public getLineNumber() : int
Return values
int

getSelectedText()

public getSelectedText() : string
Return values
string

getSelectionBounds()

public getSelectionBounds() : array{0: int, 1: int}
Return values
array{0: int, 1: int}

getShortSummary()

public getShortSummary() : string
Return values
string

getSnippet()

public getSnippet() : string
Return values
string

getSnippetBounds()

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
psalm-suppress

PossiblyUnusedMethod Part of public API

Return values
static

        
On this page

Search results