nextcloud / server

lib/private/AppFramework/App.php

Indentation +133 added lines, -133 removed lines

@@ -45,143 +45,143 @@
  */
 class App {
 
-	/** @var string[] */
-	private static $nameSpaceCache = [];
-
-	/**
-	 * Turns an app id into a namespace by either reading the appinfo.xml's
-	 * namespace tag or uppercasing the appid's first letter
-	 * @param string $appId the app id
-	 * @param string $topNamespace the namespace which should be prepended to
-	 * the transformed app id, defaults to OCA\
-	 * @return string the starting namespace for the app
-	 */
-	public static function buildAppNamespace(string $appId, string $topNamespace='OCA\\'): string {
-		// Hit the cache!
-		if (isset(self::$nameSpaceCache[$appId])) {
-			return $topNamespace . self::$nameSpaceCache[$appId];
-		}
-
-		$appInfo = \OC_App::getAppInfo($appId);
-		if (isset($appInfo['namespace'])) {
-			self::$nameSpaceCache[$appId] = trim($appInfo['namespace']);
-		} else {
-			// if the tag is not found, fall back to uppercasing the first letter
-			self::$nameSpaceCache[$appId] = ucfirst($appId);
-		}
-
-		return $topNamespace . self::$nameSpaceCache[$appId];
-	}
-
-
-	/**
-	 * Shortcut for calling a controller method and printing the result
-	 * @param string $controllerName the name of the controller under which it is
-	 *                               stored in the DI container
-	 * @param string $methodName the method that you want to call
-	 * @param DIContainer $container an instance of a pimple container.
-	 * @param array $urlParams list of URL parameters (optional)
-	 */
-	public static function main(string $controllerName, string $methodName, DIContainer $container, array $urlParams = null) {
-		if (!is_null($urlParams)) {
-			$container[IRequest::class]->setUrlParameters($urlParams);
-		} else if (isset($container['urlParams']) && !is_null($container['urlParams'])) {
-			$container[IRequest::class]->setUrlParameters($container['urlParams']);
-		}
-		$appName = $container['AppName'];
-
-		// first try $controllerName then go for \OCA\AppName\Controller\$controllerName
-		try {
-			$controller = $container->query($controllerName);
-		} catch(QueryException $e) {
-			if ($appName === 'core') {
-				$appNameSpace = 'OC\\Core';
-			} else if ($appName === 'settings') {
-				$appNameSpace = 'OC\\Settings';
-			} else {
-				$appNameSpace = self::buildAppNamespace($appName);
-			}
-			$controllerName = $appNameSpace . '\\Controller\\' . $controllerName;
-			$controller = $container->query($controllerName);
-		}
-
-		// initialize the dispatcher and run all the middleware before the controller
-		/** @var Dispatcher $dispatcher */
-		$dispatcher = $container['Dispatcher'];
-
-		list(
-			$httpHeaders,
-			$responseHeaders,
-			$responseCookies,
-			$output,
-			$response
-		) = $dispatcher->dispatch($controller, $methodName);
-
-		$io = $container[IOutput::class];
-
-		if(!is_null($httpHeaders)) {
-			$io->setHeader($httpHeaders);
-		}
-
-		foreach($responseHeaders as $name => $value) {
-			$io->setHeader($name . ': ' . $value);
-		}
-
-		foreach($responseCookies as $name => $value) {
-			$expireDate = null;
-			if($value['expireDate'] instanceof \DateTime) {
-				$expireDate = $value['expireDate']->getTimestamp();
-			}
-			$io->setCookie(
-				$name,
-				$value['value'],
-				$expireDate,
-				$container->getServer()->getWebRoot(),
-				null,
-				$container->getServer()->getRequest()->getServerProtocol() === 'https',
-				true
-			);
-		}
-
-		/*
+    /** @var string[] */
+    private static $nameSpaceCache = [];
+
+    /**
+     * Turns an app id into a namespace by either reading the appinfo.xml's
+     * namespace tag or uppercasing the appid's first letter
+     * @param string $appId the app id
+     * @param string $topNamespace the namespace which should be prepended to
+     * the transformed app id, defaults to OCA\
+     * @return string the starting namespace for the app
+     */
+    public static function buildAppNamespace(string $appId, string $topNamespace='OCA\\'): string {
+        // Hit the cache!
+        if (isset(self::$nameSpaceCache[$appId])) {
+            return $topNamespace . self::$nameSpaceCache[$appId];
+        }
+
+        $appInfo = \OC_App::getAppInfo($appId);
+        if (isset($appInfo['namespace'])) {
+            self::$nameSpaceCache[$appId] = trim($appInfo['namespace']);
+        } else {
+            // if the tag is not found, fall back to uppercasing the first letter
+            self::$nameSpaceCache[$appId] = ucfirst($appId);
+        }
+
+        return $topNamespace . self::$nameSpaceCache[$appId];
+    }
+
+
+    /**
+     * Shortcut for calling a controller method and printing the result
+     * @param string $controllerName the name of the controller under which it is
+     *                               stored in the DI container
+     * @param string $methodName the method that you want to call
+     * @param DIContainer $container an instance of a pimple container.
+     * @param array $urlParams list of URL parameters (optional)
+     */
+    public static function main(string $controllerName, string $methodName, DIContainer $container, array $urlParams = null) {
+        if (!is_null($urlParams)) {
+            $container[IRequest::class]->setUrlParameters($urlParams);
+        } else if (isset($container['urlParams']) && !is_null($container['urlParams'])) {
+            $container[IRequest::class]->setUrlParameters($container['urlParams']);
+        }
+        $appName = $container['AppName'];
+
+        // first try $controllerName then go for \OCA\AppName\Controller\$controllerName
+        try {
+            $controller = $container->query($controllerName);
+        } catch(QueryException $e) {
+            if ($appName === 'core') {
+                $appNameSpace = 'OC\\Core';
+            } else if ($appName === 'settings') {
+                $appNameSpace = 'OC\\Settings';
+            } else {
+                $appNameSpace = self::buildAppNamespace($appName);
+            }
+            $controllerName = $appNameSpace . '\\Controller\\' . $controllerName;
+            $controller = $container->query($controllerName);
+        }
+
+        // initialize the dispatcher and run all the middleware before the controller
+        /** @var Dispatcher $dispatcher */
+        $dispatcher = $container['Dispatcher'];
+
+        list(
+            $httpHeaders,
+            $responseHeaders,
+            $responseCookies,
+            $output,
+            $response
+        ) = $dispatcher->dispatch($controller, $methodName);
+
+        $io = $container[IOutput::class];
+
+        if(!is_null($httpHeaders)) {
+            $io->setHeader($httpHeaders);
+        }
+
+        foreach($responseHeaders as $name => $value) {
+            $io->setHeader($name . ': ' . $value);
+        }
+
+        foreach($responseCookies as $name => $value) {
+            $expireDate = null;
+            if($value['expireDate'] instanceof \DateTime) {
+                $expireDate = $value['expireDate']->getTimestamp();
+            }
+            $io->setCookie(
+                $name,
+                $value['value'],
+                $expireDate,
+                $container->getServer()->getWebRoot(),
+                null,
+                $container->getServer()->getRequest()->getServerProtocol() === 'https',
+                true
+            );
+        }
+
+        /*
 		 * Status 204 does not have a body and no Content Length
 		 * Status 304 does not have a body and does not need a Content Length
 		 * https://tools.ietf.org/html/rfc7230#section-3.3
 		 * https://tools.ietf.org/html/rfc7230#section-3.3.2
 		 */
-		if ($httpHeaders !== Http::STATUS_NO_CONTENT && $httpHeaders !== Http::STATUS_NOT_MODIFIED) {
-			if ($response instanceof ICallbackResponse) {
-				$response->callback($io);
-			} else if (!is_null($output)) {
-				$io->setHeader('Content-Length: ' . strlen($output));
-				$io->setOutput($output);
-			}
-		}
-
-	}
-
-	/**
-	 * Shortcut for calling a controller method and printing the result.
-	 * Similar to App:main except that no headers will be sent.
-	 * This should be used for example when registering sections via
-	 * \OC\AppFramework\Core\API::registerAdmin()
-	 *
-	 * @param string $controllerName the name of the controller under which it is
-	 *                               stored in the DI container
-	 * @param string $methodName the method that you want to call
-	 * @param array $urlParams an array with variables extracted from the routes
-	 * @param DIContainer $container an instance of a pimple container.
-	 */
-	public static function part(string $controllerName, string $methodName, array $urlParams,
-								DIContainer $container){
-
-		$container['urlParams'] = $urlParams;
-		$controller = $container[$controllerName];
-
-		$dispatcher = $container['Dispatcher'];
-
-		list(, , $output) =  $dispatcher->dispatch($controller, $methodName);
-		return $output;
-	}
+        if ($httpHeaders !== Http::STATUS_NO_CONTENT && $httpHeaders !== Http::STATUS_NOT_MODIFIED) {
+            if ($response instanceof ICallbackResponse) {
+                $response->callback($io);
+            } else if (!is_null($output)) {
+                $io->setHeader('Content-Length: ' . strlen($output));
+                $io->setOutput($output);
+            }
+        }
+
+    }
+
+    /**
+     * Shortcut for calling a controller method and printing the result.
+     * Similar to App:main except that no headers will be sent.
+     * This should be used for example when registering sections via
+     * \OC\AppFramework\Core\API::registerAdmin()
+     *
+     * @param string $controllerName the name of the controller under which it is
+     *                               stored in the DI container
+     * @param string $methodName the method that you want to call
+     * @param array $urlParams an array with variables extracted from the routes
+     * @param DIContainer $container an instance of a pimple container.
+     */
+    public static function part(string $controllerName, string $methodName, array $urlParams,
+                                DIContainer $container){
+
+        $container['urlParams'] = $urlParams;
+        $controller = $container[$controllerName];
+
+        $dispatcher = $container['Dispatcher'];
+
+        list(, , $output) =  $dispatcher->dispatch($controller, $methodName);
+        return $output;
+    }
 
 }

