PHP Class PhpCsFixer\DocBlock\Annotation

Author: Graham Campbell ([email protected])
Show file Open project: friendsofphp/php-cs-fixer Class Usage Examples

Public Methods

Method Description
__construct ( array $lines ) Create a new line instance.
__toString ( ) : string Get the string representation of object.
getContent ( ) : string Get the annotation content.
getEnd ( ) : integer Get the end position of this annotation.
getStart ( ) : integer Get the start position of this annotation.
getTag ( ) : Tag Get the associated tag.
getTagsWithTypes ( ) : string[] Get all the annotation tag names with types.
getTypes ( ) : string[] Get the types associated with this annotation.
remove ( ) Remove this annotation by removing all its lines.
setTypes ( array $types ) Set the types associated with this annotation.
supportTypes ( )

Private Methods

Method Description
getTypesContent ( ) : string Get the current types content.

Method Details

__construct() public method

Create a new line instance.
public __construct ( array $lines )
$lines array

__toString() public method

Get the string representation of object.
public __toString ( ) : string
return string

getContent() public method

Get the annotation content.
public getContent ( ) : string
return string

getEnd() public method

Get the end position of this annotation.
public getEnd ( ) : integer
return integer

getStart() public method

Get the start position of this annotation.
public getStart ( ) : integer
return integer

getTag() public method

Get the associated tag.
public getTag ( ) : Tag
return Tag

getTagsWithTypes() public static method

Get all the annotation tag names with types.
public static getTagsWithTypes ( ) : string[]
return string[]

getTypes() public method

Get the types associated with this annotation.
public getTypes ( ) : string[]
return string[]

remove() public method

Remove this annotation by removing all its lines.
public remove ( )

setTypes() public method

Set the types associated with this annotation.
public setTypes ( array $types )
$types array

supportTypes() public method

public supportTypes ( )