aboutsummaryrefslogtreecommitdiffstats
path: root/lib/appframework/routing/routeconfig.php
diff options
context:
space:
mode:
authorThomas Müller <thomas.mueller@tmit.eu>2013-09-25 13:36:30 +0200
committerThomas Müller <thomas.mueller@tmit.eu>2013-09-30 16:36:59 +0200
commit9c9dc276b7a1d2592c4fb0a887888632dc1f1e29 (patch)
treebbe3aed3e09c31c68806bdb8acffef70ba08f51c /lib/appframework/routing/routeconfig.php
parenta711399e62d5a9f14d4b748efe4354ee37e61f13 (diff)
downloadnextcloud-server-9c9dc276b7a1d2592c4fb0a887888632dc1f1e29.tar.gz
nextcloud-server-9c9dc276b7a1d2592c4fb0a887888632dc1f1e29.zip
move the private namespace OC into lib/private - OCP will stay in lib/public
Conflicts: lib/private/vcategories.php
Diffstat (limited to 'lib/appframework/routing/routeconfig.php')
-rw-r--r--lib/appframework/routing/routeconfig.php186
1 files changed, 0 insertions, 186 deletions
diff --git a/lib/appframework/routing/routeconfig.php b/lib/appframework/routing/routeconfig.php
deleted file mode 100644
index 53ab11bf2f5..00000000000
--- a/lib/appframework/routing/routeconfig.php
+++ /dev/null
@@ -1,186 +0,0 @@
-<?php
-/**
- * ownCloud - App Framework
- *
- * @author Thomas Müller
- * @copyright 2013 Thomas Müller thomas.mueller@tmit.eu
- *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
- * License as published by the Free Software Foundation; either
- * version 3 of the License, or any later version.
- *
- * This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
- *
- */
-
-namespace OC\AppFramework\routing;
-
-use OC\AppFramework\DependencyInjection\DIContainer;
-
-/**
- * Class RouteConfig
- * @package OC\AppFramework\routing
- */
-class RouteConfig {
- private $container;
- private $router;
- private $routes;
- private $appName;
-
- /**
- * @param \OC\AppFramework\DependencyInjection\DIContainer $container
- * @param \OC_Router $router
- * @param string $pathToYml
- * @internal param $appName
- */
- public function __construct(DIContainer $container, \OC_Router $router, $routes) {
- $this->routes = $routes;
- $this->container = $container;
- $this->router = $router;
- $this->appName = $container['AppName'];
- }
-
- /**
- * The routes and resource will be registered to the \OC_Router
- */
- public function register() {
-
- // parse simple
- $this->processSimpleRoutes($this->routes);
-
- // parse resources
- $this->processResources($this->routes);
- }
-
- /**
- * Creates one route base on the give configuration
- * @param $routes
- * @throws \UnexpectedValueException
- */
- private function processSimpleRoutes($routes)
- {
- $simpleRoutes = isset($routes['routes']) ? $routes['routes'] : array();
- foreach ($simpleRoutes as $simpleRoute) {
- $name = $simpleRoute['name'];
- $url = $simpleRoute['url'];
- $verb = isset($simpleRoute['verb']) ? strtoupper($simpleRoute['verb']) : 'GET';
-
- $split = explode('#', $name, 2);
- if (count($split) != 2) {
- throw new \UnexpectedValueException('Invalid route name');
- }
- $controller = $split[0];
- $action = $split[1];
-
- $controllerName = $this->buildControllerName($controller);
- $actionName = $this->buildActionName($action);
-
- // register the route
- $handler = new RouteActionHandler($this->container, $controllerName, $actionName);
- $this->router->create($this->appName.'.'.$controller.'.'.$action, $url)->method($verb)->action($handler);
- }
- }
-
- /**
- * For a given name and url restful routes are created:
- * - index
- * - show
- * - new
- * - create
- * - update
- * - destroy
- *
- * @param $routes
- */
- private function processResources($routes)
- {
- // declaration of all restful actions
- $actions = array(
- array('name' => 'index', 'verb' => 'GET', 'on-collection' => true),
- array('name' => 'show', 'verb' => 'GET'),
- array('name' => 'create', 'verb' => 'POST', 'on-collection' => true),
- array('name' => 'update', 'verb' => 'PUT'),
- array('name' => 'destroy', 'verb' => 'DELETE'),
- );
-
- $resources = isset($routes['resources']) ? $routes['resources'] : array();
- foreach ($resources as $resource => $config) {
-
- // the url parameter used as id to the resource
- $resourceId = $this->buildResourceId($resource);
- foreach($actions as $action) {
- $url = $config['url'];
- $method = $action['name'];
- $verb = isset($action['verb']) ? strtoupper($action['verb']) : 'GET';
- $collectionAction = isset($action['on-collection']) ? $action['on-collection'] : false;
- if (!$collectionAction) {
- $url = $url . '/' . $resourceId;
- }
- if (isset($action['url-postfix'])) {
- $url = $url . '/' . $action['url-postfix'];
- }
-
- $controller = $resource;
-
- $controllerName = $this->buildControllerName($controller);
- $actionName = $this->buildActionName($method);
-
- $routeName = $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
-
- $this->router->create($routeName, $url)->method($verb)->action(
- new RouteActionHandler($this->container, $controllerName, $actionName)
- );
- }
- }
- }
-
- /**
- * Based on a given route name the controller name is generated
- * @param $controller
- * @return string
- */
- private function buildControllerName($controller)
- {
- return $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
- }
-
- /**
- * Based on the action part of the route name the controller method name is generated
- * @param $action
- * @return string
- */
- private function buildActionName($action) {
- return $this->underScoreToCamelCase($action);
- }
-
- /**
- * Generates the id used in the url part o the route url
- * @param $resource
- * @return string
- */
- private function buildResourceId($resource) {
- return '{'.$this->underScoreToCamelCase(rtrim($resource, 's')).'Id}';
- }
-
- /**
- * Underscored strings are converted to camel case strings
- * @param $str string
- * @return string
- */
- private function underScoreToCamelCase($str) {
- $pattern = "/_[a-z]?/";
- return preg_replace_callback(
- $pattern,
- function ($matches) {
- return strtoupper(ltrim($matches[0], "_"));
- },
- $str);
- }
-}