123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181 |
- <?php
- declare(strict_types=1);
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Bernhard Posselt <dev@bernhard-posselt.com>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Julius Härtl <jus@bitgrid.net>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Thomas Tanghus <thomas@tanghus.net>
- *
- * @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/>
- *
- */
- /**
- * Public interface of ownCloud for apps to use.
- * AppFramework/App class
- */
- namespace OCP\AppFramework;
- use OC\AppFramework\Routing\RouteConfig;
- use OC\ServerContainer;
- use OCP\Route\IRouter;
- /**
- * Class App
- * @package OCP\AppFramework
- *
- * Any application must inherit this call - all controller instances to be used are
- * to be registered using IContainer::registerService
- * @since 6.0.0
- */
- class App {
- /** @var IAppContainer */
- private $container;
- /**
- * Turns an app id into a namespace by convention. 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 string $appName
- * @param array $urlParams an array with variables extracted from the routes
- * @since 6.0.0
- */
- public function __construct(string $appName, array $urlParams = []) {
- if (\OC::$server->getConfig()->getSystemValueBool('debug')) {
- $applicationClassName = get_class($this);
- $e = new \RuntimeException('App class ' . $applicationClassName . ' is not setup via query() but directly');
- $setUpViaQuery = false;
- $classNameParts = explode('\\', trim($applicationClassName, '\\'));
- foreach ($e->getTrace() as $step) {
- if (isset($step['class'], $step['function'], $step['args'][0]) &&
- $step['class'] === ServerContainer::class &&
- $step['function'] === 'query' &&
- $step['args'][0] === $applicationClassName) {
- $setUpViaQuery = true;
- break;
- } else if (isset($step['class'], $step['function'], $step['args'][0]) &&
- $step['class'] === ServerContainer::class &&
- $step['function'] === 'getAppContainer' &&
- $step['args'][1] === $classNameParts[1]) {
- $setUpViaQuery = true;
- break;
- }
- }
- if (!$setUpViaQuery && $applicationClassName !== \OCP\AppFramework\App::class) {
- \OC::$server->getLogger()->logException($e, [
- 'app' => $appName,
- ]);
- }
- }
- try {
- $this->container = \OC::$server->getRegisteredAppContainer($appName);
- } catch (QueryException $e) {
- $this->container = new \OC\AppFramework\DependencyInjection\DIContainer($appName, $urlParams);
- }
- }
- /**
- * @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 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);
- }
- }
|