PHP Class Phan\Language\FileRef

Inheritance: implements Serializable
Show file Open project: etsy/phan Class Usage Examples

Protected Properties

Property Type Description
$file string The path to the file in which this element is defined
$line_number_end integer The ending line number of the element within the $file
$line_number_start integer The starting line number of the element within the $file

Public Methods

Method Description
__toString ( ) : string Get a string representation of the context
getFile ( ) : string
getLineNumberStart ( ) : integer *
getProjectRelativePath ( ) : string
isInternal ( ) : boolean
serialize ( )
unserialize ( $serialized )
withFile ( string $file ) : static
withLineNumberEnd ( integer $line_number ) : static
withLineNumberStart ( integer $line_number ) : static

Method Details

__toString() public method

Get a string representation of the context
public __toString ( ) : string
return string

getFile() public method

public getFile ( ) : string
return string The path to the file in which the element is defined

getLineNumberStart() public method

*
public getLineNumberStart ( ) : integer
return integer The starting line number of the element within the file

getProjectRelativePath() public method

public getProjectRelativePath ( ) : string
return string The path of the file relative to the project root directory

isInternal() public method

public isInternal ( ) : boolean
return boolean True if this object is internal to PHP

serialize() public method

public serialize ( )

unserialize() public method

public unserialize ( $serialized )

withFile() public method

public withFile ( string $file ) : static
$file string The path to the file in which this element is defined
return static This context with the given value is returned

withLineNumberEnd() public method

public withLineNumberEnd ( integer $line_number ) : static
$line_number integer The ending line number of the element within the $file
return static This context with the given value is returned

withLineNumberStart() public method

public withLineNumberStart ( integer $line_number ) : static
$line_number integer
return static This context with the given value is returned

Property Details

$file protected property

The path to the file in which this element is defined
protected string $file
return string

$line_number_end protected property

The ending line number of the element within the $file
protected int $line_number_end
return integer

$line_number_start protected property

The starting line number of the element within the $file
protected int $line_number_start
return integer