PromotedParameterGenerator
extends ParameterGenerator
in package
FinalYes
Table of Contents
Constants
- LINE_FEED = "\n"
- Line feed to use in place of EOL
- VISIBILITY_PRIVATE = 'private'
- VISIBILITY_PROTECTED = 'protected'
- VISIBILITY_PUBLIC = 'public'
Properties
- $defaultValue : ValueGenerator|null
- $indentation : string
- $isSourceDirty : bool
- $name : string
- $passedByReference : bool
- $position : int
- $sourceContent : string|null
- TODO: Type should be changed to "string" in the next major version. Nullable for BC
- $type : TypeGenerator|null
- $omitDefaultValue : bool
- $variadic : bool
- $visibility : string
Methods
- __construct() : mixed
- fromArray() : ParameterGenerator
- Generate from array
- fromParameterGeneratorWithVisibility() : self
- fromReflection() : ParameterGenerator
- generate() : string
- getDefaultValue() : ValueGenerator|null
- getIndentation() : string
- getName() : string
- getPassedByReference() : bool
- getPosition() : int
- getSourceContent() : string|null
- getType() : string
- getVariadic() : bool
- isSourceDirty() : bool
- omitDefaultValue() : ParameterGenerator
- setDefaultValue() : ParameterGenerator
- Set the default value of the parameter.
- setIndentation() : AbstractGenerator
- setName() : ParameterGenerator
- setOptions() : AbstractGenerator
- setPassedByReference() : ParameterGenerator
- setPosition() : ParameterGenerator
- setSourceContent() : AbstractGenerator
- setSourceDirty() : AbstractGenerator
- setType() : ParameterGenerator
- setVariadic() : ParameterGenerator
- generateTypeHint() : string
Constants
LINE_FEED
Line feed to use in place of EOL
public
mixed
LINE_FEED
= "\n"
VISIBILITY_PRIVATE
public
mixed
VISIBILITY_PRIVATE
= 'private'
VISIBILITY_PROTECTED
public
mixed
VISIBILITY_PROTECTED
= 'protected'
VISIBILITY_PUBLIC
public
mixed
VISIBILITY_PUBLIC
= 'public'
Properties
$defaultValue
protected
ValueGenerator|null
$defaultValue
= null
$indentation
protected
string
$indentation
= ' '
4 spaces by default
$isSourceDirty
protected
bool
$isSourceDirty
= true
$name
protected
string
$name
= ''
$passedByReference
protected
bool
$passedByReference
= false
$position
protected
int
$position
= 0
$sourceContent
TODO: Type should be changed to "string" in the next major version. Nullable for BC
protected
string|null
$sourceContent
= null
$type
protected
TypeGenerator|null
$type
= null
$omitDefaultValue
private
bool
$omitDefaultValue
= false
$variadic
private
bool
$variadic
= false
$visibility
private
string
$visibility
Tags
Methods
__construct()
public
__construct(string $name[, string|null $type = null ][, string $visibility = self::VISIBILITY_PUBLIC ][, int|null $position = null ][, bool $passByReference = false ]) : mixed
Parameters
- $name : string
- $type : string|null = null
- $visibility : string = self::VISIBILITY_PUBLIC
- $position : int|null = null
- $passByReference : bool = false
Tags
fromArray()
Generate from array
public
static fromArray(array<string|int, mixed> $array) : ParameterGenerator
Parameters
- $array : array<string|int, mixed>
Tags
Return values
ParameterGeneratorfromParameterGeneratorWithVisibility()
public
static fromParameterGeneratorWithVisibility(ParameterGenerator $generator, string $visibility) : self
Parameters
- $generator : ParameterGenerator
- $visibility : string
Tags
Return values
selffromReflection()
public
static fromReflection(ParameterReflection $reflectionParameter) : ParameterGenerator
Parameters
- $reflectionParameter : ParameterReflection
Return values
ParameterGeneratorgenerate()
public
generate() : string
Tags
Return values
stringgetDefaultValue()
public
getDefaultValue() : ValueGenerator|null
Return values
ValueGenerator|nullgetIndentation()
public
getIndentation() : string
Return values
stringgetName()
public
getName() : string
Return values
stringgetPassedByReference()
public
getPassedByReference() : bool
Return values
boolgetPosition()
public
getPosition() : int
Return values
intgetSourceContent()
public
getSourceContent() : string|null
Return values
string|nullgetType()
public
getType() : string
Return values
stringgetVariadic()
public
getVariadic() : bool
Return values
boolisSourceDirty()
public
isSourceDirty() : bool
Return values
boolomitDefaultValue()
public
omitDefaultValue([bool $omit = true ]) : ParameterGenerator
Parameters
- $omit : bool = true
Return values
ParameterGeneratorsetDefaultValue()
Set the default value of the parameter.
public
setDefaultValue(null|bool|string|int|float|array<string|int, mixed>|ValueGenerator $defaultValue) : ParameterGenerator
Certain variables are difficult to express
Parameters
- $defaultValue : null|bool|string|int|float|array<string|int, mixed>|ValueGenerator
Return values
ParameterGeneratorsetIndentation()
public
setIndentation(string $indentation) : AbstractGenerator
Parameters
- $indentation : string
Return values
AbstractGeneratorsetName()
public
setName(string $name) : ParameterGenerator
Parameters
- $name : string
Return values
ParameterGeneratorsetOptions()
public
setOptions(array<string|int, mixed>|Traversable $options) : AbstractGenerator
Parameters
- $options : array<string|int, mixed>|Traversable
Tags
Return values
AbstractGeneratorsetPassedByReference()
public
setPassedByReference(bool $passedByReference) : ParameterGenerator
Parameters
- $passedByReference : bool
Return values
ParameterGeneratorsetPosition()
public
setPosition(int $position) : ParameterGenerator
Parameters
- $position : int
Return values
ParameterGeneratorsetSourceContent()
public
setSourceContent(string|null $sourceContent) : AbstractGenerator
Parameters
- $sourceContent : string|null
Return values
AbstractGeneratorsetSourceDirty()
public
setSourceDirty([bool $isSourceDirty = true ]) : AbstractGenerator
Parameters
- $isSourceDirty : bool = true
Return values
AbstractGeneratorsetType()
public
setType(string $type) : ParameterGenerator
Parameters
- $type : string
Return values
ParameterGeneratorsetVariadic()
public
setVariadic(bool $variadic) : ParameterGenerator
Parameters
- $variadic : bool
Return values
ParameterGeneratorgenerateTypeHint()
private
generateTypeHint() : string