@@ -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 | } |
@@ -61,15 +61,15 @@ |
||
| 61 | 61 | */ |
| 62 | 62 | public function __construct($appName, |
| 63 | 63 | IRequest $request, |
| 64 | - $corsMethods='PUT, POST, GET, DELETE, PATCH', |
|
| 65 | - $corsAllowedHeaders='Authorization, Content-Type, Accept', |
|
| 66 | - $corsMaxAge=1728000){ |
|
| 64 | + $corsMethods = 'PUT, POST, GET, DELETE, PATCH', |
|
| 65 | + $corsAllowedHeaders = 'Authorization, Content-Type, Accept', |
|
| 66 | + $corsMaxAge = 1728000) { |
|
| 67 | 67 | parent::__construct($appName, $request, $corsMethods, |
| 68 | 68 | $corsAllowedHeaders, $corsMaxAge); |
| 69 | - $this->registerResponder('json', function ($data) { |
|
| 69 | + $this->registerResponder('json', function($data) { |
|
| 70 | 70 | return $this->buildOCSResponse('json', $data); |
| 71 | 71 | }); |
| 72 | - $this->registerResponder('xml', function ($data) { |
|
| 72 | + $this->registerResponder('xml', function($data) { |
|
| 73 | 73 | return $this->buildOCSResponse('xml', $data); |
| 74 | 74 | }); |
| 75 | 75 | } |
@@ -42,70 +42,70 @@ |
||
| 42 | 42 | */ |
| 43 | 43 | abstract class OCSController extends ApiController { |
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * constructor of the controller |
|
| 47 | - * @param string $appName the name of the app |
|
| 48 | - * @param IRequest $request an instance of the request |
|
| 49 | - * @param string $corsMethods comma separated string of HTTP verbs which |
|
| 50 | - * should be allowed for websites or webapps when calling your API, defaults to |
|
| 51 | - * 'PUT, POST, GET, DELETE, PATCH' |
|
| 52 | - * @param string $corsAllowedHeaders comma separated string of HTTP headers |
|
| 53 | - * which should be allowed for websites or webapps when calling your API, |
|
| 54 | - * defaults to 'Authorization, Content-Type, Accept' |
|
| 55 | - * @param int $corsMaxAge number in seconds how long a preflighted OPTIONS |
|
| 56 | - * request should be cached, defaults to 1728000 seconds |
|
| 57 | - * @since 8.1.0 |
|
| 58 | - */ |
|
| 59 | - public function __construct($appName, |
|
| 60 | - IRequest $request, |
|
| 61 | - $corsMethods='PUT, POST, GET, DELETE, PATCH', |
|
| 62 | - $corsAllowedHeaders='Authorization, Content-Type, Accept', |
|
| 63 | - $corsMaxAge=1728000){ |
|
| 64 | - parent::__construct($appName, $request, $corsMethods, |
|
| 65 | - $corsAllowedHeaders, $corsMaxAge); |
|
| 66 | - $this->registerResponder('json', function ($data) { |
|
| 67 | - return $this->buildOCSResponse('json', $data); |
|
| 68 | - }); |
|
| 69 | - $this->registerResponder('xml', function ($data) { |
|
| 70 | - return $this->buildOCSResponse('xml', $data); |
|
| 71 | - }); |
|
| 72 | - } |
|
| 45 | + /** |
|
| 46 | + * constructor of the controller |
|
| 47 | + * @param string $appName the name of the app |
|
| 48 | + * @param IRequest $request an instance of the request |
|
| 49 | + * @param string $corsMethods comma separated string of HTTP verbs which |
|
| 50 | + * should be allowed for websites or webapps when calling your API, defaults to |
|
| 51 | + * 'PUT, POST, GET, DELETE, PATCH' |
|
| 52 | + * @param string $corsAllowedHeaders comma separated string of HTTP headers |
|
| 53 | + * which should be allowed for websites or webapps when calling your API, |
|
| 54 | + * defaults to 'Authorization, Content-Type, Accept' |
|
| 55 | + * @param int $corsMaxAge number in seconds how long a preflighted OPTIONS |
|
| 56 | + * request should be cached, defaults to 1728000 seconds |
|
| 57 | + * @since 8.1.0 |
|
| 58 | + */ |
|
| 59 | + public function __construct($appName, |
|
| 60 | + IRequest $request, |
|
| 61 | + $corsMethods='PUT, POST, GET, DELETE, PATCH', |
|
| 62 | + $corsAllowedHeaders='Authorization, Content-Type, Accept', |
|
| 63 | + $corsMaxAge=1728000){ |
|
| 64 | + parent::__construct($appName, $request, $corsMethods, |
|
| 65 | + $corsAllowedHeaders, $corsMaxAge); |
|
| 66 | + $this->registerResponder('json', function ($data) { |
|
| 67 | + return $this->buildOCSResponse('json', $data); |
|
| 68 | + }); |
|
| 69 | + $this->registerResponder('xml', function ($data) { |
|
| 70 | + return $this->buildOCSResponse('xml', $data); |
|
| 71 | + }); |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * Since the OCS endpoints default to XML we need to find out the format |
|
| 76 | - * again |
|
| 77 | - * @param mixed $response the value that was returned from a controller and |
|
| 78 | - * is not a Response instance |
|
| 79 | - * @param string $format the format for which a formatter has been registered |
|
| 80 | - * @throws \DomainException if format does not match a registered formatter |
|
| 81 | - * @return Response |
|
| 82 | - * @since 9.1.0 |
|
| 83 | - */ |
|
| 84 | - public function buildResponse($response, $format = 'xml') { |
|
| 85 | - return parent::buildResponse($response, $format); |
|
| 86 | - } |
|
| 74 | + /** |
|
| 75 | + * Since the OCS endpoints default to XML we need to find out the format |
|
| 76 | + * again |
|
| 77 | + * @param mixed $response the value that was returned from a controller and |
|
| 78 | + * is not a Response instance |
|
| 79 | + * @param string $format the format for which a formatter has been registered |
|
| 80 | + * @throws \DomainException if format does not match a registered formatter |
|
| 81 | + * @return Response |
|
| 82 | + * @since 9.1.0 |
|
| 83 | + */ |
|
| 84 | + public function buildResponse($response, $format = 'xml') { |
|
| 85 | + return parent::buildResponse($response, $format); |
|
| 86 | + } |
|
| 87 | 87 | |
| 88 | - /** |
|
| 89 | - * Unwrap data and build ocs response |
|
| 90 | - * @param string $format json or xml |
|
| 91 | - * @param DataResponse $data the data which should be transformed |
|
| 92 | - * @since 8.1.0 |
|
| 93 | - * @return OCSResponse |
|
| 94 | - */ |
|
| 95 | - private function buildOCSResponse($format, DataResponse $data) { |
|
| 96 | - $params = [ |
|
| 97 | - 'statuscode' => 100, |
|
| 98 | - 'message' => 'OK', |
|
| 99 | - 'data' => $data->getData(), |
|
| 100 | - 'itemscount' => '', |
|
| 101 | - 'itemsperpage' => '' |
|
| 102 | - ]; |
|
| 88 | + /** |
|
| 89 | + * Unwrap data and build ocs response |
|
| 90 | + * @param string $format json or xml |
|
| 91 | + * @param DataResponse $data the data which should be transformed |
|
| 92 | + * @since 8.1.0 |
|
| 93 | + * @return OCSResponse |
|
| 94 | + */ |
|
| 95 | + private function buildOCSResponse($format, DataResponse $data) { |
|
| 96 | + $params = [ |
|
| 97 | + 'statuscode' => 100, |
|
| 98 | + 'message' => 'OK', |
|
| 99 | + 'data' => $data->getData(), |
|
| 100 | + 'itemscount' => '', |
|
| 101 | + 'itemsperpage' => '' |
|
| 102 | + ]; |
|
| 103 | 103 | |
| 104 | - return new OCSResponse( |
|
| 105 | - $format, $params['statuscode'], |
|
| 106 | - $params['message'], $params['data'], |
|
| 107 | - $params['itemscount'], $params['itemsperpage'] |
|
| 108 | - ); |
|
| 109 | - } |
|
| 104 | + return new OCSResponse( |
|
| 105 | + $format, $params['statuscode'], |
|
| 106 | + $params['message'], $params['data'], |
|
| 107 | + $params['itemscount'], $params['itemsperpage'] |
|
| 108 | + ); |
|
| 109 | + } |
|
| 110 | 110 | |
| 111 | 111 | } |
@@ -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 | } |
@@ -52,7 +52,7 @@ discard block |
||
| 52 | 52 | * @param int $statusCode the Http status code, defaults to 200 |
| 53 | 53 | * @since 6.0.0 |
| 54 | 54 | */ |
| 55 | - public function __construct($data=array(), $statusCode=Http::STATUS_OK) { |
|
| 55 | + public function __construct($data = array(), $statusCode = Http::STATUS_OK) { |
|
| 56 | 56 | $this->data = $data; |
| 57 | 57 | $this->setStatus($statusCode); |
| 58 | 58 | $this->addHeader('Content-Type', 'application/json; charset=utf-8'); |
@@ -67,8 +67,8 @@ discard block |
||
| 67 | 67 | */ |
| 68 | 68 | public function render() { |
| 69 | 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 ' . |
|
| 70 | + if ($response === false) { |
|
| 71 | + throw new \Exception(sprintf('Could not json_encode due to invalid '. |
|
| 72 | 72 | 'non UTF-8 characters in the array: %s', var_export($this->data, true))); |
| 73 | 73 | } |
| 74 | 74 | |
@@ -82,7 +82,7 @@ discard block |
||
| 82 | 82 | * @return JSONResponse Reference to this object |
| 83 | 83 | * @since 6.0.0 - return value was added in 7.0.0 |
| 84 | 84 | */ |
| 85 | - public function setData($data){ |
|
| 85 | + public function setData($data) { |
|
| 86 | 86 | $this->data = $data; |
| 87 | 87 | |
| 88 | 88 | return $this; |
@@ -94,7 +94,7 @@ discard block |
||
| 94 | 94 | * @return array the data |
| 95 | 95 | * @since 6.0.0 |
| 96 | 96 | */ |
| 97 | - public function getData(){ |
|
| 97 | + public function getData() { |
|
| 98 | 98 | return $this->data; |
| 99 | 99 | } |
| 100 | 100 | |
@@ -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 | } |
@@ -50,8 +50,8 @@ discard block |
||
| 50 | 50 | * @param array $headers additional key value based headers |
| 51 | 51 | * @since 8.0.0 |
| 52 | 52 | */ |
| 53 | - public function __construct($data=array(), $statusCode=Http::STATUS_OK, |
|
| 54 | - array $headers=array()) { |
|
| 53 | + public function __construct($data = array(), $statusCode = Http::STATUS_OK, |
|
| 54 | + array $headers = array()) { |
|
| 55 | 55 | $this->data = $data; |
| 56 | 56 | $this->setStatus($statusCode); |
| 57 | 57 | $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
@@ -64,7 +64,7 @@ discard block |
||
| 64 | 64 | * @return DataResponse Reference to this object |
| 65 | 65 | * @since 8.0.0 |
| 66 | 66 | */ |
| 67 | - public function setData($data){ |
|
| 67 | + public function setData($data) { |
|
| 68 | 68 | $this->data = $data; |
| 69 | 69 | |
| 70 | 70 | return $this; |
@@ -76,7 +76,7 @@ discard block |
||
| 76 | 76 | * @return array the data |
| 77 | 77 | * @since 8.0.0 |
| 78 | 78 | */ |
| 79 | - public function getData(){ |
|
| 79 | + public function getData() { |
|
| 80 | 80 | return $this->data; |
| 81 | 81 | } |
| 82 | 82 | |
@@ -33,12 +33,12 @@ |
||
| 33 | 33 | */ |
| 34 | 34 | interface ICallbackResponse { |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * Outputs the content that should be printed |
|
| 38 | - * |
|
| 39 | - * @param IOutput $output a small wrapper that handles output |
|
| 40 | - * @since 8.1.0 |
|
| 41 | - */ |
|
| 42 | - function callback(IOutput $output); |
|
| 36 | + /** |
|
| 37 | + * Outputs the content that should be printed |
|
| 38 | + * |
|
| 39 | + * @param IOutput $output a small wrapper that handles output |
|
| 40 | + * @since 8.1.0 |
|
| 41 | + */ |
|
| 42 | + function callback(IOutput $output); |
|
| 43 | 43 | |
| 44 | 44 | } |
@@ -33,57 +33,57 @@ |
||
| 33 | 33 | */ |
| 34 | 34 | class DataDisplayResponse extends Response { |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * response data |
|
| 38 | - * @var string; |
|
| 39 | - */ |
|
| 40 | - protected $data; |
|
| 36 | + /** |
|
| 37 | + * response data |
|
| 38 | + * @var string; |
|
| 39 | + */ |
|
| 40 | + protected $data; |
|
| 41 | 41 | |
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @param string $data the data to display |
|
| 45 | - * @param int $statusCode the Http status code, defaults to 200 |
|
| 46 | - * @param array $headers additional key value based headers |
|
| 47 | - * @since 8.1.0 |
|
| 48 | - */ |
|
| 49 | - public function __construct($data="", $statusCode=Http::STATUS_OK, |
|
| 50 | - $headers=[]) { |
|
| 51 | - $this->data = $data; |
|
| 52 | - $this->setStatus($statusCode); |
|
| 53 | - $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
|
| 54 | - $this->addHeader('Content-Disposition', 'inline; filename=""'); |
|
| 55 | - } |
|
| 43 | + /** |
|
| 44 | + * @param string $data the data to display |
|
| 45 | + * @param int $statusCode the Http status code, defaults to 200 |
|
| 46 | + * @param array $headers additional key value based headers |
|
| 47 | + * @since 8.1.0 |
|
| 48 | + */ |
|
| 49 | + public function __construct($data="", $statusCode=Http::STATUS_OK, |
|
| 50 | + $headers=[]) { |
|
| 51 | + $this->data = $data; |
|
| 52 | + $this->setStatus($statusCode); |
|
| 53 | + $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
|
| 54 | + $this->addHeader('Content-Disposition', 'inline; filename=""'); |
|
| 55 | + } |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * Outputs data. No processing is done. |
|
| 59 | - * @return string |
|
| 60 | - * @since 8.1.0 |
|
| 61 | - */ |
|
| 62 | - public function render() { |
|
| 63 | - return $this->data; |
|
| 64 | - } |
|
| 57 | + /** |
|
| 58 | + * Outputs data. No processing is done. |
|
| 59 | + * @return string |
|
| 60 | + * @since 8.1.0 |
|
| 61 | + */ |
|
| 62 | + public function render() { |
|
| 63 | + return $this->data; |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * Sets values in the data |
|
| 69 | - * @param string $data the data to display |
|
| 70 | - * @return DataDisplayResponse Reference to this object |
|
| 71 | - * @since 8.1.0 |
|
| 72 | - */ |
|
| 73 | - public function setData($data){ |
|
| 74 | - $this->data = $data; |
|
| 67 | + /** |
|
| 68 | + * Sets values in the data |
|
| 69 | + * @param string $data the data to display |
|
| 70 | + * @return DataDisplayResponse Reference to this object |
|
| 71 | + * @since 8.1.0 |
|
| 72 | + */ |
|
| 73 | + public function setData($data){ |
|
| 74 | + $this->data = $data; |
|
| 75 | 75 | |
| 76 | - return $this; |
|
| 77 | - } |
|
| 76 | + return $this; |
|
| 77 | + } |
|
| 78 | 78 | |
| 79 | 79 | |
| 80 | - /** |
|
| 81 | - * Used to get the set parameters |
|
| 82 | - * @return string the data |
|
| 83 | - * @since 8.1.0 |
|
| 84 | - */ |
|
| 85 | - public function getData(){ |
|
| 86 | - return $this->data; |
|
| 87 | - } |
|
| 80 | + /** |
|
| 81 | + * Used to get the set parameters |
|
| 82 | + * @return string the data |
|
| 83 | + * @since 8.1.0 |
|
| 84 | + */ |
|
| 85 | + public function getData(){ |
|
| 86 | + return $this->data; |
|
| 87 | + } |
|
| 88 | 88 | |
| 89 | 89 | } |
@@ -46,8 +46,8 @@ discard block |
||
| 46 | 46 | * @param array $headers additional key value based headers |
| 47 | 47 | * @since 8.1.0 |
| 48 | 48 | */ |
| 49 | - public function __construct($data="", $statusCode=Http::STATUS_OK, |
|
| 50 | - $headers=[]) { |
|
| 49 | + public function __construct($data = "", $statusCode = Http::STATUS_OK, |
|
| 50 | + $headers = []) { |
|
| 51 | 51 | $this->data = $data; |
| 52 | 52 | $this->setStatus($statusCode); |
| 53 | 53 | $this->setHeaders(array_merge($this->getHeaders(), $headers)); |
@@ -70,7 +70,7 @@ discard block |
||
| 70 | 70 | * @return DataDisplayResponse Reference to this object |
| 71 | 71 | * @since 8.1.0 |
| 72 | 72 | */ |
| 73 | - public function setData($data){ |
|
| 73 | + public function setData($data) { |
|
| 74 | 74 | $this->data = $data; |
| 75 | 75 | |
| 76 | 76 | return $this; |
@@ -82,7 +82,7 @@ discard block |
||
| 82 | 82 | * @return string the data |
| 83 | 83 | * @since 8.1.0 |
| 84 | 84 | */ |
| 85 | - public function getData(){ |
|
| 85 | + public function getData() { |
|
| 86 | 86 | return $this->data; |
| 87 | 87 | } |
| 88 | 88 | |
@@ -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,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 | } |