PHP Class TheSeer\phpDox\DocBlock\Factory

Exibir arquivo Open project: theseer/phpdox Class Usage Examples

Public Methods

Method	Description
addParserClass ( string $annotation, string $classname )	Register a parser by its classname.
addParserFactory ( string $annotation, TheSeer\phpDox\FactoryInterface \| string $factory )	Register a parser factory.
getDocBlock ( )
getElementInstanceFor ( $name, $annotation = null )
getInlineProcessor ( TheSeer\fDOM\fDOMDocument $dom )
getParserInstanceFor ( $name, $annotation = null )

Protected Methods

Method	Description
getInstanceByMap ( $map, $name, $annotation = null )
verifyType ( mixed $item, string $type = 'string' )	Verify the type of the given item matches the expected one.

Method Details

addParserClass() public method

Register a parser by its classname.

public addParserClass ( string $annotation, string $classname )
$annotation	string	Identifier of the parser within the registry.
$classname	string	Name of the class representing the parser.

addParserFactory() public method

Register a parser factory.

public addParserFactory ( string $annotation, TheSeer\phpDox\FactoryInterface \| string $factory )
$annotation	string	Identifier of the parser within the registry.
$factory	TheSeer\phpDox\FactoryInterface \| string	Instance of FactoryInterface to be registered or FQCN of the object to be created.

getDocBlock() public method

public getDocBlock ( )

getElementInstanceFor() public method

public getElementInstanceFor ( $name, $annotation = null )

getInlineProcessor() public method

public getInlineProcessor ( TheSeer\fDOM\fDOMDocument $dom )
$dom	TheSeer\fDOM\fDOMDocument

getInstanceByMap() protected method

protected getInstanceByMap ( $map, $name, $annotation = null )

getParserInstanceFor() public method

public getParserInstanceFor ( $name, $annotation = null )

verifyType() protected method

Verify the type of the given item matches the expected one.

protected verifyType ( mixed $item, string $type = 'string' )
$item	mixed
$type	string