lib/public/AppFramework/App.php

Indentation +86 added lines, -86 removed lines

@@ -47,96 +47,96 @@
  */
 class App {
 
-	/** @var IAppContainer */
-	private $container;
+    /** @var IAppContainer */
+    private $container;
 
-	/**
-	 * Turns an app id into a namespace by convetion. The id is split at the
-	 * underscores, all parts are camelcased and reassembled. e.g.:
-	 * some_app_id -> OCA\SomeAppId
-	 * @param string $appId the app id
-	 * @param string $topNamespace the namespace which should be prepended to
-	 * the transformed app id, defaults to OCA\
-	 * @return string the starting namespace for the app
-	 * @since 8.0.0
-	 */
-	public static function buildAppNamespace(string $appId, string $topNamespace='OCA\\'): string {
-		return \OC\AppFramework\App::buildAppNamespace($appId, $topNamespace);
-	}
+    /**
+     * Turns an app id into a namespace by convetion. The id is split at the
+     * underscores, all parts are camelcased and reassembled. e.g.:
+     * some_app_id -> OCA\SomeAppId
+     * @param string $appId the app id
+     * @param string $topNamespace the namespace which should be prepended to
+     * the transformed app id, defaults to OCA\
+     * @return string the starting namespace for the app
+     * @since 8.0.0
+     */
+    public static function buildAppNamespace(string $appId, string $topNamespace='OCA\\'): string {
+        return \OC\AppFramework\App::buildAppNamespace($appId, $topNamespace);
+    }
 
 
-	/**
-	 * @param array $urlParams an array with variables extracted from the routes
-	 * @since 6.0.0
-	 */
-	public function __construct(string $appName, array $urlParams = []) {
-		$this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName, $urlParams);
-	}
+    /**
+     * @param array $urlParams an array with variables extracted from the routes
+     * @since 6.0.0
+     */
+    public function __construct(string $appName, array $urlParams = []) {
+        $this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName, $urlParams);
+    }
 
