Blame view

sources/lib/private/route/route.php 3 KB
03e52840d   Kload   Init
1
2
3
4
5
6
7
  <?php
  /**
   * Copyright (c) 2012 Bart Visscher <bartv@thisnet.nl>
   * This file is licensed under the Affero General Public License version 3 or
   * later.
   * See the COPYING-README file.
   */
6d9380f96   Cédric Dupont   Update sources OC...
8
  namespace OC\Route;
03e52840d   Kload   Init
9

6d9380f96   Cédric Dupont   Update sources OC...
10
11
12
13
  use OCP\Route\IRoute;
  use Symfony\Component\Routing\Route as SymfonyRoute;
  
  class Route extends SymfonyRoute implements IRoute {
03e52840d   Kload   Init
14
15
16
17
  	/**
  	 * Specify the method when this route is to be used
  	 *
  	 * @param string $method HTTP method (uppercase)
6d9380f96   Cédric Dupont   Update sources OC...
18
  	 * @return \OC\Route\Route
03e52840d   Kload   Init
19
20
21
22
23
24
25
26
  	 */
  	public function method($method) {
  		$this->setRequirement('_method', strtoupper($method));
  		return $this;
  	}
  
  	/**
  	 * Specify POST as the method to use with this route
6d9380f96   Cédric Dupont   Update sources OC...
27
  	 * @return \OC\Route\Route
03e52840d   Kload   Init
28
29
30
31
32
33
34
35
  	 */
  	public function post() {
  		$this->method('POST');
  		return $this;
  	}
  
  	/**
  	 * Specify GET as the method to use with this route
6d9380f96   Cédric Dupont   Update sources OC...
36
  	 * @return \OC\Route\Route
03e52840d   Kload   Init
37
38
39
40
41
42
43
44
  	 */
  	public function get() {
  		$this->method('GET');
  		return $this;
  	}
  
  	/**
  	 * Specify PUT as the method to use with this route
6d9380f96   Cédric Dupont   Update sources OC...
45
  	 * @return \OC\Route\Route
03e52840d   Kload   Init
46
47
48
49
50
51
52
53
  	 */
  	public function put() {
  		$this->method('PUT');
  		return $this;
  	}
  
  	/**
  	 * Specify DELETE as the method to use with this route
6d9380f96   Cédric Dupont   Update sources OC...
54
  	 * @return \OC\Route\Route
03e52840d   Kload   Init
55
56
57
58
59
60
61
  	 */
  	public function delete() {
  		$this->method('DELETE');
  		return $this;
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
62
  	 * Specify PATCH as the method to use with this route
6d9380f96   Cédric Dupont   Update sources OC...
63
  	 * @return \OC\Route\Route
31b7f2792   Kload   Upgrade to ownclo...
64
65
66
67
68
69
70
  	 */
  	public function patch() {
  		$this->method('PATCH');
  		return $this;
  	}
  
  	/**
03e52840d   Kload   Init
71
72
73
  	 * Defaults to use for this route
  	 *
  	 * @param array $defaults The defaults
6d9380f96   Cédric Dupont   Update sources OC...
74
  	 * @return \OC\Route\Route
03e52840d   Kload   Init
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
  	 */
  	public function defaults($defaults) {
  		$action = $this->getDefault('action');
  		$this->setDefaults($defaults);
  		if (isset($defaults['action'])) {
  			$action = $defaults['action'];
  		}
  		$this->action($action);
  		return $this;
  	}
  
  	/**
  	 * Requirements for this route
  	 *
  	 * @param array $requirements The requirements
6d9380f96   Cédric Dupont   Update sources OC...
90
  	 * @return \OC\Route\Route
03e52840d   Kload   Init
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
  	 */
  	public function requirements($requirements) {
  		$method = $this->getRequirement('_method');
  		$this->setRequirements($requirements);
  		if (isset($requirements['_method'])) {
  			$method = $requirements['_method'];
  		}
  		if ($method) {
  			$this->method($method);
  		}
  		return $this;
  	}
  
  	/**
  	 * The action to execute when this route matches
6d9380f96   Cédric Dupont   Update sources OC...
106
  	 *
03e52840d   Kload   Init
107
108
  	 * @param string|callable $class the class or a callable
  	 * @param string $function the function to use with the class
6d9380f96   Cédric Dupont   Update sources OC...
109
  	 * @return \OC\Route\Route
03e52840d   Kload   Init
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
  	 *
  	 * This function is called with $class set to a callable or
  	 * to the class with $function
  	 */
  	public function action($class, $function = null) {
  		$action = array($class, $function);
  		if (is_null($function)) {
  			$action = $class;
  		}
  		$this->setDefault('action', $action);
  		return $this;
  	}
  
  	/**
  	 * The action to execute when this route matches, includes a file like
  	 * it is called directly
6d9380f96   Cédric Dupont   Update sources OC...
126
127
  	 * @param string $file
  	 * @return void
03e52840d   Kload   Init
128
129
130
131
132
133
134
135
136
137
  	 */
  	public function actionInclude($file) {
  		$function = create_function('$param',
  			'unset($param["_route"]);'
  			.'$_GET=array_merge($_GET, $param);'
  			.'unset($param);'
  			.'require_once "'.$file.'";');
  		$this->action($function);
  	}
  }