nextcloud / server

lib/private/AppFramework/Routing/RouteConfig.php

Indentation +275 added lines, -275 removed lines

@@ -37,281 +37,281 @@
  * @package OC\AppFramework\routing
  */
 class RouteConfig {
-	/** @var DIContainer */
-	private $container;
-
-	/** @var IRouter */
-	private $router;
-
-	/** @var array */
-	private $routes;
-
-	/** @var string */
-	private $appName;
-
-	/** @var string[] */
-	private $controllerNameCache = [];
-
-	/**
-	 * @param \OC\AppFramework\DependencyInjection\DIContainer $container
-	 * @param \OCP\Route\IRouter $router
-	 * @param array $routes
-	 * @internal param $appName
-	 */
-	public function __construct(DIContainer $container, IRouter $router, $routes) {
-		$this->routes = $routes;
-		$this->container = $container;
-		$this->router = $router;
-		$this->appName = $container['AppName'];
-	}
-
-	/**
-	 * The routes and resource will be registered to the \OCP\Route\IRouter
-	 */
-	public function register() {
-
-		// parse simple
-		$this->processSimpleRoutes($this->routes);
-
-		// parse resources
-		$this->processResources($this->routes);
-
-		/*
+    /** @var DIContainer */
+    private $container;
+
+    /** @var IRouter */
+    private $router;
+
+    /** @var array */
+    private $routes;
+
+    /** @var string */
+    private $appName;
+
+    /** @var string[] */
+    private $controllerNameCache = [];
+
+    /**
+     * @param \OC\AppFramework\DependencyInjection\DIContainer $container
+     * @param \OCP\Route\IRouter $router
+     * @param array $routes
+     * @internal param $appName
+     */
+    public function __construct(DIContainer $container, IRouter $router, $routes) {
+        $this->routes = $routes;
+        $this->container = $container;
+        $this->router = $router;
+        $this->appName = $container['AppName'];
+    }
+
+    /**
+     * The routes and resource will be registered to the \OCP\Route\IRouter
+     */
+    public function register() {
+
+        // parse simple
+        $this->processSimpleRoutes($this->routes);
+
+        // parse resources
+        $this->processResources($this->routes);
+
+        /*
 		 * OCS routes go into a different collection
 		 */
-		$oldCollection = $this->router->getCurrentCollection();
-		$this->router->useCollection($oldCollection . '.ocs');
-
-		// parse ocs simple routes
-		$this->processOCS($this->routes);
-
-		// parse ocs simple routes
-		$this->processOCSResources($this->routes);
-
-		$this->router->useCollection($oldCollection);
-	}
-
-	private function processOCS(array $routes): void {
-		$ocsRoutes = $routes['ocs'] ?? [];
-		foreach ($ocsRoutes as $ocsRoute) {
-			$name = $ocsRoute['name'];
-			$postfix = $ocsRoute['postfix'] ?? '';
-			$root = $ocsRoute['root'] ?? '/apps/' . $this->appName;
-
-			$url = $root . $ocsRoute['url'];
-			$verb = strtoupper($ocsRoute['verb'] ?? 'GET');
-
-			$split = explode('#', $name, 2);
-			if (count($split) !== 2) {
-				throw new \UnexpectedValueException('Invalid route name');
-			}
-			list($controller, $action) = $split;
-
-			$controllerName = $this->buildControllerName($controller);
-			$actionName = $this->buildActionName($action);
-
-			$routeName = 'ocs.' . $this->appName . '.' . $controller . '.' . $action . $postfix;
-
-			// register the route
-			$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
-
-			$router = $this->router->create($routeName, $url)
-				->method($verb)
-				->action($handler);
-
-			// optionally register requirements for route. This is used to
-			// tell the route parser how url parameters should be matched
-			if(array_key_exists('requirements', $ocsRoute)) {
-				$router->requirements($ocsRoute['requirements']);
-			}
-
-			// optionally register defaults for route. This is used to
-			// tell the route parser how url parameters should be default valued
-			if(array_key_exists('defaults', $ocsRoute)) {
-				$router->defaults($ocsRoute['defaults']);
-			}
-		}
-	}
-
-	/**
-	 * Creates one route base on the give configuration
-	 * @param array $routes
-	 * @throws \UnexpectedValueException
-	 */
-	private function processSimpleRoutes(array $routes): void {
-		$simpleRoutes = $routes['routes'] ?? [];
-		foreach ($simpleRoutes as $simpleRoute) {
-			$name = $simpleRoute['name'];
-			$postfix = $simpleRoute['postfix'] ?? '';
-
-			$url = $simpleRoute['url'];
-			$verb = strtoupper($simpleRoute['verb'] ?? 'GET');
-
-			$split = explode('#', $name, 2);
-			if (count($split) !== 2) {
-				throw new \UnexpectedValueException('Invalid route name');
-			}
-			list($controller, $action) = $split;
-
-			$controllerName = $this->buildControllerName($controller);
-			$actionName = $this->buildActionName($action);
-
-			$routeName = $this->appName . '.' . $controller . '.' . $action . $postfix;
-
-			// register the route
-			$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
-			$router = $this->router->create($routeName, $url)
-							->method($verb)
-							->action($handler);
-
-			// optionally register requirements for route. This is used to
-			// tell the route parser how url parameters should be matched
-			if(array_key_exists('requirements', $simpleRoute)) {
-				$router->requirements($simpleRoute['requirements']);
-			}
-
-			// optionally register defaults for route. This is used to
-			// tell the route parser how url parameters should be default valued
-			if(array_key_exists('defaults', $simpleRoute)) {
-				$router->defaults($simpleRoute['defaults']);
-			}
-		}
-	}
-
-	/**
-	 * For a given name and url restful OCS routes are created:
-	 *  - index
-	 *  - show
-	 *  - create
-	 *  - update
-	 *  - destroy
-	 *
-	 * @param array $routes
-	 */
-	private function processOCSResources(array $routes): void {
-		// declaration of all restful actions
-		$actions = [
-			['name' => 'index', 'verb' => 'GET', 'on-collection' => true],
-			['name' => 'show', 'verb' => 'GET'],
-			['name' => 'create', 'verb' => 'POST', 'on-collection' => true],
-			['name' => 'update', 'verb' => 'PUT'],
-			['name' => 'destroy', 'verb' => 'DELETE'],
-		];
-
-		$resources = $routes['ocs-resources'] ?? [];
-		foreach ($resources as $resource => $config) {
-			$root = $config['root'] ?? '/apps/' . $this->appName;
-
-			// the url parameter used as id to the resource
-			foreach($actions as $action) {
-				$url = $root . $config['url'];
-				$method = $action['name'];
-				$verb = strtoupper($action['verb'] ?? 'GET');
-				$collectionAction = $action['on-collection'] ?? false;
-				if (!$collectionAction) {
-					$url .= '/{id}';
-				}
-				if (isset($action['url-postfix'])) {
-					$url .= '/' . $action['url-postfix'];
-				}
-
-				$controller = $resource;
-
-				$controllerName = $this->buildControllerName($controller);
-				$actionName = $this->buildActionName($method);
-
-				$routeName = 'ocs.' . $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
-
-				$this->router->create($routeName, $url)->method($verb)->action(
-					new RouteActionHandler($this->container, $controllerName, $actionName)
-				);
-			}
-		}
-	}
-
-	/**
-	 * For a given name and url restful routes are created:
-	 *  - index
-	 *  - show
-	 *  - create
-	 *  - update
-	 *  - destroy
-	 *
-	 * @param array $routes
-	 */
-	private function processResources(array $routes): void {
-		// declaration of all restful actions
-		$actions = [
-			['name' => 'index', 'verb' => 'GET', 'on-collection' => true],
-			['name' => 'show', 'verb' => 'GET'],
-			['name' => 'create', 'verb' => 'POST', 'on-collection' => true],
-			['name' => 'update', 'verb' => 'PUT'],
-			['name' => 'destroy', 'verb' => 'DELETE'],
-		];
-
-		$resources = $routes['resources'] ?? [];
-		foreach ($resources as $resource => $config) {
-
-			// the url parameter used as id to the resource
-			foreach($actions as $action) {
-				$url = $config['url'];
-				$method = $action['name'];
-				$verb = strtoupper($action['verb'] ?? 'GET');
-				$collectionAction = $action['on-collection'] ?? false;
-				if (!$collectionAction) {
-					$url .= '/{id}';
-				}
-				if (isset($action['url-postfix'])) {
-					$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 string $controller
-	 * @return string
-	 */
-	private function buildControllerName(string $controller): string {
-		if (!isset($this->controllerNameCache[$controller])) {
-			$this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
-		}
-		return $this->controllerNameCache[$controller];
-	}
-
-	/**
-	 * Based on the action part of the route name the controller method name is generated
-	 * @param string $action
-	 * @return string
-	 */
-	private function buildActionName(string $action): string {
-		return $this->underScoreToCamelCase($action);
-	}
-
-	/**
-	 * Underscored strings are converted to camel case strings
-	 * @param string $str
-	 * @return string
-	 */
-	private function underScoreToCamelCase(string $str): string {
-		$pattern = '/_[a-z]?/';
-		return preg_replace_callback(
-			$pattern,
-			function ($matches) {
-				return strtoupper(ltrim($matches[0], '_'));
-			},
-			$str);
-	}
+        $oldCollection = $this->router->getCurrentCollection();
+        $this->router->useCollection($oldCollection . '.ocs');
+
+        // parse ocs simple routes
+        $this->processOCS($this->routes);
+
+        // parse ocs simple routes
+        $this->processOCSResources($this->routes);
+
+        $this->router->useCollection($oldCollection);
+    }
+
+    private function processOCS(array $routes): void {
+        $ocsRoutes = $routes['ocs'] ?? [];
+        foreach ($ocsRoutes as $ocsRoute) {
+            $name = $ocsRoute['name'];
+            $postfix = $ocsRoute['postfix'] ?? '';
+            $root = $ocsRoute['root'] ?? '/apps/' . $this->appName;
+
+            $url = $root . $ocsRoute['url'];
+            $verb = strtoupper($ocsRoute['verb'] ?? 'GET');
+
+            $split = explode('#', $name, 2);
+            if (count($split) !== 2) {
+                throw new \UnexpectedValueException('Invalid route name');
+            }
+            list($controller, $action) = $split;
+
+            $controllerName = $this->buildControllerName($controller);
+            $actionName = $this->buildActionName($action);
+
+            $routeName = 'ocs.' . $this->appName . '.' . $controller . '.' . $action . $postfix;
+
+            // register the route
+            $handler = new RouteActionHandler($this->container, $controllerName, $actionName);
+
+            $router = $this->router->create($routeName, $url)
+                ->method($verb)
+                ->action($handler);
+
+            // optionally register requirements for route. This is used to
+            // tell the route parser how url parameters should be matched
+            if(array_key_exists('requirements', $ocsRoute)) {
+                $router->requirements($ocsRoute['requirements']);
+            }
+
+            // optionally register defaults for route. This is used to
+            // tell the route parser how url parameters should be default valued
+            if(array_key_exists('defaults', $ocsRoute)) {
+                $router->defaults($ocsRoute['defaults']);
+            }
+        }
+    }
+
+    /**
+     * Creates one route base on the give configuration
+     * @param array $routes
+     * @throws \UnexpectedValueException
+     */
+    private function processSimpleRoutes(array $routes): void {
+        $simpleRoutes = $routes['routes'] ?? [];
+        foreach ($simpleRoutes as $simpleRoute) {
+            $name = $simpleRoute['name'];
+            $postfix = $simpleRoute['postfix'] ?? '';
+
+            $url = $simpleRoute['url'];
+            $verb = strtoupper($simpleRoute['verb'] ?? 'GET');
+
+            $split = explode('#', $name, 2);
+            if (count($split) !== 2) {
+                throw new \UnexpectedValueException('Invalid route name');
+            }
+            list($controller, $action) = $split;
+
+            $controllerName = $this->buildControllerName($controller);
+            $actionName = $this->buildActionName($action);
+
+            $routeName = $this->appName . '.' . $controller . '.' . $action . $postfix;
+
+            // register the route
+            $handler = new RouteActionHandler($this->container, $controllerName, $actionName);
+            $router = $this->router->create($routeName, $url)
+                            ->method($verb)
+                            ->action($handler);
+
+            // optionally register requirements for route. This is used to
+            // tell the route parser how url parameters should be matched
+            if(array_key_exists('requirements', $simpleRoute)) {
+                $router->requirements($simpleRoute['requirements']);
+            }
+
+            // optionally register defaults for route. This is used to
+            // tell the route parser how url parameters should be default valued
+            if(array_key_exists('defaults', $simpleRoute)) {
+                $router->defaults($simpleRoute['defaults']);
+            }
+        }
+    }
+
+    /**
+     * For a given name and url restful OCS routes are created:
+     *  - index
+     *  - show
+     *  - create
+     *  - update
+     *  - destroy
+     *
+     * @param array $routes
+     */
+    private function processOCSResources(array $routes): void {
+        // declaration of all restful actions
+        $actions = [
+            ['name' => 'index', 'verb' => 'GET', 'on-collection' => true],
+            ['name' => 'show', 'verb' => 'GET'],
+            ['name' => 'create', 'verb' => 'POST', 'on-collection' => true],
+            ['name' => 'update', 'verb' => 'PUT'],
+            ['name' => 'destroy', 'verb' => 'DELETE'],
+        ];
+
+        $resources = $routes['ocs-resources'] ?? [];
+        foreach ($resources as $resource => $config) {
+            $root = $config['root'] ?? '/apps/' . $this->appName;
+
+            // the url parameter used as id to the resource
+            foreach($actions as $action) {
+                $url = $root . $config['url'];
+                $method = $action['name'];
+                $verb = strtoupper($action['verb'] ?? 'GET');
+                $collectionAction = $action['on-collection'] ?? false;
+                if (!$collectionAction) {
+                    $url .= '/{id}';
+                }
+                if (isset($action['url-postfix'])) {
+                    $url .= '/' . $action['url-postfix'];
+                }
+
+                $controller = $resource;
+
+                $controllerName = $this->buildControllerName($controller);
+                $actionName = $this->buildActionName($method);
+
+                $routeName = 'ocs.' . $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
+
+                $this->router->create($routeName, $url)->method($verb)->action(
+                    new RouteActionHandler($this->container, $controllerName, $actionName)
+                );
+            }
+        }
+    }
+
+    /**
+     * For a given name and url restful routes are created:
+     *  - index
+     *  - show
+     *  - create
+     *  - update
+     *  - destroy
+     *
+     * @param array $routes
+     */
+    private function processResources(array $routes): void {
+        // declaration of all restful actions
+        $actions = [
+            ['name' => 'index', 'verb' => 'GET', 'on-collection' => true],
+            ['name' => 'show', 'verb' => 'GET'],
+            ['name' => 'create', 'verb' => 'POST', 'on-collection' => true],
+            ['name' => 'update', 'verb' => 'PUT'],
+            ['name' => 'destroy', 'verb' => 'DELETE'],
+        ];
+
+        $resources = $routes['resources'] ?? [];
+        foreach ($resources as $resource => $config) {
+
+            // the url parameter used as id to the resource
+            foreach($actions as $action) {
+                $url = $config['url'];
+                $method = $action['name'];
+                $verb = strtoupper($action['verb'] ?? 'GET');
+                $collectionAction = $action['on-collection'] ?? false;
+                if (!$collectionAction) {
+                    $url .= '/{id}';
+                }
+                if (isset($action['url-postfix'])) {
+                    $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 string $controller
+     * @return string
+     */
+    private function buildControllerName(string $controller): string {
+        if (!isset($this->controllerNameCache[$controller])) {
+            $this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
+        }
+        return $this->controllerNameCache[$controller];
+    }
+
+    /**
+     * Based on the action part of the route name the controller method name is generated
+     * @param string $action
+     * @return string
+     */
+    private function buildActionName(string $action): string {
+        return $this->underScoreToCamelCase($action);
+    }
+
+    /**
+     * Underscored strings are converted to camel case strings
+     * @param string $str
+     * @return string
+     */
+    private function underScoreToCamelCase(string $str): string {
+        $pattern = '/_[a-z]?/';
+        return preg_replace_callback(
+            $pattern,
+            function ($matches) {
+                return strtoupper(ltrim($matches[0], '_'));
+            },
+            $str);
+    }
 }

Spacing +19 added lines, -19 removed lines

@@ -80,7 +80,7 @@ 
 		 * OCS routes go into a different collection
 		 */
 		$oldCollection = $this->router->getCurrentCollection();
-		$this->router->useCollection($oldCollection . '.ocs');
+		$this->router->useCollection($oldCollection.'.ocs');
 
 		// parse ocs simple routes
 		$this->processOCS($this->routes);
@@ -96,9 +96,9 @@ 
 		foreach ($ocsRoutes as $ocsRoute) {
 			$name = $ocsRoute['name'];
 			$postfix = $ocsRoute['postfix'] ?? '';
-			$root = $ocsRoute['root'] ?? '/apps/' . $this->appName;
+			$root = $ocsRoute['root'] ?? '/apps/'.$this->appName;
 
-			$url = $root . $ocsRoute['url'];
+			$url = $root.$ocsRoute['url'];
 			$verb = strtoupper($ocsRoute['verb'] ?? 'GET');
 
 			$split = explode('#', $name, 2);
@@ -110,7 +110,7 @@ 
 			$controllerName = $this->buildControllerName($controller);
 			$actionName = $this->buildActionName($action);
 
-			$routeName = 'ocs.' . $this->appName . '.' . $controller . '.' . $action . $postfix;
+			$routeName = 'ocs.'.$this->appName.'.'.$controller.'.'.$action.$postfix;
 
 			// register the route
 			$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
@@ -121,13 +121,13 @@ 
 
 			// optionally register requirements for route. This is used to
 			// tell the route parser how url parameters should be matched
-			if(array_key_exists('requirements', $ocsRoute)) {
+			if (array_key_exists('requirements', $ocsRoute)) {
 				$router->requirements($ocsRoute['requirements']);
 			}
 
 			// optionally register defaults for route. This is used to
 			// tell the route parser how url parameters should be default valued
-			if(array_key_exists('defaults', $ocsRoute)) {
+			if (array_key_exists('defaults', $ocsRoute)) {
 				$router->defaults($ocsRoute['defaults']);
 			}
 		}
@@ -156,7 +156,7 @@ 
 			$controllerName = $this->buildControllerName($controller);
 			$actionName = $this->buildActionName($action);
 
-			$routeName = $this->appName . '.' . $controller . '.' . $action . $postfix;
+			$routeName = $this->appName.'.'.$controller.'.'.$action.$postfix;
 
 			// register the route
 			$handler = new RouteActionHandler($this->container, $controllerName, $actionName);
@@ -166,13 +166,13 @@ 
 
 			// optionally register requirements for route. This is used to
 			// tell the route parser how url parameters should be matched
-			if(array_key_exists('requirements', $simpleRoute)) {
+			if (array_key_exists('requirements', $simpleRoute)) {
 				$router->requirements($simpleRoute['requirements']);
 			}
 
 			// optionally register defaults for route. This is used to
 			// tell the route parser how url parameters should be default valued
-			if(array_key_exists('defaults', $simpleRoute)) {
+			if (array_key_exists('defaults', $simpleRoute)) {
 				$router->defaults($simpleRoute['defaults']);
 			}
 		}
@@ -200,11 +200,11 @@ 
 
 		$resources = $routes['ocs-resources'] ?? [];
 		foreach ($resources as $resource => $config) {
-			$root = $config['root'] ?? '/apps/' . $this->appName;
+			$root = $config['root'] ?? '/apps/'.$this->appName;
 
 			// the url parameter used as id to the resource
-			foreach($actions as $action) {
-				$url = $root . $config['url'];
+			foreach ($actions as $action) {
+				$url = $root.$config['url'];
 				$method = $action['name'];
 				$verb = strtoupper($action['verb'] ?? 'GET');
 				$collectionAction = $action['on-collection'] ?? false;
@@ -212,7 +212,7 @@ 
 					$url .= '/{id}';
 				}
 				if (isset($action['url-postfix'])) {
-					$url .= '/' . $action['url-postfix'];
+					$url .= '/'.$action['url-postfix'];
 				}
 
 				$controller = $resource;
@@ -220,7 +220,7 @@ 
 				$controllerName = $this->buildControllerName($controller);
 				$actionName = $this->buildActionName($method);
 
-				$routeName = 'ocs.' . $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
+				$routeName = 'ocs.'.$this->appName.'.'.strtolower($resource).'.'.strtolower($method);
 
 				$this->router->create($routeName, $url)->method($verb)->action(
 					new RouteActionHandler($this->container, $controllerName, $actionName)
@@ -253,7 +253,7 @@ 
 		foreach ($resources as $resource => $config) {
 
 			// the url parameter used as id to the resource
-			foreach($actions as $action) {
+			foreach ($actions as $action) {
 				$url = $config['url'];
 				$method = $action['name'];
 				$verb = strtoupper($action['verb'] ?? 'GET');
@@ -262,7 +262,7 @@ 
 					$url .= '/{id}';
 				}
 				if (isset($action['url-postfix'])) {
-					$url .= '/' . $action['url-postfix'];
+					$url .= '/'.$action['url-postfix'];
 				}
 
 				$controller = $resource;
@@ -270,7 +270,7 @@ 
 				$controllerName = $this->buildControllerName($controller);
 				$actionName = $this->buildActionName($method);
 
-				$routeName = $this->appName . '.' . strtolower($resource) . '.' . strtolower($method);
+				$routeName = $this->appName.'.'.strtolower($resource).'.'.strtolower($method);
 
 				$this->router->create($routeName, $url)->method($verb)->action(
 					new RouteActionHandler($this->container, $controllerName, $actionName)
@@ -286,7 +286,7 @@ 
 	 */
 	private function buildControllerName(string $controller): string {
 		if (!isset($this->controllerNameCache[$controller])) {
-			$this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)) . 'Controller';
+			$this->controllerNameCache[$controller] = $this->underScoreToCamelCase(ucfirst($controller)).'Controller';
 		}
 		return $this->controllerNameCache[$controller];
 	}
@@ -309,7 +309,7 @@ 
 		$pattern = '/_[a-z]?/';
 		return preg_replace_callback(
 			$pattern,
-			function ($matches) {
+			function($matches) {
 				return strtoupper(ltrim($matches[0], '_'));
 			},
 			$str);