PHP Class Phan\Language\Element\TypedElement

..
Inheritance: implements Phan\Language\Element\TypedElementInterface, use trait Phan\Memoize
Show file Open project: etsy/phan Class Usage Examples

Public Methods

Method Description
__clone ( ) : null After a clone is called on this object, clone our type and fqsen so that they survive copies intact
__construct ( Context $context, string $name, UnionType $type, integer $flags )
getContext ( ) : Context
getFileRef ( ) : FileRef
getFlags ( ) : integer
getName ( ) : string
getPhanFlags ( ) : integer
getSuppressIssueList ( ) : array
getUnionType ( ) : UnionType
getVariadicElementUnionType ( ) : UnionType Variables can't be variadic. This is the same as getUnionType for variables, but not necessarily for subclasses. Method will return the element type (such as DateTime) for variadic parameters.
hasSuppressIssue ( string $issue_name ) : boolean return bool True if this element would like to suppress the given issue name
hydrate ( CodeBase $code_base ) : void This method must be called before analysis begins.
isDeprecated ( ) : boolean
isInternal ( ) : boolean
setFlags ( integer $flags ) : void
setIsDeprecated ( boolean $is_deprecated ) : void
setPhanFlags ( integer $phan_flags ) : void
setSuppressIssueList ( array $suppress_issue_list ) : void
setUnionType ( UnionType $type ) : void

Protected Methods

Method Description
hydrateOnce ( CodeBase $code_base ) : void This method must be called before analysis begins.

Private Methods

Method Description
setIsInternal ( boolean $is_internal ) : void

Method Details

__clone() public method

After a clone is called on this object, clone our type and fqsen so that they survive copies intact
public __clone ( ) : null
return null

__construct() public method

public __construct ( Context $context, string $name, UnionType $type, integer $flags )
$context Phan\Language\Context The context in which the structural element lives
$name string
$type Phan\Language\UnionType
$flags integer

getContext() public method

public getContext ( ) : Context
return Phan\Language\Context The context in which this structural element exists

getFileRef() public method

public getFileRef ( ) : FileRef
return Phan\Language\FileRef A reference to where this element was found

getFlags() public method

public getFlags ( ) : integer
return integer

getName() public method

public getName ( ) : string
return string The (not fully-qualified) name of this element.

getPhanFlags() public method

public getPhanFlags ( ) : integer
return integer

getSuppressIssueList() public method

public getSuppressIssueList ( ) : array
return array

getUnionType() public method

public getUnionType ( ) : UnionType
return Phan\Language\UnionType Get the type of this structural element

getVariadicElementUnionType() public method

Variables can't be variadic. This is the same as getUnionType for variables, but not necessarily for subclasses. Method will return the element type (such as DateTime) for variadic parameters.
public getVariadicElementUnionType ( ) : UnionType
return Phan\Language\UnionType

hasSuppressIssue() public method

return bool True if this element would like to suppress the given issue name
public hasSuppressIssue ( string $issue_name ) : boolean
$issue_name string
return boolean

hydrate() final public method

This method must be called before analysis begins.
final public hydrate ( CodeBase $code_base ) : void
$code_base Phan\CodeBase
return void

hydrateOnce() protected method

This method must be called before analysis begins.
protected hydrateOnce ( CodeBase $code_base ) : void
$code_base Phan\CodeBase
return void

isDeprecated() public method

public isDeprecated ( ) : boolean
return boolean True if this element is marked as deprecated

isInternal() public method

public isInternal ( ) : boolean
return boolean True if this was an internal PHP object

setFlags() public method

public setFlags ( integer $flags ) : void
$flags integer
return void

setIsDeprecated() public method

public setIsDeprecated ( boolean $is_deprecated ) : void
$is_deprecated boolean Set this element as deprecated
return void

setPhanFlags() public method

public setPhanFlags ( integer $phan_flags ) : void
$phan_flags integer
return void

setSuppressIssueList() public method

public setSuppressIssueList ( array $suppress_issue_list ) : void
$suppress_issue_list array Set the set of issue names to suppress
return void

setUnionType() public method

public setUnionType ( UnionType $type ) : void
$type Phan\Language\UnionType Set the type of this element
return void