\OCP\RouteIRoute

Interface IRoute

Summary

Methods
Constants
patch()
method()
actionInclude()
get()
post()
delete()
action()
defaults()
requirements()
put()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

patch()

patch() : \OCP\Route\IRoute

Specify PATCH as the method to use with this route

Returns

\OCP\Route\IRoute

method()

method(string  $method) : \OCP\Route\IRoute

Specify the method when this route is to be used

Parameters

string $method

HTTP method (uppercase)

Returns

\OCP\Route\IRoute

actionInclude()

actionInclude(string  $file) : void

The action to execute when this route matches, includes a file like it is called directly

Parameters

string $file

get()

get() : \OCP\Route\IRoute

Specify GET as the method to use with this route

Returns

\OCP\Route\IRoute

post()

post() : \OCP\Route\IRoute

Specify POST as the method to use with this route

Returns

\OCP\Route\IRoute

delete()

delete() : \OCP\Route\IRoute

Specify DELETE as the method to use with this route

Returns

\OCP\Route\IRoute

action()

action(string|callable  $class, string  $function = null) : \OCP\Route\IRoute

The action to execute when this route matches

Parameters

string|callable $class

the class or a callable

string $function

the function to use with the class

Returns

\OCP\Route\IRoute

This function is called with $class set to a callable or to the class with $function

defaults()

defaults(array  $defaults) : \OCP\Route\IRoute

Defaults to use for this route

Parameters

array $defaults

The defaults

Returns

\OCP\Route\IRoute

requirements()

requirements(array  $requirements) : \OCP\Route\IRoute

Requirements for this route

Parameters

array $requirements

The requirements

Returns

\OCP\Route\IRoute

put()

put() : \OCP\Route\IRoute

Specify PUT as the method to use with this route

Returns

\OCP\Route\IRoute