Nextcloud PHP API (stable19)

IControllerMethodReflector

Interface ControllerMethodReflector

Reads and parses annotations from doc comments

Tags
since
8.0.0

Table of Contents

getParameters()  : array
getType()  : string|null
Inspects the PHPDoc parameters for types
hasAnnotation()  : bool
Check if a method contains an annotation
reflect()  : void

Methods

getParameters()

public getParameters() : array
Tags
since
8.0.0
Return values
array

the arguments of the method with key => default value

getType()

Inspects the PHPDoc parameters for types

public getType(string $parameter) : string|null
Parameters
$parameter : string

the parameter whose type comments should be parsed

Tags
since
8.0.0
Return values
string|null

type in the type parameters (@param int $something) would return int or null if not existing

hasAnnotation()

Check if a method contains an annotation

public hasAnnotation(string $name) : bool
Parameters
$name : string

the name of the annotation

Tags
since
8.0.0
Return values
bool

true if the annotation is found

reflect()

public reflect(object $object, string $method) : void
Parameters
$object : object

an object or classname

$method : string

the method which we want to inspect

Tags
since
8.0.0
deprecated
17.0.0

Reflect should not be called multiple times and only be used internally. This will be removed in Nextcloud 18

Search results