@@ -34,38 +34,38 @@ |
||
34 | 34 | */ |
35 | 35 | interface IControllerMethodReflector { |
36 | 36 | |
37 | - /** |
|
38 | - * @param object $object an object or classname |
|
39 | - * @param string $method the method which we want to inspect |
|
40 | - * @return void |
|
41 | - * @since 8.0.0 |
|
42 | - */ |
|
43 | - public function reflect($object, $method); |
|
37 | + /** |
|
38 | + * @param object $object an object or classname |
|
39 | + * @param string $method the method which we want to inspect |
|
40 | + * @return void |
|
41 | + * @since 8.0.0 |
|
42 | + */ |
|
43 | + public function reflect($object, $method); |
|
44 | 44 | |
45 | - /** |
|
46 | - * Inspects the PHPDoc parameters for types |
|
47 | - * |
|
48 | - * @param string $parameter the parameter whose type comments should be |
|
49 | - * parsed |
|
50 | - * @return string|null type in the type parameters (@param int $something) |
|
51 | - * would return int or null if not existing |
|
52 | - * @since 8.0.0 |
|
53 | - */ |
|
54 | - public function getType($parameter); |
|
45 | + /** |
|
46 | + * Inspects the PHPDoc parameters for types |
|
47 | + * |
|
48 | + * @param string $parameter the parameter whose type comments should be |
|
49 | + * parsed |
|
50 | + * @return string|null type in the type parameters (@param int $something) |
|
51 | + * would return int or null if not existing |
|
52 | + * @since 8.0.0 |
|
53 | + */ |
|
54 | + public function getType($parameter); |
|
55 | 55 | |
56 | - /** |
|
57 | - * @return array the arguments of the method with key => default value |
|
58 | - * @since 8.0.0 |
|
59 | - */ |
|
60 | - public function getParameters(); |
|
56 | + /** |
|
57 | + * @return array the arguments of the method with key => default value |
|
58 | + * @since 8.0.0 |
|
59 | + */ |
|
60 | + public function getParameters(); |
|
61 | 61 | |
62 | - /** |
|
63 | - * Check if a method contains an annotation |
|
64 | - * |
|
65 | - * @param string $name the name of the annotation |
|
66 | - * @return bool true if the annotation is found |
|
67 | - * @since 8.0.0 |
|
68 | - */ |
|
69 | - public function hasAnnotation($name); |
|
62 | + /** |
|
63 | + * Check if a method contains an annotation |
|
64 | + * |
|
65 | + * @param string $name the name of the annotation |
|
66 | + * @return bool true if the annotation is found |
|
67 | + * @since 8.0.0 |
|
68 | + */ |
|
69 | + public function hasAnnotation($name); |
|
70 | 70 | |
71 | 71 | } |
@@ -42,73 +42,73 @@ |
||
42 | 42 | */ |
43 | 43 | abstract class OCSController extends ApiController { |
44 | 44 | |
45 | - /** @var int */ |
|
46 | - private $ocsVersion; |
|
45 | + /** @var int */ |
|
46 | + private $ocsVersion; |
|
47 | 47 | |
48 | - /** |
|
49 | - * constructor of the controller |
|
50 | - * @param string $appName the name of the app |
|
51 | - * @param IRequest $request an instance of the request |
|
52 | - * @param string $corsMethods comma separated string of HTTP verbs which |
|
53 | - * should be allowed for websites or webapps when calling your API, defaults to |
|
54 | - * 'PUT, POST, GET, DELETE, PATCH' |
|
55 | - * @param string $corsAllowedHeaders comma separated string of HTTP headers |
|
56 | - * which should be allowed for websites or webapps when calling your API, |
|
57 | - * defaults to 'Authorization, Content-Type, Accept' |
|
58 | - * @param int $corsMaxAge number in seconds how long a preflighted OPTIONS |
|
59 | - * request should be cached, defaults to 1728000 seconds |
|
60 | - * @since 8.1.0 |
|
61 | - */ |
|
62 | - public function __construct($appName, |
|
63 | - IRequest $request, |
|
64 | - $corsMethods='PUT, POST, GET, DELETE, PATCH', |
|
65 | - $corsAllowedHeaders='Authorization, Content-Type, Accept', |
|
66 | - $corsMaxAge=1728000){ |
|
67 | - parent::__construct($appName, $request, $corsMethods, |
|
68 | - $corsAllowedHeaders, $corsMaxAge); |
|
69 | - $this->registerResponder('json', function ($data) { |
|
70 | - return $this->buildOCSResponse('json', $data); |
|
71 | - }); |
|
72 | - $this->registerResponder('xml', function ($data) { |
|
73 | - return $this->buildOCSResponse('xml', $data); |
|
74 | - }); |
|
75 | - } |
|
48 | + /** |
|
49 | + * constructor of the controller |
|
50 | + * @param string $appName the name of the app |
|
51 | + * @param IRequest $request an instance of the request |
|
52 | + * @param string $corsMethods comma separated string of HTTP verbs which |
|
53 | + * should be allowed for websites or webapps when calling your API, defaults to |
|
54 | + * 'PUT, POST, GET, DELETE, PATCH' |
|
55 | + * @param string $corsAllowedHeaders comma separated string of HTTP headers |
|
56 | + * which should be allowed for websites or webapps when calling your API, |
|
57 | + * defaults to 'Authorization, Content-Type, Accept' |
|
58 | + * @param int $corsMaxAge number in seconds how long a preflighted OPTIONS |
|
59 | + * request should be cached, defaults to 1728000 seconds |
|
60 | + * @since 8.1.0 |
|
61 | + */ |
|
62 | + public function __construct($appName, |
|
63 | + IRequest $request, |
|
64 | + $corsMethods='PUT, POST, GET, DELETE, PATCH', |
|
65 | + $corsAllowedHeaders='Authorization, Content-Type, Accept', |
|
66 | + $corsMaxAge=1728000){ |
|
67 | + parent::__construct($appName, $request, $corsMethods, |
|
68 | + $corsAllowedHeaders, $corsMaxAge); |
|
69 | + $this->registerResponder('json', function ($data) { |
|
70 | + return $this->buildOCSResponse('json', $data); |
|
71 | + }); |
|
72 | + $this->registerResponder('xml', function ($data) { |
|
73 | + return $this->buildOCSResponse('xml', $data); |
|
74 | + }); |
|
75 | + } |
|
76 | 76 | |
77 | - /** |
|
78 | - * @param int $version |
|
79 | - * @since 11.0.0 |
|
80 | - * @internal |
|
81 | - */ |
|
82 | - public function setOCSVersion($version) { |
|
83 | - $this->ocsVersion = $version; |
|
84 | - } |
|
77 | + /** |
|
78 | + * @param int $version |
|
79 | + * @since 11.0.0 |
|
80 | + * @internal |
|
81 | + */ |
|
82 | + public function setOCSVersion($version) { |
|
83 | + $this->ocsVersion = $version; |
|
84 | + } |
|
85 | 85 | |
86 | - /** |
|
87 | - * Since the OCS endpoints default to XML we need to find out the format |
|
88 | - * again |
|
89 | - * @param mixed $response the value that was returned from a controller and |
|
90 | - * is not a Response instance |
|
91 | - * @param string $format the format for which a formatter has been registered |
|
92 | - * @throws \DomainException if format does not match a registered formatter |
|
93 | - * @return Response |
|
94 | - * @since 9.1.0 |
|
95 | - */ |
|
96 | - public function buildResponse($response, $format = 'xml') { |
|
97 | - return parent::buildResponse($response, $format); |
|
98 | - } |
|
86 | + /** |
|
87 | + * Since the OCS endpoints default to XML we need to find out the format |
|
88 | + * again |
|
89 | + * @param mixed $response the value that was returned from a controller and |
|
90 | + * is not a Response instance |
|
91 | + * @param string $format the format for which a formatter has been registered |
|
92 | + * @throws \DomainException if format does not match a registered formatter |
|
93 | + * @return Response |
|
94 | + * @since 9.1.0 |
|
95 | + */ |
|
96 | + public function buildResponse($response, $format = 'xml') { |
|
97 | + return parent::buildResponse($response, $format); |
|
98 | + } |
|
99 | 99 | |
100 | - /** |
|
101 | - * Unwrap data and build ocs response |
|
102 | - * @param string $format json or xml |
|
103 | - * @param DataResponse $data the data which should be transformed |
|
104 | - * @since 8.1.0 |
|
105 | - * @return \OC\AppFramework\OCS\BaseResponse |
|
106 | - */ |
|
107 | - private function buildOCSResponse($format, DataResponse $data) { |
|
108 | - if ($this->ocsVersion === 1) { |
|
109 | - return new \OC\AppFramework\OCS\V1Response($data, $format); |
|
110 | - } |
|
111 | - return new \OC\AppFramework\OCS\V2Response($data, $format); |
|
112 | - } |
|
100 | + /** |
|
101 | + * Unwrap data and build ocs response |
|
102 | + * @param string $format json or xml |
|
103 | + * @param DataResponse $data the data which should be transformed |
|
104 | + * @since 8.1.0 |
|
105 | + * @return \OC\AppFramework\OCS\BaseResponse |
|
106 | + */ |
|
107 | + private function buildOCSResponse($format, DataResponse $data) { |
|
108 | + if ($this->ocsVersion === 1) { |
|
109 | + return new \OC\AppFramework\OCS\V1Response($data, $format); |
|
110 | + } |
|
111 | + return new \OC\AppFramework\OCS\V2Response($data, $format); |
|
112 | + } |
|
113 | 113 | |
114 | 114 | } |
@@ -36,27 +36,27 @@ |
||
36 | 36 | */ |
37 | 37 | class RedirectResponse extends Response { |
38 | 38 | |
39 | - private $redirectURL; |
|
40 | - |
|
41 | - /** |
|
42 | - * Creates a response that redirects to a url |
|
43 | - * @param string $redirectURL the url to redirect to |
|
44 | - * @since 7.0.0 |
|
45 | - */ |
|
46 | - public function __construct($redirectURL) { |
|
47 | - $this->redirectURL = $redirectURL; |
|
48 | - $this->setStatus(Http::STATUS_SEE_OTHER); |
|
49 | - $this->addHeader('Location', $redirectURL); |
|
50 | - } |
|
51 | - |
|
52 | - |
|
53 | - /** |
|
54 | - * @return string the url to redirect |
|
55 | - * @since 7.0.0 |
|
56 | - */ |
|
57 | - public function getRedirectURL() { |
|
58 | - return $this->redirectURL; |
|
59 | - } |
|
39 | + private $redirectURL; |
|
40 | + |
|
41 | + /** |
|
42 | + * Creates a response that redirects to a url |
|
43 | + * @param string $redirectURL the url to redirect to |
|
44 | + * @since 7.0.0 |
|
45 | + */ |
|
46 | + public function __construct($redirectURL) { |
|
47 | + $this->redirectURL = $redirectURL; |
|
48 | + $this->setStatus(Http::STATUS_SEE_OTHER); |
|
49 | + $this->addHeader('Location', $redirectURL); |
|
50 | + } |
|
51 | + |
|
52 | + |
|
53 | + /** |
|
54 | + * @return string the url to redirect |
|
55 | + * @since 7.0.0 |
|
56 | + */ |
|
57 | + public function getRedirectURL() { |
|
58 | + return $this->redirectURL; |
|
59 | + } |
|
60 | 60 | |
61 | 61 | |
62 | 62 | } |
@@ -39,63 +39,63 @@ |
||
39 | 39 | */ |
40 | 40 | class JSONResponse extends Response { |
41 | 41 | |
42 | - /** |
|
43 | - * response data |
|
44 | - * @var array|object |
|
45 | - */ |
|
46 | - protected $data; |
|
42 | + /** |
|
43 | + * response data |
|
44 | + * @var array|object |
|
45 | + */ |
|
46 | + protected $data; |
|
47 | 47 | |
48 | 48 | |
49 | - /** |
|
50 | - * constructor of JSONResponse |
|
51 | - * @param array|object $data the object or array that should be transformed |
|
52 | - * @param int $statusCode the Http status code, defaults to 200 |
|
53 | - * @since 6.0.0 |
|
54 | - */ |
|
55 | - public function __construct($data=array(), $statusCode=Http::STATUS_OK) { |
|
56 | - $this->data = $data; |
|
57 | - $this->setStatus($statusCode); |
|
58 | - $this->addHeader('Content-Type', 'application/json; charset=utf-8'); |
|
59 | - } |
|
49 | + /** |
|
50 | + * constructor of JSONResponse |
|
51 | + * @param array|object $data the object or array that should be transformed |
|
52 | + * @param int $statusCode the Http status code, defaults to 200 |
|
53 | + * @since 6.0.0 |
|
54 | + */ |
|
55 | + public function __construct($data=array(), $statusCode=Http::STATUS_OK) { |
|
56 | + $this->data = $data; |
|
57 | + $this->setStatus($statusCode); |
|
58 | + $this->addHeader('Content-Type', 'application/json; charset=utf-8'); |
|
59 | + } |
|
60 | 60 | |
61 | 61 | |
62 | - /** |
|
63 | - * Returns the rendered json |
|
64 | - * @return string the rendered json |
|
65 | - * @since 6.0.0 |
|
66 | - * @throws \Exception If data could not get encoded |
|
67 | - */ |
|
68 | - public function render() { |
|
69 | - $response = json_encode($this->data, JSON_HEX_TAG); |
|
70 | - if($response === false) { |
|
71 | - throw new \Exception(sprintf('Could not json_encode due to invalid ' . |
|
72 | - 'non UTF-8 characters in the array: %s', var_export($this->data, true))); |
|
73 | - } |
|
62 | + /** |
|
63 | + * Returns the rendered json |
|
64 | + * @return string the rendered json |
|
65 | + * @since 6.0.0 |
|
66 | + * @throws \Exception If data could not get encoded |
|
67 | + */ |
|
68 | + public function render() { |
|
69 | + $response = json_encode($this->data, JSON_HEX_TAG); |
|
70 | + if($response === false) { |
|
71 | + throw new \Exception(sprintf('Could not json_encode due to invalid ' . |
|
72 | + 'non UTF-8 characters in the array: %s', var_export($this->data, true))); |
|
73 | + } |
|
74 | 74 | |
75 | - return $response; |
|
76 | - } |
|
75 | + return $response; |
|
76 | + } |
|
77 | 77 | |
78 | - /** |
|
79 | - * Sets values in the data json array |
|
80 | - * @param array|object $data an array or object which will be transformed |
|
81 | - * to JSON |
|
82 | - * @return JSONResponse Reference to this object |
|
83 | - * @since 6.0.0 - return value was added in 7.0.0 |
|
84 | - */ |
|
85 | - public function setData($data){ |
|
86 | - $this->data = $data; |
|
78 | + /** |
|
79 | + * Sets values in the data json array |
|
80 | + * @param array|object $data an array or object which will be transformed |
|
81 | + * to JSON |
|
82 | + * @return JSONResponse Reference to this object |
|
83 | + * @since 6.0.0 - return value was added in 7.0.0 |
|
84 | + */ |
|
85 | + public function setData($data){ |
|
86 | + $this->data = $data; |
|
87 | 87 | |
88 | - return $this; |
|
89 | - } |
|
88 | + return $this; |
|
89 | + } |
|
90 | 90 | |
91 | 91 | |
92 | - /** |
|
93 | - * Used to get the set parameters |
|
94 | - * @return array the data |
|
95 | - * @since 6.0.0 |
|
96 | - */ |
|
97 | - public function getData(){ |
|
98 | - return $this->data; |
|
99 | - } |
|
92 | + /** |
|
93 | + * Used to get the set parameters |
|
94 | + * @return array the data |
|
95 | + * @since 6.0.0 |
|
96 | + */ |
|
97 | + public function getData(){ |
|
98 | + return $this->data; |
|
99 | + } |
|
100 | 100 | |
101 | 101 | } |
@@ -37,48 +37,48 @@ |
||
37 | 37 | */ |
38 | 38 | class DataResponse extends Response { |
39 | 39 | |
40 | - /** |
|
41 | - * response data |
|
42 | - * @var array|object |
|
43 | - */ |
|
44 | - protected $data; |
|
40 | + /** |
|
41 | + * response data |
|
42 | + * @var array|object |
|
43 | + */ |
|
44 | + protected $data; |
|
45 | 45 | |
46 | 46 | |
47 | - /** |
|
48 | - * @param array|object $data the object or array that should be transformed |
|
49 | - * @param int $statusCode the Http status code, defaults to 200 |
|
50 | - * @param array $headers additional key value based headers |
|
51 | - * @since 8.0.0 |
|
52 | - */ |
|
53 | - public function __construct($data=array(), $statusCode=Http::STATUS_OK, |
|
54 | - array $headers=array()) { |
|
55 | - $this->data = $data; |
|
56 | - $this->setStatus($statusCode); |
|
57 | - $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
|
58 | - } |
|
47 | + /** |
|
48 | + * @param array|object $data the object or array that should be transformed |
|
49 | + * @param int $statusCode the Http status code, defaults to 200 |
|
50 | + * @param array $headers additional key value based headers |
|
51 | + * @since 8.0.0 |
|
52 | + */ |
|
53 | + public function __construct($data=array(), $statusCode=Http::STATUS_OK, |
|
54 | + array $headers=array()) { |
|
55 | + $this->data = $data; |
|
56 | + $this->setStatus($statusCode); |
|
57 | + $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
|
58 | + } |
|
59 | 59 | |
60 | 60 | |
61 | - /** |
|
62 | - * Sets values in the data json array |
|
63 | - * @param array|object $data an array or object which will be transformed |
|
64 | - * @return DataResponse Reference to this object |
|
65 | - * @since 8.0.0 |
|
66 | - */ |
|
67 | - public function setData($data){ |
|
68 | - $this->data = $data; |
|
61 | + /** |
|
62 | + * Sets values in the data json array |
|
63 | + * @param array|object $data an array or object which will be transformed |
|
64 | + * @return DataResponse Reference to this object |
|
65 | + * @since 8.0.0 |
|
66 | + */ |
|
67 | + public function setData($data){ |
|
68 | + $this->data = $data; |
|
69 | 69 | |
70 | - return $this; |
|
71 | - } |
|
70 | + return $this; |
|
71 | + } |
|
72 | 72 | |
73 | 73 | |
74 | - /** |
|
75 | - * Used to get the set parameters |
|
76 | - * @return array the data |
|
77 | - * @since 8.0.0 |
|
78 | - */ |
|
79 | - public function getData(){ |
|
80 | - return $this->data; |
|
81 | - } |
|
74 | + /** |
|
75 | + * Used to get the set parameters |
|
76 | + * @return array the data |
|
77 | + * @since 8.0.0 |
|
78 | + */ |
|
79 | + public function getData(){ |
|
80 | + return $this->data; |
|
81 | + } |
|
82 | 82 | |
83 | 83 | |
84 | 84 | } |
@@ -29,36 +29,36 @@ |
||
29 | 29 | * @since 8.0.0 |
30 | 30 | */ |
31 | 31 | class DataDownloadResponse extends DownloadResponse { |
32 | - /** |
|
33 | - * @var string |
|
34 | - */ |
|
35 | - private $data; |
|
32 | + /** |
|
33 | + * @var string |
|
34 | + */ |
|
35 | + private $data; |
|
36 | 36 | |
37 | - /** |
|
38 | - * Creates a response that prompts the user to download the text |
|
39 | - * @param string $data text to be downloaded |
|
40 | - * @param string $filename the name that the downloaded file should have |
|
41 | - * @param string $contentType the mimetype that the downloaded file should have |
|
42 | - * @since 8.0.0 |
|
43 | - */ |
|
44 | - public function __construct($data, $filename, $contentType) { |
|
45 | - $this->data = $data; |
|
46 | - parent::__construct($filename, $contentType); |
|
47 | - } |
|
37 | + /** |
|
38 | + * Creates a response that prompts the user to download the text |
|
39 | + * @param string $data text to be downloaded |
|
40 | + * @param string $filename the name that the downloaded file should have |
|
41 | + * @param string $contentType the mimetype that the downloaded file should have |
|
42 | + * @since 8.0.0 |
|
43 | + */ |
|
44 | + public function __construct($data, $filename, $contentType) { |
|
45 | + $this->data = $data; |
|
46 | + parent::__construct($filename, $contentType); |
|
47 | + } |
|
48 | 48 | |
49 | - /** |
|
50 | - * @param string $data |
|
51 | - * @since 8.0.0 |
|
52 | - */ |
|
53 | - public function setData($data) { |
|
54 | - $this->data = $data; |
|
55 | - } |
|
49 | + /** |
|
50 | + * @param string $data |
|
51 | + * @since 8.0.0 |
|
52 | + */ |
|
53 | + public function setData($data) { |
|
54 | + $this->data = $data; |
|
55 | + } |
|
56 | 56 | |
57 | - /** |
|
58 | - * @return string |
|
59 | - * @since 8.0.0 |
|
60 | - */ |
|
61 | - public function render() { |
|
62 | - return $this->data; |
|
63 | - } |
|
57 | + /** |
|
58 | + * @return string |
|
59 | + * @since 8.0.0 |
|
60 | + */ |
|
61 | + public function render() { |
|
62 | + return $this->data; |
|
63 | + } |
|
64 | 64 | } |
@@ -32,38 +32,38 @@ |
||
32 | 32 | */ |
33 | 33 | class FileDisplayResponse extends Response implements ICallbackResponse { |
34 | 34 | |
35 | - /** @var \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile */ |
|
36 | - private $file; |
|
35 | + /** @var \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile */ |
|
36 | + private $file; |
|
37 | 37 | |
38 | - /** |
|
39 | - * FileDisplayResponse constructor. |
|
40 | - * |
|
41 | - * @param \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile $file |
|
42 | - * @param int $statusCode |
|
43 | - * @param array $headers |
|
44 | - * @since 11.0.0 |
|
45 | - */ |
|
46 | - public function __construct($file, $statusCode=Http::STATUS_OK, |
|
47 | - $headers=[]) { |
|
48 | - $this->file = $file; |
|
49 | - $this->setStatus($statusCode); |
|
50 | - $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
|
51 | - $this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"'); |
|
38 | + /** |
|
39 | + * FileDisplayResponse constructor. |
|
40 | + * |
|
41 | + * @param \OCP\Files\File|\OCP\Files\SimpleFS\ISimpleFile $file |
|
42 | + * @param int $statusCode |
|
43 | + * @param array $headers |
|
44 | + * @since 11.0.0 |
|
45 | + */ |
|
46 | + public function __construct($file, $statusCode=Http::STATUS_OK, |
|
47 | + $headers=[]) { |
|
48 | + $this->file = $file; |
|
49 | + $this->setStatus($statusCode); |
|
50 | + $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
|
51 | + $this->addHeader('Content-Disposition', 'inline; filename="' . rawurldecode($file->getName()) . '"'); |
|
52 | 52 | |
53 | - $this->setETag($file->getEtag()); |
|
54 | - $lastModified = new \DateTime(); |
|
55 | - $lastModified->setTimestamp($file->getMTime()); |
|
56 | - $this->setLastModified($lastModified); |
|
57 | - } |
|
53 | + $this->setETag($file->getEtag()); |
|
54 | + $lastModified = new \DateTime(); |
|
55 | + $lastModified->setTimestamp($file->getMTime()); |
|
56 | + $this->setLastModified($lastModified); |
|
57 | + } |
|
58 | 58 | |
59 | - /** |
|
60 | - * @param IOutput $output |
|
61 | - * @since 11.0.0 |
|
62 | - */ |
|
63 | - public function callback(IOutput $output) { |
|
64 | - if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) { |
|
65 | - $output->setHeader('Content-Length: ' . $this->file->getSize()); |
|
66 | - $output->setOutput($this->file->getContent()); |
|
67 | - } |
|
68 | - } |
|
59 | + /** |
|
60 | + * @param IOutput $output |
|
61 | + * @since 11.0.0 |
|
62 | + */ |
|
63 | + public function callback(IOutput $output) { |
|
64 | + if ($output->getHttpResponseCode() !== Http::STATUS_NOT_MODIFIED) { |
|
65 | + $output->setHeader('Content-Length: ' . $this->file->getSize()); |
|
66 | + $output->setOutput($this->file->getContent()); |
|
67 | + } |
|
68 | + } |
|
69 | 69 | } |
@@ -32,19 +32,19 @@ |
||
32 | 32 | */ |
33 | 33 | class NotFoundResponse extends Response { |
34 | 34 | |
35 | - /** |
|
36 | - * @since 8.1.0 |
|
37 | - */ |
|
38 | - public function __construct() { |
|
39 | - $this->setStatus(404); |
|
40 | - } |
|
35 | + /** |
|
36 | + * @since 8.1.0 |
|
37 | + */ |
|
38 | + public function __construct() { |
|
39 | + $this->setStatus(404); |
|
40 | + } |
|
41 | 41 | |
42 | - /** |
|
43 | - * @return string |
|
44 | - * @since 8.1.0 |
|
45 | - */ |
|
46 | - public function render() { |
|
47 | - $template = new Template('core', '404', 'guest'); |
|
48 | - return $template->fetchPage(); |
|
49 | - } |
|
42 | + /** |
|
43 | + * @return string |
|
44 | + * @since 8.1.0 |
|
45 | + */ |
|
46 | + public function render() { |
|
47 | + $template = new Template('core', '404', 'guest'); |
|
48 | + return $template->fetchPage(); |
|
49 | + } |
|
50 | 50 | } |
@@ -37,124 +37,124 @@ |
||
37 | 37 | */ |
38 | 38 | class TemplateResponse extends Response { |
39 | 39 | |
40 | - /** |
|
41 | - * name of the template |
|
42 | - * @var string |
|
43 | - */ |
|
44 | - protected $templateName; |
|
45 | - |
|
46 | - /** |
|
47 | - * parameters |
|
48 | - * @var array |
|
49 | - */ |
|
50 | - protected $params; |
|
51 | - |
|
52 | - /** |
|
53 | - * rendering type (admin, user, blank) |
|
54 | - * @var string |
|
55 | - */ |
|
56 | - protected $renderAs; |
|
57 | - |
|
58 | - /** |
|
59 | - * app name |
|
60 | - * @var string |
|
61 | - */ |
|
62 | - protected $appName; |
|
63 | - |
|
64 | - /** |
|
65 | - * constructor of TemplateResponse |
|
66 | - * @param string $appName the name of the app to load the template from |
|
67 | - * @param string $templateName the name of the template |
|
68 | - * @param array $params an array of parameters which should be passed to the |
|
69 | - * template |
|
70 | - * @param string $renderAs how the page should be rendered, defaults to user |
|
71 | - * @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0 |
|
72 | - */ |
|
73 | - public function __construct($appName, $templateName, array $params=array(), |
|
74 | - $renderAs='user') { |
|
75 | - $this->templateName = $templateName; |
|
76 | - $this->appName = $appName; |
|
77 | - $this->params = $params; |
|
78 | - $this->renderAs = $renderAs; |
|
79 | - } |
|
80 | - |
|
81 | - |
|
82 | - /** |
|
83 | - * Sets template parameters |
|
84 | - * @param array $params an array with key => value structure which sets template |
|
85 | - * variables |
|
86 | - * @return TemplateResponse Reference to this object |
|
87 | - * @since 6.0.0 - return value was added in 7.0.0 |
|
88 | - */ |
|
89 | - public function setParams(array $params){ |
|
90 | - $this->params = $params; |
|
91 | - |
|
92 | - return $this; |
|
93 | - } |
|
94 | - |
|
95 | - |
|
96 | - /** |
|
97 | - * Used for accessing the set parameters |
|
98 | - * @return array the params |
|
99 | - * @since 6.0.0 |
|
100 | - */ |
|
101 | - public function getParams(){ |
|
102 | - return $this->params; |
|
103 | - } |
|
104 | - |
|
105 | - |
|
106 | - /** |
|
107 | - * Used for accessing the name of the set template |
|
108 | - * @return string the name of the used template |
|
109 | - * @since 6.0.0 |
|
110 | - */ |
|
111 | - public function getTemplateName(){ |
|
112 | - return $this->templateName; |
|
113 | - } |
|
114 | - |
|
115 | - |
|
116 | - /** |
|
117 | - * Sets the template page |
|
118 | - * @param string $renderAs admin, user or blank. Admin also prints the admin |
|
119 | - * settings header and footer, user renders the normal |
|
120 | - * normal page including footer and header and blank |
|
121 | - * just renders the plain template |
|
122 | - * @return TemplateResponse Reference to this object |
|
123 | - * @since 6.0.0 - return value was added in 7.0.0 |
|
124 | - */ |
|
125 | - public function renderAs($renderAs){ |
|
126 | - $this->renderAs = $renderAs; |
|
127 | - |
|
128 | - return $this; |
|
129 | - } |
|
130 | - |
|
131 | - |
|
132 | - /** |
|
133 | - * Returns the set renderAs |
|
134 | - * @return string the renderAs value |
|
135 | - * @since 6.0.0 |
|
136 | - */ |
|
137 | - public function getRenderAs(){ |
|
138 | - return $this->renderAs; |
|
139 | - } |
|
140 | - |
|
141 | - |
|
142 | - /** |
|
143 | - * Returns the rendered html |
|
144 | - * @return string the rendered html |
|
145 | - * @since 6.0.0 |
|
146 | - */ |
|
147 | - public function render(){ |
|
148 | - // \OCP\Template needs an empty string instead of 'blank' for an unwrapped response |
|
149 | - $renderAs = $this->renderAs === 'blank' ? '' : $this->renderAs; |
|
150 | - |
|
151 | - $template = new \OCP\Template($this->appName, $this->templateName, $renderAs); |
|
152 | - |
|
153 | - foreach($this->params as $key => $value){ |
|
154 | - $template->assign($key, $value); |
|
155 | - } |
|
156 | - |
|
157 | - return $template->fetchPage(); |
|
158 | - } |
|
40 | + /** |
|
41 | + * name of the template |
|
42 | + * @var string |
|
43 | + */ |
|
44 | + protected $templateName; |
|
45 | + |
|
46 | + /** |
|
47 | + * parameters |
|
48 | + * @var array |
|
49 | + */ |
|
50 | + protected $params; |
|
51 | + |
|
52 | + /** |
|
53 | + * rendering type (admin, user, blank) |
|
54 | + * @var string |
|
55 | + */ |
|
56 | + protected $renderAs; |
|
57 | + |
|
58 | + /** |
|
59 | + * app name |
|
60 | + * @var string |
|
61 | + */ |
|
62 | + protected $appName; |
|
63 | + |
|
64 | + /** |
|
65 | + * constructor of TemplateResponse |
|
66 | + * @param string $appName the name of the app to load the template from |
|
67 | + * @param string $templateName the name of the template |
|
68 | + * @param array $params an array of parameters which should be passed to the |
|
69 | + * template |
|
70 | + * @param string $renderAs how the page should be rendered, defaults to user |
|
71 | + * @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0 |
|
72 | + */ |
|
73 | + public function __construct($appName, $templateName, array $params=array(), |
|
74 | + $renderAs='user') { |
|
75 | + $this->templateName = $templateName; |
|
76 | + $this->appName = $appName; |
|
77 | + $this->params = $params; |
|
78 | + $this->renderAs = $renderAs; |
|
79 | + } |
|
80 | + |
|
81 | + |
|
82 | + /** |
|
83 | + * Sets template parameters |
|
84 | + * @param array $params an array with key => value structure which sets template |
|
85 | + * variables |
|
86 | + * @return TemplateResponse Reference to this object |
|
87 | + * @since 6.0.0 - return value was added in 7.0.0 |
|
88 | + */ |
|
89 | + public function setParams(array $params){ |
|
90 | + $this->params = $params; |
|
91 | + |
|
92 | + return $this; |
|
93 | + } |
|
94 | + |
|
95 | + |
|
96 | + /** |
|
97 | + * Used for accessing the set parameters |
|
98 | + * @return array the params |
|
99 | + * @since 6.0.0 |
|
100 | + */ |
|
101 | + public function getParams(){ |
|
102 | + return $this->params; |
|
103 | + } |
|
104 | + |
|
105 | + |
|
106 | + /** |
|
107 | + * Used for accessing the name of the set template |
|
108 | + * @return string the name of the used template |
|
109 | + * @since 6.0.0 |
|
110 | + */ |
|
111 | + public function getTemplateName(){ |
|
112 | + return $this->templateName; |
|
113 | + } |
|
114 | + |
|
115 | + |
|
116 | + /** |
|
117 | + * Sets the template page |
|
118 | + * @param string $renderAs admin, user or blank. Admin also prints the admin |
|
119 | + * settings header and footer, user renders the normal |
|
120 | + * normal page including footer and header and blank |
|
121 | + * just renders the plain template |
|
122 | + * @return TemplateResponse Reference to this object |
|
123 | + * @since 6.0.0 - return value was added in 7.0.0 |
|
124 | + */ |
|
125 | + public function renderAs($renderAs){ |
|
126 | + $this->renderAs = $renderAs; |
|
127 | + |
|
128 | + return $this; |
|
129 | + } |
|
130 | + |
|
131 | + |
|
132 | + /** |
|
133 | + * Returns the set renderAs |
|
134 | + * @return string the renderAs value |
|
135 | + * @since 6.0.0 |
|
136 | + */ |
|
137 | + public function getRenderAs(){ |
|
138 | + return $this->renderAs; |
|
139 | + } |
|
140 | + |
|
141 | + |
|
142 | + /** |
|
143 | + * Returns the rendered html |
|
144 | + * @return string the rendered html |
|
145 | + * @since 6.0.0 |
|
146 | + */ |
|
147 | + public function render(){ |
|
148 | + // \OCP\Template needs an empty string instead of 'blank' for an unwrapped response |
|
149 | + $renderAs = $this->renderAs === 'blank' ? '' : $this->renderAs; |
|
150 | + |
|
151 | + $template = new \OCP\Template($this->appName, $this->templateName, $renderAs); |
|
152 | + |
|
153 | + foreach($this->params as $key => $value){ |
|
154 | + $template->assign($key, $value); |
|
155 | + } |
|
156 | + |
|
157 | + return $template->fetchPage(); |
|
158 | + } |
|
159 | 159 | |
160 | 160 | } |