nextcloud/lib/public/irequest.php

97 lines
2.7 KiB
PHP
Raw Normal View History

2013-08-20 19:53:58 +04:00
<?php
/**
2013-08-31 03:41:24 +04:00
* ownCloud
*
* @author Thomas Müller
* @copyright 2013 Thomas Müller deepdiver@owncloud.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/>.
*
2013-08-20 19:53:58 +04:00
*/
namespace OCP;
2013-08-20 19:53:58 +04:00
interface IRequest {
function getHeader($name);
/**
* Lets you access post and get parameters by the index
* In case of json requests the encoded json body is accessed
*
* @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 getParam($key, $default = null);
/**
* Returns all params that were received, be it from the request
2013-08-31 22:57:16 +04:00
*
2013-08-21 02:58:33 +04:00
* (as GET or POST) or through the URL by the route
2013-08-20 19:53:58 +04:00
* @return array the array with all parameters
*/
public function getParams();
/**
* Returns the method of the request
2013-08-31 22:57:16 +04:00
*
2013-08-20 19:53:58 +04:00
* @return string the method of the request (POST, GET, etc)
*/
public function getMethod();
/**
* Shortcut for accessing an uploaded file through the $_FILES array
2013-08-31 22:57:16 +04:00
*
2013-08-20 19:53:58 +04:00
* @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);
/**
* Shortcut for getting env variables
2013-08-31 22:57:16 +04:00
*
2013-08-20 19:53:58 +04:00
* @param string $key the key that will be taken from the $_ENV array
* @return array the value in the $_ENV element
*/
public function getEnv($key);
/**
* Shortcut for getting cookie variables
2013-08-31 22:57:16 +04:00
*
2013-08-20 19:53:58 +04:00
* @param string $key the key that will be taken from the $_COOKIE array
* @return array the value in the $_COOKIE element
*/
function getCookie($key);
/**
* Returns the request body content.
*
* @param Boolean $asResource If true, a resource will be returned
* @return string|resource The request body content or a resource to read the body stream.
* @throws \LogicException
*/
function getContent($asResource = false);
}