aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Route/Route.php
diff options
context:
space:
mode:
authorRoeland Jago Douma <rullzer@owncloud.com>2016-04-25 21:49:07 +0200
committerRoeland Jago Douma <rullzer@owncloud.com>2016-04-25 21:49:07 +0200
commitbb1e2f9d9d51e83da6ee0da9ce5fb2e415542119 (patch)
treeb5158aa03c9460235f4d30b04cca1d8ff16111ac /lib/private/Route/Route.php
parent5e57d3a0b9c42df1413c4d2245faf1bbbe768a63 (diff)
downloadnextcloud-server-bb1e2f9d9d51e83da6ee0da9ce5fb2e415542119.tar.gz
nextcloud-server-bb1e2f9d9d51e83da6ee0da9ce5fb2e415542119.zip
Move \OC\Route to PSR-4
Diffstat (limited to 'lib/private/Route/Route.php')
-rw-r--r--lib/private/Route/Route.php157
1 files changed, 157 insertions, 0 deletions
diff --git a/lib/private/Route/Route.php b/lib/private/Route/Route.php
new file mode 100644
index 00000000000..966790a63c0
--- /dev/null
+++ b/lib/private/Route/Route.php
@@ -0,0 +1,157 @@
+<?php
+/**
+ * @author Bart Visscher <bartv@thisnet.nl>
+ * @author David Prévot <taffit@debian.org>
+ * @author Felix Moeller <mail@felixmoeller.de>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Robin McCorkell <robin@mccorkell.me.uk>
+ * @author Thomas Tanghus <thomas@tanghus.net>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\Route;
+
+use OCP\Route\IRoute;
+use Symfony\Component\Routing\Route as SymfonyRoute;
+
+class Route extends SymfonyRoute implements IRoute {
+ /**
+ * Specify the method when this route is to be used
+ *
+ * @param string $method HTTP method (uppercase)
+ * @return \OC\Route\Route
+ */
+ public function method($method) {
+ $this->setMethods($method);
+ return $this;
+ }
+
+ /**
+ * Specify POST as the method to use with this route
+ * @return \OC\Route\Route
+ */
+ public function post() {
+ $this->method('POST');
+ return $this;
+ }
+
+ /**
+ * Specify GET as the method to use with this route
+ * @return \OC\Route\Route
+ */
+ public function get() {
+ $this->method('GET');
+ return $this;
+ }
+
+ /**
+ * Specify PUT as the method to use with this route
+ * @return \OC\Route\Route
+ */
+ public function put() {
+ $this->method('PUT');
+ return $this;
+ }
+
+ /**
+ * Specify DELETE as the method to use with this route
+ * @return \OC\Route\Route
+ */
+ public function delete() {
+ $this->method('DELETE');
+ return $this;
+ }
+
+ /**
+ * Specify PATCH as the method to use with this route
+ * @return \OC\Route\Route
+ */
+ public function patch() {
+ $this->method('PATCH');
+ return $this;
+ }
+
+ /**
+ * Defaults to use for this route
+ *
+ * @param array $defaults The defaults
+ * @return \OC\Route\Route
+ */
+ 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
+ * @return \OC\Route\Route
+ */
+ public function requirements($requirements) {
+ $method = $this->getMethods();
+ $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
+ *
+ * @param string|callable $class the class or a callable
+ * @param string $function the function to use with the class
+ * @return \OC\Route\Route
+ *
+ * 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
+ * @param string $file
+ * @return void
+ */
+ public function actionInclude($file) {
+ $function = create_function('$param',
+ 'unset($param["_route"]);'
+ .'$_GET=array_merge($_GET, $param);'
+ .'unset($param);'
+ .'require_once "'.$file.'";');
+ $this->action($function);
+ }
+}