summaryrefslogtreecommitdiffstats
path: root/lib/private/route/route.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/route/route.php')
-rw-r--r--lib/private/route/route.php132
1 files changed, 132 insertions, 0 deletions
diff --git a/lib/private/route/route.php b/lib/private/route/route.php
new file mode 100644
index 00000000000..6ade9ec15f6
--- /dev/null
+++ b/lib/private/route/route.php
@@ -0,0 +1,132 @@
+<?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.
+ */
+
+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->setRequirement('_method', strtoupper($method));
+ return $this;
+ }
+
+ /**
+ * Specify POST as the method to use with this route
+ */
+ public function post() {
+ $this->method('POST');
+ return $this;
+ }
+
+ /**
+ * Specify GET as the method to use with this route
+ */
+ public function get() {
+ $this->method('GET');
+ return $this;
+ }
+
+ /**
+ * Specify PUT as the method to use with this route
+ */
+ public function put() {
+ $this->method('PUT');
+ return $this;
+ }
+
+ /**
+ * Specify DELETE as the method to use with this route
+ */
+ public function delete() {
+ $this->method('DELETE');
+ return $this;
+ }
+
+ /**
+ * Specify PATCH as the method to use with this 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->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
+ *
+ * @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 $file
+ */
+ public function actionInclude($file) {
+ $function = create_function('$param',
+ 'unset($param["_route"]);'
+ .'$_GET=array_merge($_GET, $param);'
+ .'unset($param);'
+ .'require_once "'.$file.'";');
+ $this->action($function);
+ }
+}