Reflection Docblock

Template extends BaseTag
in package

FinalYes

Reflection class for a {@}template tag in a Docblock.

Table of Contents

Properties

$description  : Description|null
$name  : string
$bound  : Type|null
$default  : Type|null
$templateName  : non-empty-string

Methods

__construct()  : mixed
__toString()  : string
create()  : Tag|mixed
getBound()  : Type|null
getDefault()  : Type|null
getDescription()  : Description|null
getName()  : string
Gets the name of this tag.
getTemplateName()  : string
render()  : string

Properties

$name

protected string $name = ''

Name of the tag

$bound

private Type|null $bound

The real type

$templateName

private non-empty-string $templateName

Methods

__construct()

public __construct(non-empty-string $templateName[, Type|null $bound = null ][, Type|null $default = null ][, Description|null $description = null ]) : mixed
Parameters
$templateName : non-empty-string
$bound : Type|null = null
$default : Type|null = null
$description : Description|null = null

__toString()

public __toString() : string
Return values
string

create()

public static create(string $body) : Tag|mixed

Create using static factory is deprecated, this method should not be called directly by library consumers

Parameters
$body : string
Return values
Tag|mixed —

Class that implements Tag

getBound()

public getBound() : Type|null
Return values
Type|null

getDefault()

public getDefault() : Type|null
Return values
Type|null

getName()

Gets the name of this tag.

public getName() : string
Return values
string —

The name of this tag.

getTemplateName()

public getTemplateName() : string
Return values
string

render()

public render([Formatter|null $formatter = null ]) : string
Parameters
$formatter : Formatter|null = null
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results