Function_
extends AbstractFactory
in package
implements
ProjectFactoryStrategy
Strategy to convert Function_ to FunctionDescriptor
Tags
Interfaces, Classes and Traits
- ProjectFactoryStrategy
- Interface for strategies used by the project factory to build Elements out of nodes.
Table of Contents
- $docBlockFactory : DocBlockFactoryInterface
- __construct() : mixed
- 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() : void
- Creates a FunctionDescriptor out of the given object including its child elements.
Properties
$docBlockFactory
private
DocBlockFactoryInterface
$docBlockFactory
Methods
__construct()
public
__construct(DocBlockFactoryInterface $docBlockFactory) : mixed
Parameters
- $docBlockFactory : DocBlockFactoryInterface
Return values
mixed —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.
Return values
void —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.
Return values
bool —createDocBlock()
protected
createDocBlock([Doc|null $docBlock = null ][, Context|null $context = null ]) : DocBlock|null
Parameters
Return values
DocBlock|null —doCreate()
Creates a FunctionDescriptor out of the given object including its child elements.
protected
doCreate(ContextStack $context, Function_ $object, StrategyContainer $strategies) : void
Parameters
- $context : ContextStack
-
of the created object
- $object : Function_
- $strategies : StrategyContainer