Documentation

PropertyDocBlockExtractorInterface

Extract a property's doc block.

A property's doc block may be located on a constructor promoted argument, on the property or on a mutator for that property.

Tags
author

Tobias Nyholm tobias.nyholm@gmail.com

Table of Contents

Methods

getDocBlock()  : DocBlock|null
Gets the first available doc block for a property. It finds the doc block by the following priority: - constructor promoted argument, - the class property, - a mutator method for that property.

Methods

getDocBlock()

Gets the first available doc block for a property. It finds the doc block by the following priority: - constructor promoted argument, - the class property, - a mutator method for that property.

public getDocBlock(string $class, string $property) : DocBlock|null

If no doc block is found, it will return null.

Parameters
$class : string
$property : string
Return values
DocBlock|null

        
On this page

Search results