Merge pull request #5802 from nextcloud/rm_dep_controller_functions
Remove deprecated Controller Functions
This commit is contained in:
Lukas Reschke
GitHub
commit
1c1ff82c06
|
|
@ -32,7 +32,6 @@
|
||||||
|
|
||||||
namespace OCP\AppFramework;
|
namespace OCP\AppFramework;
|
||||||
|
|
||||||
use OCP\AppFramework\Http\TemplateResponse;
|
|
||||||
use OCP\AppFramework\Http\JSONResponse;
|
use OCP\AppFramework\Http\JSONResponse;
|
||||||
use OCP\AppFramework\Http\DataResponse;
|
use OCP\AppFramework\Http\DataResponse;
|
||||||
use OCP\AppFramework\Http\Response;
|
use OCP\AppFramework\Http\Response;
|
||||||
|
|
@ -102,6 +101,7 @@ abstract class Controller {
|
||||||
/**
|
/**
|
||||||
* Parses an HTTP accept header and returns the supported responder type
|
* Parses an HTTP accept header and returns the supported responder type
|
||||||
* @param string $acceptHeader
|
* @param string $acceptHeader
|
||||||
|
* @param string $default
|
||||||
* @return string the responder type
|
* @return string the responder type
|
||||||
* @since 7.0.0
|
* @since 7.0.0
|
||||||
* @since 9.1.0 Added default parameter
|
* @since 9.1.0 Added default parameter
|
||||||
|
|
@ -156,108 +156,4 @@ abstract class Controller {
|
||||||
throw new \DomainException('No responder registered for format '.
|
throw new \DomainException('No responder registered for format '.
|
||||||
$format . '!');
|
$format . '!');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Lets you access post and get parameters by the index
|
|
||||||
* @deprecated 7.0.0 write your parameters as method arguments instead
|
|
||||||
* @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 string $default If the key is not found, this value will be returned
|
|
||||||
* @return mixed the content of the array
|
|
||||||
* @since 6.0.0
|
|
||||||
*/
|
|
||||||
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 through the URL by the route
|
|
||||||
* @deprecated 7.0.0 use $this->request instead
|
|
||||||
* @return array the array with all parameters
|
|
||||||
* @since 6.0.0
|
|
||||||
*/
|
|
||||||
public function getParams() {
|
|
||||||
return $this->request->getParams();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the method of the request
|
|
||||||
* @deprecated 7.0.0 use $this->request instead
|
|
||||||
* @return string the method of the request (POST, GET, etc)
|
|
||||||
* @since 6.0.0
|
|
||||||
*/
|
|
||||||
public function method() {
|
|
||||||
return $this->request->getMethod();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Shortcut for accessing an uploaded file through the $_FILES array
|
|
||||||
* @deprecated 7.0.0 use $this->request instead
|
|
||||||
* @param string $key the key that will be taken from the $_FILES array
|
|
||||||
* @return array the file in the $_FILES element
|
|
||||||
* @since 6.0.0
|
|
||||||
*/
|
|
||||||
public function getUploadedFile($key) {
|
|
||||||
return $this->request->getUploadedFile($key);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Shortcut for getting env variables
|
|
||||||
* @deprecated 7.0.0 use $this->request instead
|
|
||||||
* @param string $key the key that will be taken from the $_ENV array
|
|
||||||
* @return array the value in the $_ENV element
|
|
||||||
* @since 6.0.0
|
|
||||||
*/
|
|
||||||
public function env($key) {
|
|
||||||
return $this->request->getEnv($key);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Shortcut for getting cookie variables
|
|
||||||
* @deprecated 7.0.0 use $this->request instead
|
|
||||||
* @param string $key the key that will be taken from the $_COOKIE array
|
|
||||||
* @return array the value in the $_COOKIE element
|
|
||||||
* @since 6.0.0
|
|
||||||
*/
|
|
||||||
public function cookie($key) {
|
|
||||||
return $this->request->getCookie($key);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Shortcut for rendering a template
|
|
||||||
* @deprecated 7.0.0 return a template response instead
|
|
||||||
* @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 string[] $headers set additional headers in name/value pairs
|
|
||||||
* @return \OCP\AppFramework\Http\TemplateResponse containing the page
|
|
||||||
* @since 6.0.0
|
|
||||||
*/
|
|
||||||
public function render($templateName, array $params=array(),
|
|
||||||
$renderAs='user', array $headers=array()){
|
|
||||||
$response = new TemplateResponse($this->appName, $templateName);
|
|
||||||
$response->setParams($params);
|
|
||||||
$response->renderAs($renderAs);
|
|
||||||
|
|
||||||
foreach($headers as $name => $value){
|
|
||||||
$response->addHeader($name, $value);
|
|
||||||
}
|
|
||||||
|
|
||||||
return $response;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -95,75 +95,6 @@ class ControllerTest extends \Test\TestCase {
|
||||||
$this->controller = new ChildController($this->app, $request);
|
$this->controller = new ChildController($this->app, $request);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
public function testParamsGet(){
|
|
||||||
$this->assertEquals('Johnny Weissmüller', $this->controller->params('name', 'Tarzan'));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public function testParamsGetDefault(){
|
|
||||||
$this->assertEquals('Tarzan', $this->controller->params('Ape Man', 'Tarzan'));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public function testParamsFile(){
|
|
||||||
$this->assertEquals('filevalue', $this->controller->params('file', 'filevalue'));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public function testGetUploadedFile(){
|
|
||||||
$this->assertEquals('filevalue', $this->controller->getUploadedFile('file'));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
public function testGetUploadedFileDefault(){
|
|
||||||
$this->assertEquals('default', $this->controller->params('files', 'default'));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public function testGetParams(){
|
|
||||||
$params = array(
|
|
||||||
'name' => 'Johnny Weissmüller',
|
|
||||||
'nickname' => 'Janey',
|
|
||||||
);
|
|
||||||
|
|
||||||
$this->assertEquals($params, $this->controller->getParams());
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public function testRender(){
|
|
||||||
$this->assertTrue($this->controller->render('') instanceof TemplateResponse);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public function testSetParams(){
|
|
||||||
$params = array('john' => 'foo');
|
|
||||||
$response = $this->controller->render('home', $params);
|
|
||||||
|
|
||||||
$this->assertEquals($params, $response->getParams());
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public function testRenderHeaders(){
|
|
||||||
$headers = array('one', 'two');
|
|
||||||
$response = $this->controller->render('', array(), '', $headers);
|
|
||||||
|
|
||||||
$this->assertTrue(in_array($headers[0], $response->getHeaders()));
|
|
||||||
$this->assertTrue(in_array($headers[1], $response->getHeaders()));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public function testGetRequestMethod(){
|
|
||||||
$this->assertEquals('hi', $this->controller->method());
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
public function testGetEnvVariable(){
|
|
||||||
$this->assertEquals('daheim', $this->controller->env('PATH'));
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @expectedException \DomainException
|
* @expectedException \DomainException
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue