Zend Framework » \Zend\Code\Generator\DocBlock\Tag\ParamTag

This abstract class can be used as parent for all tags that use a type part in their content.

Methods

__construct()

__construct(string $variableName, array $types, string $description)

Parameters

$variableName

string

$types

array

$description

string

fromReflection()

fromReflection(\Zend\Code\Reflection\DocBlock\Tag\TagInterface $reflectionTag) : \Zend\Code\Generator\DocBlock\Tag\ReturnTag

deprecated	Deprecated in 2.3. Use TagManager::createTagFromReflection() instead

Parameters

$reflectionTag

\Zend\Code\Reflection\DocBlock\Tag\TagInterface

Returns

\Zend\Code\Generator\DocBlock\Tag\ReturnTag

generate()

generate() : string

Returns

string

getDatatype()

getDatatype() : string

deprecated	Deprecated in 2.3. Use getTypes() or getTypesAsString() instead

Returns

string

getDescription()

getDescription() : string

Inherited

inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::getDescription()

Returns

string

getIndentation()

getIndentation() : string

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::getIndentation()
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::getIndentation()

Returns

string

getName()

getName() : string

Returns

string

getParamName()

getParamName() : string

deprecated	Deprecated in 2.3. Use getVariableName() instead

Returns

string

getSourceContent()

getSourceContent() : string

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::getSourceContent()
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::getSourceContent()

Returns

string

getTypes()

getTypes() : array

Inherited

inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::getTypes()

Returns

array

getTypesAsString()

getTypesAsString(string $delimiter) : string

Inherited

inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::getTypesAsString()

Parameters

$delimiter

string

Returns

string

getVariableName()

getVariableName() : string

Returns

string

isSourceDirty()

isSourceDirty() : bool

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::isSourceDirty()
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::isSourceDirty()

Returns

bool

setDatatype()

setDatatype(string $datatype) : \Zend\Code\Generator\DocBlock\Tag\ReturnTag

deprecated	Deprecated in 2.3. Use setTypes() instead

Parameters

$datatype

string

Returns

\Zend\Code\Generator\DocBlock\Tag\ReturnTag

setDescription()

setDescription(string $description) : \Zend\Code\Generator\DocBlock\Tag\ReturnTag

Inherited

inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::setDescription()

Parameters

$description

string

Returns

\Zend\Code\Generator\DocBlock\Tag\ReturnTag

setIndentation()

setIndentation(string $indentation) : \Zend\Code\Generator\AbstractGenerator

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::setIndentation()
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::setIndentation()

Parameters

$indentation

string

Returns

\Zend\Code\Generator\AbstractGenerator

setOptions()

setOptions(array | \Traversable $options) : \Zend\Code\Generator\AbstractGenerator

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::setOptions()
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::setOptions()

Parameters

$options

array\Traversable

Exceptions

`\Zend\Code\Generator\Exception\InvalidArgumentException`

Returns

\Zend\Code\Generator\AbstractGenerator

setParamName()

setParamName(string $paramName) : \Zend\Code\Generator\DocBlock\Tag\ParamTag

deprecated	Deprecated in 2.3. Use setVariableName() instead

Parameters

$paramName

string

Returns

\Zend\Code\Generator\DocBlock\Tag\ParamTag

setSourceContent()

setSourceContent(string $sourceContent) : \Zend\Code\Generator\AbstractGenerator

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::setSourceContent()
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::setSourceContent()

Parameters

$sourceContent

string

Returns

\Zend\Code\Generator\AbstractGenerator

setSourceDirty()

setSourceDirty(bool $isSourceDirty) : \Zend\Code\Generator\AbstractGenerator

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::setSourceDirty()
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::setSourceDirty()

Parameters

$isSourceDirty

bool

Returns

\Zend\Code\Generator\AbstractGenerator

Array of types or string with types delimited by pipe (|) e.g.

setTypes(array | string $types) : \Zend\Code\Generator\DocBlock\Tag\ReturnTag

Inherited

array('int', 'null') or "int|null"

inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::setTypes()

Parameters

$types

arraystring

Returns

\Zend\Code\Generator\DocBlock\Tag\ReturnTag

setVariableName()

setVariableName(string $variableName) : \Zend\Code\Generator\DocBlock\Tag\ParamTag

Parameters

$variableName

string

Returns

\Zend\Code\Generator\DocBlock\Tag\ParamTag

Properties

$description

$description : string

Inherited

inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::$$description

<p>4 spaces by default</p>

$indentation : int | string

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::$$indentation
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::$$indentation

$isSourceDirty

$isSourceDirty : bool

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::$$isSourceDirty
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::$$isSourceDirty

$sourceContent

$sourceContent : string

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::$$sourceContent
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::$$sourceContent

$types

$types : array

Inherited

inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::$$types

$variableName

$variableName : string

Constants

Line feed to use in place of EOL

LINE_FEED

Inherited

inherited_from	\Zend\Code\Generator\AbstractGenerator::LINE_FEED
inherited_from	\Zend\Code\Generator\DocBlock\Tag\AbstractTypeableTag::LINE_FEED