ReflectionClassDocblockContext

class ReflectionClassDocblockContext

Methods

__construct(ReflectionClass $class, ReflectionMethodDecorator|null $method = null)

Create a class docblock context.

ReflectionClass
getDeclaringClass()

Return the class that declares the docblock.

false|string
getDocComment()

Return the class docblock.

false|string
getFileName()

Return the source filename.

string
getName()

Return the diagnostic context name.

false|int
getStartLine()

Return the source start line.

ReflectionClass
sourceClass()

Return the source class.

Details

at line 1848
__construct(ReflectionClass $class, ReflectionMethodDecorator|null $method = null)

Create a class docblock context.

Parameters

ReflectionClass $class
ReflectionMethodDecorator|null $method

at line 1857
ReflectionClass getDeclaringClass()

Return the class that declares the docblock.

Return Value

ReflectionClass

at line 1865
false|string getDocComment()

Return the class docblock.

Return Value

false|string

at line 1873
false|string getFileName()

Return the source filename.

Return Value

false|string

at line 1881
string getName()

Return the diagnostic context name.

Return Value

string

at line 1889
false|int getStartLine()

Return the source start line.

Return Value

false|int

at line 1897
ReflectionClass sourceClass()

Return the source class.

Return Value

ReflectionClass