-	/**
-	 * @return IAppContainer
-	 * @since 6.0.0
-	 */
-	public function getContainer(): IAppContainer {
-		return $this->container;
-	}
+    /**
+     * @return IAppContainer
+     * @since 6.0.0
+     */
+    public function getContainer(): IAppContainer {
+        return $this->container;
+    }
 
-	/**
-	 * This function is to be called to create single routes and restful routes based on the given $routes array.
-	 *
-	 * Example code in routes.php of tasks app (it will register two restful resources):
-	 * $routes = array(
-	 *		'resources' => array(
-	 *		'lists' => array('url' => '/tasklists'),
-	 *		'tasks' => array('url' => '/tasklists/{listId}/tasks')
-	 *	)
-	 *	);
-	 *
-	 * $a = new TasksApp();
-	 * $a->registerRoutes($this, $routes);
-	 *
-	 * @param \OCP\Route\IRouter $router
-	 * @param array $routes
-	 * @since 6.0.0
-	 * @suppress PhanAccessMethodInternal
-	 */
-	public function registerRoutes(IRouter $router, array $routes) {
-		$routeConfig = new RouteConfig($this->container, $router, $routes);
-		$routeConfig->register();
-	}
+    /**
+     * This function is to be called to create single routes and restful routes based on the given $routes array.
+     *
+     * Example code in routes.php of tasks app (it will register two restful resources):
+     * $routes = array(
+     *		'resources' => array(
+     *		'lists' => array('url' => '/tasklists'),
+     *		'tasks' => array('url' => '/tasklists/{listId}/tasks')
+     *	)
+     *	);
+     *
+     * $a = new TasksApp();
+     * $a->registerRoutes($this, $routes);
+     *
+     * @param \OCP\Route\IRouter $router
+     * @param array $routes
+     * @since 6.0.0
+     * @suppress PhanAccessMethodInternal
+     */
+    public function registerRoutes(IRouter $router, array $routes) {
+        $routeConfig = new RouteConfig($this->container, $router, $routes);
+        $routeConfig->register();
+    }
 
