ControllerMethodReflector

class OC\AppFramework\Utility\ControllerMethodReflector
Reads and parses annotations from doc comments
Source:lib/private/AppFramework/Utility/ControllerMethodReflector.php#42
Implements:OCP\AppFramework\Utility\IControllerMethodReflector

Properties

public static property OC\AppFramework\Utility\ControllerMethodReflector::$annotations
Source:lib/private/AppFramework/Utility/ControllerMethodReflector.php#43

Methods

public OC\AppFramework\Utility\ControllerMethodReflector::reflect($object, $method)
Source:

lib/private/AppFramework/Utility/ControllerMethodReflector.php#51

Parameters:
  • $object (object) an object or classname
  • $method (string) the method which we want to inspect
public OC\AppFramework\Utility\ControllerMethodReflector::getType($parameter)
Inspects the PHPDoc parameters for types
Source:

lib/private/AppFramework/Utility/ControllerMethodReflector.php#102

Parameters:
  • $parameter (string) the parameter whose type comments should be

parsed

Returns:

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

public OC\AppFramework\Utility\ControllerMethodReflector::getParameters()
Source:lib/private/AppFramework/Utility/ControllerMethodReflector.php#113
Returns:array the arguments of the method with key => default value
public OC\AppFramework\Utility\ControllerMethodReflector::hasAnnotation($name)
Check if a method contains an annotation
Source:

lib/private/AppFramework/Utility/ControllerMethodReflector.php#122

Parameters:
  • $name (string) the name of the annotation
Returns:

bool true if the annotation is found

public OC\AppFramework\Utility\ControllerMethodReflector::getAnnotationParameter($name, $key)
Get optional annotation parameter by key
Source:

lib/private/AppFramework/Utility/ControllerMethodReflector.php#134

Parameters:
  • $name (string) the name of the annotation
  • $key (string) the string of the annotation
Returns:

string