ParamTag
extends AbstractTypeableTag
in package
implements
TagInterface
This abstract class can be used as parent for all tags that use a type part in their content.
Interfaces, Classes, Traits and Enums
Table of Contents
- LINE_FEED = "\n"
- Line feed to use in place of EOL
- $description : string
- $indentation : int|string
- $isSourceDirty : bool
- $sourceContent : string
- $types : array<string|int, mixed>
- $variableName : string
- __construct() : mixed
- fromReflection() : ParamTag
- generate() : string
- getDatatype() : string
- getDescription() : string
- getIndentation() : string
- getName() : string
- getParamName() : string
- getSourceContent() : string
- getTypes() : array<string|int, mixed>
- getTypesAsString() : string
- getVariableName() : string
- isSourceDirty() : bool
- setDatatype() : ParamTag
- setDescription() : AbstractTypeableTag
- setIndentation() : AbstractGenerator
- setOptions() : AbstractGenerator
- setParamName() : ParamTag
- setSourceContent() : AbstractGenerator
- setSourceDirty() : AbstractGenerator
- setTypes() : AbstractTypeableTag
- Array of types or string with types delimited by pipe (|) e.g. array('int', 'null') or "int|null"
- setVariableName() : ParamTag
Constants
LINE_FEED
Line feed to use in place of EOL
public
mixed
LINE_FEED
= "\n"
Properties
$description
protected
string
$description
$indentation
protected
int|string
$indentation
= ' '
4 spaces by default
$isSourceDirty
protected
bool
$isSourceDirty
= true
$sourceContent
protected
string
$sourceContent
$types
protected
array<string|int, mixed>
$types
= []
$variableName
protected
string
$variableName
Methods
__construct()
public
__construct([string $variableName = null ][, array<string|int, mixed> $types = [] ][, string $description = null ]) : mixed
Parameters
- $variableName : string = null
- $types : array<string|int, mixed> = []
- $description : string = null
Return values
mixed —fromReflection()
public
static fromReflection(TagInterface $reflectionTag) : ParamTag
Parameters
- $reflectionTag : TagInterface
Tags
Return values
ParamTag —generate()
public
generate() : string
Return values
string —getDatatype()
public
getDatatype() : string
Tags
Return values
string —getDescription()
public
getDescription() : string
Return values
string —getIndentation()
public
getIndentation() : string
Return values
string —getName()
public
getName() : string
Return values
string —getParamName()
public
getParamName() : string
Tags
Return values
string —getSourceContent()
public
getSourceContent() : string
Return values
string —getTypes()
public
getTypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTypesAsString()
public
getTypesAsString([string $delimiter = '|' ]) : string
Parameters
- $delimiter : string = '|'
Return values
string —getVariableName()
public
getVariableName() : string
Return values
string —isSourceDirty()
public
isSourceDirty() : bool
Return values
bool —setDatatype()
public
setDatatype(string $datatype) : ParamTag
Parameters
- $datatype : string
Tags
Return values
ParamTag —setDescription()
public
setDescription(string $description) : AbstractTypeableTag
Parameters
- $description : string
Return values
AbstractTypeableTag —setIndentation()
public
setIndentation(string $indentation) : AbstractGenerator
Parameters
- $indentation : string
Return values
AbstractGenerator —setOptions()
public
setOptions(array<string|int, mixed>|Traversable $options) : AbstractGenerator
Parameters
- $options : array<string|int, mixed>|Traversable
Tags
Return values
AbstractGenerator —setParamName()
public
setParamName(string $paramName) : ParamTag
Parameters
- $paramName : string
Tags
Return values
ParamTag —setSourceContent()
public
setSourceContent(string $sourceContent) : AbstractGenerator
Parameters
- $sourceContent : string
Return values
AbstractGenerator —setSourceDirty()
public
setSourceDirty([bool $isSourceDirty = true ]) : AbstractGenerator
Parameters
- $isSourceDirty : bool = true
Return values
AbstractGenerator —setTypes()
Array of types or string with types delimited by pipe (|) e.g. array('int', 'null') or "int|null"
public
setTypes(array<string|int, mixed>|string $types) : AbstractTypeableTag
Parameters
- $types : array<string|int, mixed>|string
Return values
AbstractTypeableTag —setVariableName()
public
setVariableName(string $variableName) : ParamTag
Parameters
- $variableName : string