-	/**
-	 * This function is called by the routing component to fire up the frameworks dispatch mechanism.
-	 *
-	 * Example code in routes.php of the task app:
-	 * $this->create('tasks_index', '/')->get()->action(
-	 *		function($params){
-	 *			$app = new TaskApp($params);
-	 *			$app->dispatch('PageController', 'index');
-	 *		}
-	 *	);
-	 *
-	 *
-	 * Example for for TaskApp implementation:
-	 * class TaskApp extends \OCP\AppFramework\App {
-	 *
-	 *		public function __construct($params){
-	 *			parent::__construct('tasks', $params);
-	 *
-	 *			$this->getContainer()->registerService('PageController', function(IAppContainer $c){
-	 *				$a = $c->query('API');
-	 *				$r = $c->query('Request');
-	 *				return new PageController($a, $r);
-	 *			});
-	 *		}
-	 *	}
-	 *
-	 * @param string $controllerName the name of the controller under which it is
-	 *                               stored in the DI container
-	 * @param string $methodName the method that you want to call
-	 * @since 6.0.0
-	 */
-	public function dispatch(string $controllerName, string $methodName) {
-		\OC\AppFramework\App::main($controllerName, $methodName, $this->container);
-	}
+    /**
+     * This function is called by the routing component to fire up the frameworks dispatch mechanism.
+     *
+     * Example code in routes.php of the task app:
+     * $this->create('tasks_index', '/')->get()->action(
+     *		function($params){
+     *			$app = new TaskApp($params);
+     *			$app->dispatch('PageController', 'index');
+     *		}
+     *	);
+     *
+     *
+     * Example for for TaskApp implementation:
+     * class TaskApp extends \OCP\AppFramework\App {
+     *
+     *		public function __construct($params){
+     *			parent::__construct('tasks', $params);
+     *
+     *			$this->getContainer()->registerService('PageController', function(IAppContainer $c){
+     *				$a = $c->query('API');
+     *				$r = $c->query('Request');
+     *				return new PageController($a, $r);
+     *			});
+     *		}
+     *	}
+     *
+     * @param string $controllerName the name of the controller under which it is
+     *                               stored in the DI container
+     * @param string $methodName the method that you want to call
+     * @since 6.0.0
+     */
+    public function dispatch(string $controllerName, string $methodName) {
+        \OC\AppFramework\App::main($controllerName, $methodName, $this->container);
+    }
 }