Define
extends AbstractFactory
in package
Strategy to convert `define` expressions to ConstantElement
Tags
Table of Contents
Properties
- $docBlockFactory : DocBlockFactoryInterface
- $reducers : iterable<string|int, mixed>
- $constantEvaluator : ConstantEvaluator
- $valueConverter : Standard
Methods
- __construct() : mixed
- Initializes the object.
- create() : void
- Creates an Element out of the given object.
- matches() : bool
- Returns true when the strategy is able to handle the object.
- createDocBlock() : DocBlock|null
- doCreate() : object|null
- Creates an Constant out of the given object.
- determineFqsen() : Fqsen|null
- determineValue() : Expression|null
- fqsenFromExpression() : Fqsen|null
- fqsenFromString() : Fqsen
Properties
$docBlockFactory read-only
protected
DocBlockFactoryInterface
$docBlockFactory
$reducers read-only
protected
iterable<string|int, mixed>
$reducers
= []
$constantEvaluator read-only
private
ConstantEvaluator
$constantEvaluator
= new ConstantEvaluator()
$valueConverter read-only
private
Standard
$valueConverter
Methods
__construct()
Initializes the object.
public
__construct(DocBlockFactoryInterface $docBlockFactory, Standard $valueConverter[, ConstantEvaluator $constantEvaluator = new ConstantEvaluator() ]) : mixed
Parameters
- $docBlockFactory : DocBlockFactoryInterface
- $valueConverter : Standard
- $constantEvaluator : ConstantEvaluator = new ConstantEvaluator()
create()
Creates an Element out of the given object.
public
create(ContextStack $context, object $object, StrategyContainer $strategies) : void
Since an object might contain other objects that need to be converted the $stategies are passed so it can be used to create nested Elements. The passed ContextStack contains a stack of upstream created Elements that can be manipulated by factories. This allows the factory to also impact on parent objects of earlier created elements.
Parameters
- $context : ContextStack
-
context to set the factory result.
- $object : object
-
object to convert to an Element
- $strategies : StrategyContainer
-
used to convert nested objects.
Attributes
- #[Override]
matches()
Returns true when the strategy is able to handle the object.
public
matches(ContextStack $context, object $object) : bool
Parameters
- $context : ContextStack
- $object : object
-
object to check.
Attributes
- #[Override]
Return values
boolcreateDocBlock()
protected
createDocBlock([Doc|null $docBlock = null ][, Context|null $context = null ]) : DocBlock|null
Parameters
Return values
DocBlock|nulldoCreate()
Creates an Constant out of the given object.
protected
doCreate(ContextStack $context, Expression $object, StrategyContainer $strategies) : object|null
Since an object might contain other objects that need to be converted the $factory is passed so it can be used to create nested Elements.
Parameters
- $context : ContextStack
- $object : Expression
-
object to convert to an Element
- $strategies : StrategyContainer
-
used to convert nested objects.
Attributes
- #[Override]
Return values
object|nulldetermineFqsen()
private
determineFqsen(Arg $name, ContextStack $context) : Fqsen|null
Parameters
- $name : Arg
- $context : ContextStack
Return values
Fqsen|nulldetermineValue()
private
determineValue(Arg|null $value) : Expression|null
Parameters
- $value : Arg|null
Return values
Expression|nullfqsenFromExpression()
private
fqsenFromExpression(Expr $nameString, ContextStack $context) : Fqsen|null
Parameters
- $nameString : Expr
- $context : ContextStack
Return values
Fqsen|nullfqsenFromString()
private
fqsenFromString(string $nameString) : Fqsen
Parameters
- $nameString : string