blob: d5610e762a82f0e94b701834155ce954448d41dc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
<?php
/**
* Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
namespace OCP\Route;
interface IRoute {
/**
* Specify PATCH as the method to use with this route
* @return \OCP\Route\IRoute
*/
public function patch();
/**
* Specify the method when this route is to be used
*
* @param string $method HTTP method (uppercase)
* @return \OCP\Route\IRoute
*/
public function method($method);
/**
* The action to execute when this route matches, includes a file like
* it is called directly
*
* @param $file
* @return void
*/
public function actionInclude($file);
/**
* Specify GET as the method to use with this route
* @return \OCP\Route\IRoute
*/
public function get();
/**
* Specify POST as the method to use with this route
* @return \OCP\Route\IRoute
*/
public function post();
/**
* Specify DELETE as the method to use with this route
* @return \OCP\Route\IRoute
*/
public function delete();
/**
* The action to execute when this route matches
*
* @param string|callable $class the class or a callable
* @param string $function the function to use with the class
* @return \OCP\Route\IRoute
*
* This function is called with $class set to a callable or
* to the class with $function
*/
public function action($class, $function = null);
/**
* Defaults to use for this route
*
* @param array $defaults The defaults
* @return \OCP\Route\IRoute
*/
public function defaults($defaults);
/**
* Requirements for this route
*
* @param array $requirements The requirements
* @return \OCP\Route\IRoute
*/
public function requirements($requirements);
/**
* Specify PUT as the method to use with this route
* @return \OCP\Route\IRoute
*/
public function put();
}
|
