phpDocumentor

IsInFile

Table of Contents

Properties

$endLocation  : Location|null
$fileDescriptor  : FileInterface|null
$line  : int
$startLocation  : Location|null

Methods

getEndLocation()  : Location|null
Returns the end location where the definition for this element can be found.
getFile()  : FileInterface|null
Returns the file in which this element resides or null in case the element is not bound to a file.
getLine()  : int
Returns the line number where the definition for this element can be found.
getPath()  : string
Returns the path to the file containing this element relative to the project's root.
getStartLocation()  : Location|null
Returns the start location where the definition for this element can be found.

Properties

$endLocation

protected Location|null $endLocation = null

$fileDescriptor

protected FileInterface|null $fileDescriptor = null

The file to which this element belongs; if applicable

$line

protected int $line = 0

The line number on which this element occurs.

$startLocation

protected Location|null $startLocation = null

Methods

getEndLocation()

Returns the end location where the definition for this element can be found.

public getEndLocation() : Location|null
Return values
Location|null

getFile()

Returns the file in which this element resides or null in case the element is not bound to a file.

public getFile() : FileInterface|null

.

Return values
FileInterface|null

getLine()

Returns the line number where the definition for this element can be found.

public getLine() : int

use getStartLocation()->getLineNumber() instead

Return values
int

getPath()

Returns the path to the file containing this element relative to the project's root.

public getPath() : string
Return values
string

getStartLocation()

Returns the start location where the definition for this element can be found.

public getStartLocation() : Location|null
Return values
Location|null

        
On this page

Search results