Class ParamTag

Summary

Fully Qualified Name: Zend\Code\Generator\DocBlock\Tag\ParamTag
Extends: AbstractTypeableTag
Implements: TagInterface

Description

Methods

Name Description Defined By
__construct() ParamTag
fromReflection() ParamTag
generate() ParamTag
getDatatype() ParamTag
getDescription() AbstractTypeableTag
getIndentation() AbstractGenerator
getName() ParamTag
getParamName() ParamTag
getSourceContent() AbstractGenerator
getTypes() AbstractTypeableTag
getTypesAsString() AbstractTypeableTag
getVariableName() ParamTag
isSourceDirty() AbstractGenerator
setDatatype() ParamTag
setDescription() AbstractTypeableTag
setIndentation() AbstractGenerator
setOptions() AbstractGenerator
setParamName() ParamTag
setSourceContent() AbstractGenerator
setSourceDirty() AbstractGenerator
setTypes() Array of types or string with types delimited by pipe (|) e.g. array('int', 'null') or "int|null" AbstractTypeableTag
setVariableName() ParamTag

Method Details

__construct()

Parameter Name Type Description
$variableName string
$types array
$description string

Returns:

fromReflection()

Parameter Name Type Description
$reflectionTag \ReflectionTagInterface

Returns: \ReturnTag

generate()

Returns: string

getDatatype()

Returns: string

getDescription()

Returns: string

getIndentation()

Returns: string

getName()

Returns: string

getParamName()

Returns: string

getSourceContent()

Returns: string

getTypes()

Returns: array

getTypesAsString()

Parameter Name Type Description
$delimiter string

Returns: string

getVariableName()

Returns: string

isSourceDirty()

Returns: bool

setDatatype()

Parameter Name Type Description
$datatype string

Returns: \ReturnTag

setDescription()

Parameter Name Type Description
$description string

Returns: \ReturnTag

setIndentation()

Parameter Name Type Description
$indentation string

Returns: \AbstractGenerator

setOptions()

Parameter Name Type Description
$options array|\Traversable

Returns: \AbstractGenerator

setParamName()

Parameter Name Type Description
$paramName string

Returns: \ParamTag

setSourceContent()

Parameter Name Type Description
$sourceContent string

Returns: \AbstractGenerator

setSourceDirty()

Parameter Name Type Description
$isSourceDirty bool

Returns: \AbstractGenerator

setTypes()

Array of types or string with types delimited by pipe (|) e.g. array('int', 'null') or "int|null"

Parameter Name Type Description
$types array|string

Returns: \ReturnTag

setVariableName()

Parameter Name Type Description
$variableName string

Returns: \ParamTag

Top