move controller to OCP

1 files changed, 147 insertions, 0 deletions

diff --git a/lib/public/appframework/controller/controller.php b/lib/public/appframework/controller/controller.php
new file mode 100644
index 00000000000..a832f89df42
--- /dev/null
+++ b/lib/public/appframework/controller/controller.php
@@ -0,0 +1,147 @@
+<?php
+
+/**
+ * ownCloud - App Framework
+ *
+ * @author Bernhard Posselt
+ * @copyright 2012 Bernhard Posselt nukeawhale@gmail.com
+ *
+ * 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 OCP\AppFramework\Controller;
+
+use OC\AppFramework\Http\Request;
+use OC\AppFramework\Core\API;
+use OCP\AppFramework\Http\TemplateResponse;
+use OCP\AppFramework\IAppContainer;
+use OCP\IRequest;
+
+
+/**
+ * Base class to inherit your controllers from
+ */
+abstract class Controller {
+
+	/**
+	 * @var \OCP\AppFramework\IAppContainer
+	 */
+	protected $app;
+
+	/**
+	 * @var \OCP\IRequest
+	 */
+	protected $request;
+
+	/**
+	 * @param IAppContainer $app interface to the app
+	 * @param IRequest $request an instance of the request
+	 */
+	public function __construct(IAppContainer $app, IRequest $request){
+		$this->app = $app;
+		$this->request = $request;
+	}
+
+
+	/**
+	 * Lets you access post and get parameters by the index
+	 * @param string $key the key which you want to access in the URL Parameter
+	 *                     placeholder, $_POST or $_GET array.
+	 *                     The priority how they're returned is the following:
+	 *                     1. URL parameters
+	 *                     2. POST parameters
+	 *                     3. GET parameters
+	 * @param mixed $default If the key is not found, this value will be returned
+	 * @return mixed the content of the array
+	 */
+	public function params($key, $default=null){
+		return $this->request->getParam($key, $default);
+	}
+
+
+	/**
+	 * Returns all params that were received, be it from the request
+	 * (as GET or POST) or throuh the URL by the route
+	 * @return array the array with all parameters
+	 */
+	public function getParams() {
+		return $this->request->getParams();
+	}
+
+
+	/**
+	 * Returns the method of the request
+	 * @return string the method of the request (POST, GET, etc)
+	 */
+	public function method() {
+		return $this->request->getMethod();
+	}
+
+
+	/**
+	 * Shortcut for accessing an uploaded file through the $_FILES array
+	 * @param string $key the key that will be taken from the $_FILES array
+	 * @return array the file in the $_FILES element
+	 */
+	public function getUploadedFile($key) {
+		return $this->request->getUploadedFile($key);
+	}
+
+
+	/**
+	 * Shortcut for getting env variables
+	 * @param string $key the key that will be taken from the $_ENV array
+	 * @return array the value in the $_ENV element
+	 */
+	public function env($key) {
+		return $this->request->getEnv($key);
+	}
+
+
+	/**
+	 * Shortcut for getting cookie variables
+	 * @param string $key the key that will be taken from the $_COOKIE array
+	 * @return array the value in the $_COOKIE element
+	 */
+	public function cookie($key) {
+		return $this->request->getCookie($key);
+	}
+
+
+	/**
+	 * Shortcut for rendering a template
+	 * @param string $templateName the name of the template
+	 * @param array $params the template parameters in key => value structure
+	 * @param string $renderAs user renders a full page, blank only your template
+	 *                          admin an entry in the admin settings
+	 * @param array $headers set additional headers in name/value pairs
+	 * @return \OCP\AppFramework\Http\TemplateResponse containing the page
+	 */
+	public function render($templateName, array $params=array(),
+							$renderAs='user', array $headers=array()){
+		$response = new TemplateResponse($this->app->getAppName(), $templateName);
+		$response->setParams($params);
+		$response->renderAs($renderAs);
+
+		foreach($headers as $name => $value){
+			$response->addHeader($name, $value);
+		}
+
+		return $response;
+	}
+
+
+}