\OCP\AppFrameworkMiddleware

Middleware is used to provide hooks before or after controller methods and deal with possible exceptions raised in the controller methods.

They're modeled after Django's middleware system: https://docs.djangoproject.com/en/dev/topics/http/middleware/

Summary

Methods
Properties
Constants
beforeController()
afterException()
afterController()
beforeOutput()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

beforeController()

beforeController(\OCP\AppFramework\Controller  $controller, string  $methodName) 

This is being run in normal order before the controller is being called which allows several modifications and checks

Parameters

\OCP\AppFramework\Controller $controller

the controller that is being called

string $methodName

the name of the method that will be called on the controller

afterException()

afterException(\OCP\AppFramework\Controller  $controller, string  $methodName, \Exception  $exception) : \OCP\AppFramework\Http\Response

This is being run when either the beforeController method or the controller method itself is throwing an exception. The middleware is asked in reverse order to handle the exception and to return a response.

If the response is null, it is assumed that the exception could not be handled and the error will be thrown again

Parameters

\OCP\AppFramework\Controller $controller

the controller that is being called

string $methodName

the name of the method that will be called on the controller

\Exception $exception

the thrown exception

Throws

\Exception

the passed in exception if it can't handle it

Returns

\OCP\AppFramework\Http\Response

a Response object in case that the exception was handled

afterController()

afterController(\OCP\AppFramework\Controller  $controller, string  $methodName, \OCP\AppFramework\Http\Response  $response) : \OCP\AppFramework\Http\Response

This is being run after a successful controllermethod call and allows the manipulation of a Response object. The middleware is run in reverse order

Parameters

\OCP\AppFramework\Controller $controller

the controller that is being called

string $methodName

the name of the method that will be called on the controller

\OCP\AppFramework\Http\Response $response

the generated response from the controller

Returns

\OCP\AppFramework\Http\Response

a Response object

beforeOutput()

beforeOutput(\OCP\AppFramework\Controller  $controller, string  $methodName, string  $output) : string

This is being run after the response object has been rendered and allows the manipulation of the output. The middleware is run in reverse order

Parameters

\OCP\AppFramework\Controller $controller

the controller that is being called

string $methodName

the name of the method that will be called on the controller

string $output

the generated output from a response

Returns

string —

the output that should be printed