@@ -27,12 +27,12 @@ |
||
| 27 | 27 | * @since 8.2.0 |
| 28 | 28 | */ |
| 29 | 29 | class AutoloadNotAllowedException extends \DomainException { |
| 30 | - /** |
|
| 31 | - * @param string $path |
|
| 32 | - * @since 8.2.0 |
|
| 33 | - */ |
|
| 34 | - public function __construct($path) { |
|
| 35 | - parent::__construct('Autoload path not allowed: '.$path); |
|
| 36 | - } |
|
| 30 | + /** |
|
| 31 | + * @param string $path |
|
| 32 | + * @since 8.2.0 |
|
| 33 | + */ |
|
| 34 | + public function __construct($path) { |
|
| 35 | + parent::__construct('Autoload path not allowed: '.$path); |
|
| 36 | + } |
|
| 37 | 37 | } |
| 38 | 38 | |
@@ -25,26 +25,26 @@ |
||
| 25 | 25 | * @since 9.2 |
| 26 | 26 | */ |
| 27 | 27 | interface ILockdownManager { |
| 28 | - /** |
|
| 29 | - * Enable the lockdown restrictions |
|
| 30 | - * |
|
| 31 | - * @since 9.2 |
|
| 32 | - */ |
|
| 33 | - public function enable(); |
|
| 28 | + /** |
|
| 29 | + * Enable the lockdown restrictions |
|
| 30 | + * |
|
| 31 | + * @since 9.2 |
|
| 32 | + */ |
|
| 33 | + public function enable(); |
|
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * Set the active token to get the restrictions from and enable the lockdown |
|
| 37 | - * |
|
| 38 | - * @param IToken $token |
|
| 39 | - * @since 9.2 |
|
| 40 | - */ |
|
| 41 | - public function setToken(IToken $token); |
|
| 35 | + /** |
|
| 36 | + * Set the active token to get the restrictions from and enable the lockdown |
|
| 37 | + * |
|
| 38 | + * @param IToken $token |
|
| 39 | + * @since 9.2 |
|
| 40 | + */ |
|
| 41 | + public function setToken(IToken $token); |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * Check whether or not filesystem access is allowed |
|
| 45 | - * |
|
| 46 | - * @return bool |
|
| 47 | - * @since 9.2 |
|
| 48 | - */ |
|
| 49 | - public function canAccessFilesystem(); |
|
| 43 | + /** |
|
| 44 | + * Check whether or not filesystem access is allowed |
|
| 45 | + * |
|
| 46 | + * @return bool |
|
| 47 | + * @since 9.2 |
|
| 48 | + */ |
|
| 49 | + public function canAccessFilesystem(); |
|
| 50 | 50 | } |
@@ -32,60 +32,60 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | abstract class Provider { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @since 8.0.0 |
|
| 37 | - */ |
|
| 38 | - const OPTION_APPS = 'apps'; |
|
| 35 | + /** |
|
| 36 | + * @since 8.0.0 |
|
| 37 | + */ |
|
| 38 | + const OPTION_APPS = 'apps'; |
|
| 39 | 39 | |
| 40 | - /** |
|
| 41 | - * List of options |
|
| 42 | - * @var array |
|
| 43 | - * @since 7.0.0 |
|
| 44 | - */ |
|
| 45 | - protected $options; |
|
| 40 | + /** |
|
| 41 | + * List of options |
|
| 42 | + * @var array |
|
| 43 | + * @since 7.0.0 |
|
| 44 | + */ |
|
| 45 | + protected $options; |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * Constructor |
|
| 49 | - * @param array $options as key => value |
|
| 50 | - * @since 7.0.0 - default value for $options was added in 8.0.0 |
|
| 51 | - */ |
|
| 52 | - public function __construct($options = array()) { |
|
| 53 | - $this->options = $options; |
|
| 54 | - } |
|
| 47 | + /** |
|
| 48 | + * Constructor |
|
| 49 | + * @param array $options as key => value |
|
| 50 | + * @since 7.0.0 - default value for $options was added in 8.0.0 |
|
| 51 | + */ |
|
| 52 | + public function __construct($options = array()) { |
|
| 53 | + $this->options = $options; |
|
| 54 | + } |
|
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * get a value from the options array or null |
|
| 58 | - * @param string $key |
|
| 59 | - * @return mixed |
|
| 60 | - * @since 8.0.0 |
|
| 61 | - */ |
|
| 62 | - public function getOption($key) { |
|
| 63 | - if (is_array($this->options) && isset($this->options[$key])) { |
|
| 64 | - return $this->options[$key]; |
|
| 65 | - } else { |
|
| 66 | - return null; |
|
| 67 | - } |
|
| 68 | - } |
|
| 56 | + /** |
|
| 57 | + * get a value from the options array or null |
|
| 58 | + * @param string $key |
|
| 59 | + * @return mixed |
|
| 60 | + * @since 8.0.0 |
|
| 61 | + */ |
|
| 62 | + public function getOption($key) { |
|
| 63 | + if (is_array($this->options) && isset($this->options[$key])) { |
|
| 64 | + return $this->options[$key]; |
|
| 65 | + } else { |
|
| 66 | + return null; |
|
| 67 | + } |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | - /** |
|
| 71 | - * checks if the given apps and the apps this provider has results for intersect |
|
| 72 | - * returns true if the given array is empty (all apps) |
|
| 73 | - * or if this provider does not have a list of apps it provides results for (legacy search providers) |
|
| 74 | - * or if the two above arrays have elements in common (intersect) |
|
| 75 | - * @param string[] $apps |
|
| 76 | - * @return bool |
|
| 77 | - * @since 8.0.0 |
|
| 78 | - */ |
|
| 79 | - public function providesResultsFor(array $apps = array()) { |
|
| 80 | - $forApps = $this->getOption(self::OPTION_APPS); |
|
| 81 | - return empty($apps) || empty($forApps) || array_intersect($forApps, $apps); |
|
| 82 | - } |
|
| 70 | + /** |
|
| 71 | + * checks if the given apps and the apps this provider has results for intersect |
|
| 72 | + * returns true if the given array is empty (all apps) |
|
| 73 | + * or if this provider does not have a list of apps it provides results for (legacy search providers) |
|
| 74 | + * or if the two above arrays have elements in common (intersect) |
|
| 75 | + * @param string[] $apps |
|
| 76 | + * @return bool |
|
| 77 | + * @since 8.0.0 |
|
| 78 | + */ |
|
| 79 | + public function providesResultsFor(array $apps = array()) { |
|
| 80 | + $forApps = $this->getOption(self::OPTION_APPS); |
|
| 81 | + return empty($apps) || empty($forApps) || array_intersect($forApps, $apps); |
|
| 82 | + } |
|
| 83 | 83 | |
| 84 | - /** |
|
| 85 | - * Search for $query |
|
| 86 | - * @param string $query |
|
| 87 | - * @return array An array of OCP\Search\Result's |
|
| 88 | - * @since 7.0.0 |
|
| 89 | - */ |
|
| 90 | - abstract public function search($query); |
|
| 84 | + /** |
|
| 85 | + * Search for $query |
|
| 86 | + * @param string $query |
|
| 87 | + * @return array An array of OCP\Search\Result's |
|
| 88 | + * @since 7.0.0 |
|
| 89 | + */ |
|
| 90 | + abstract public function search($query); |
|
| 91 | 91 | } |
@@ -31,47 +31,47 @@ |
||
| 31 | 31 | */ |
| 32 | 32 | class Result { |
| 33 | 33 | |
| 34 | - /** |
|
| 35 | - * A unique identifier for the result, usually given as the item ID in its |
|
| 36 | - * corresponding application. |
|
| 37 | - * @var string |
|
| 38 | - * @since 7.0.0 |
|
| 39 | - */ |
|
| 40 | - public $id; |
|
| 34 | + /** |
|
| 35 | + * A unique identifier for the result, usually given as the item ID in its |
|
| 36 | + * corresponding application. |
|
| 37 | + * @var string |
|
| 38 | + * @since 7.0.0 |
|
| 39 | + */ |
|
| 40 | + public $id; |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * The name of the item returned; this will be displayed in the search |
|
| 44 | - * results. |
|
| 45 | - * @var string |
|
| 46 | - * @since 7.0.0 |
|
| 47 | - */ |
|
| 48 | - public $name; |
|
| 42 | + /** |
|
| 43 | + * The name of the item returned; this will be displayed in the search |
|
| 44 | + * results. |
|
| 45 | + * @var string |
|
| 46 | + * @since 7.0.0 |
|
| 47 | + */ |
|
| 48 | + public $name; |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * URL to the application item. |
|
| 52 | - * @var string |
|
| 53 | - * @since 7.0.0 |
|
| 54 | - */ |
|
| 55 | - public $link; |
|
| 50 | + /** |
|
| 51 | + * URL to the application item. |
|
| 52 | + * @var string |
|
| 53 | + * @since 7.0.0 |
|
| 54 | + */ |
|
| 55 | + public $link; |
|
| 56 | 56 | |
| 57 | - /** |
|
| 58 | - * The type of search result returned; for consistency, name this the same |
|
| 59 | - * as the class name (e.g. \OC\Search\File -> 'file') in lowercase. |
|
| 60 | - * @var string |
|
| 61 | - * @since 7.0.0 |
|
| 62 | - */ |
|
| 63 | - public $type = 'generic'; |
|
| 57 | + /** |
|
| 58 | + * The type of search result returned; for consistency, name this the same |
|
| 59 | + * as the class name (e.g. \OC\Search\File -> 'file') in lowercase. |
|
| 60 | + * @var string |
|
| 61 | + * @since 7.0.0 |
|
| 62 | + */ |
|
| 63 | + public $type = 'generic'; |
|
| 64 | 64 | |
| 65 | - /** |
|
| 66 | - * Create a new search result |
|
| 67 | - * @param string $id unique identifier from application: '[app_name]/[item_identifier_in_app]' |
|
| 68 | - * @param string $name displayed text of result |
|
| 69 | - * @param string $link URL to the result within its app |
|
| 70 | - * @since 7.0.0 |
|
| 71 | - */ |
|
| 72 | - public function __construct($id = null, $name = null, $link = null) { |
|
| 73 | - $this->id = $id; |
|
| 74 | - $this->name = $name; |
|
| 75 | - $this->link = $link; |
|
| 76 | - } |
|
| 65 | + /** |
|
| 66 | + * Create a new search result |
|
| 67 | + * @param string $id unique identifier from application: '[app_name]/[item_identifier_in_app]' |
|
| 68 | + * @param string $name displayed text of result |
|
| 69 | + * @param string $link URL to the result within its app |
|
| 70 | + * @since 7.0.0 |
|
| 71 | + */ |
|
| 72 | + public function __construct($id = null, $name = null, $link = null) { |
|
| 73 | + $this->id = $id; |
|
| 74 | + $this->name = $name; |
|
| 75 | + $this->link = $link; |
|
| 76 | + } |
|
| 77 | 77 | } |
@@ -31,11 +31,11 @@ |
||
| 31 | 31 | * @since 5.0.0 |
| 32 | 32 | */ |
| 33 | 33 | interface Share_Backend_Collection extends Share_Backend { |
| 34 | - /** |
|
| 35 | - * Get the sources of the children of the item |
|
| 36 | - * @param string $itemSource |
|
| 37 | - * @return array Returns an array of children each inside an array with the keys: source, target, and file_path if applicable |
|
| 38 | - * @since 5.0.0 |
|
| 39 | - */ |
|
| 40 | - public function getChildren($itemSource); |
|
| 34 | + /** |
|
| 35 | + * Get the sources of the children of the item |
|
| 36 | + * @param string $itemSource |
|
| 37 | + * @return array Returns an array of children each inside an array with the keys: source, target, and file_path if applicable |
|
| 38 | + * @since 5.0.0 |
|
| 39 | + */ |
|
| 40 | + public function getChildren($itemSource); |
|
| 41 | 41 | } |
@@ -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 | } |
@@ -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,48 +32,48 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | interface IOutput { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * @param string $out |
|
| 37 | - * @since 8.1.0 |
|
| 38 | - */ |
|
| 39 | - public function setOutput($out); |
|
| 35 | + /** |
|
| 36 | + * @param string $out |
|
| 37 | + * @since 8.1.0 |
|
| 38 | + */ |
|
| 39 | + public function setOutput($out); |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * @param string|resource $path or file handle |
|
| 43 | - * |
|
| 44 | - * @return bool false if an error occurred |
|
| 45 | - * @since 8.1.0 |
|
| 46 | - */ |
|
| 47 | - public function setReadfile($path); |
|
| 41 | + /** |
|
| 42 | + * @param string|resource $path or file handle |
|
| 43 | + * |
|
| 44 | + * @return bool false if an error occurred |
|
| 45 | + * @since 8.1.0 |
|
| 46 | + */ |
|
| 47 | + public function setReadfile($path); |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * @param string $header |
|
| 51 | - * @since 8.1.0 |
|
| 52 | - */ |
|
| 53 | - public function setHeader($header); |
|
| 49 | + /** |
|
| 50 | + * @param string $header |
|
| 51 | + * @since 8.1.0 |
|
| 52 | + */ |
|
| 53 | + public function setHeader($header); |
|
| 54 | 54 | |
| 55 | - /** |
|
| 56 | - * @return int returns the current http response code |
|
| 57 | - * @since 8.1.0 |
|
| 58 | - */ |
|
| 59 | - public function getHttpResponseCode(); |
|
| 55 | + /** |
|
| 56 | + * @return int returns the current http response code |
|
| 57 | + * @since 8.1.0 |
|
| 58 | + */ |
|
| 59 | + public function getHttpResponseCode(); |
|
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * @param int $code sets the http status code |
|
| 63 | - * @since 8.1.0 |
|
| 64 | - */ |
|
| 65 | - public function setHttpResponseCode($code); |
|
| 61 | + /** |
|
| 62 | + * @param int $code sets the http status code |
|
| 63 | + * @since 8.1.0 |
|
| 64 | + */ |
|
| 65 | + public function setHttpResponseCode($code); |
|
| 66 | 66 | |
| 67 | - /** |
|
| 68 | - * @param string $name |
|
| 69 | - * @param string $value |
|
| 70 | - * @param int $expire |
|
| 71 | - * @param string $path |
|
| 72 | - * @param string $domain |
|
| 73 | - * @param bool $secure |
|
| 74 | - * @param bool $httpOnly |
|
| 75 | - * @since 8.1.0 |
|
| 76 | - */ |
|
| 77 | - public function setCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly); |
|
| 67 | + /** |
|
| 68 | + * @param string $name |
|
| 69 | + * @param string $value |
|
| 70 | + * @param int $expire |
|
| 71 | + * @param string $path |
|
| 72 | + * @param string $domain |
|
| 73 | + * @param bool $secure |
|
| 74 | + * @param bool $httpOnly |
|
| 75 | + * @since 8.1.0 |
|
| 76 | + */ |
|
| 77 | + public function setCookie($name, $value, $expire, $path, $domain, $secure, $httpOnly); |
|
| 78 | 78 | |
| 79 | 79 | } |
@@ -44,69 +44,69 @@ |
||
| 44 | 44 | abstract class Middleware { |
| 45 | 45 | |
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * This is being run in normal order before the controller is being |
|
| 49 | - * called which allows several modifications and checks |
|
| 50 | - * |
|
| 51 | - * @param Controller $controller the controller that is being called |
|
| 52 | - * @param string $methodName the name of the method that will be called on |
|
| 53 | - * the controller |
|
| 54 | - * @since 6.0.0 |
|
| 55 | - */ |
|
| 56 | - public function beforeController($controller, $methodName){ |
|
| 47 | + /** |
|
| 48 | + * This is being run in normal order before the controller is being |
|
| 49 | + * called which allows several modifications and checks |
|
| 50 | + * |
|
| 51 | + * @param Controller $controller the controller that is being called |
|
| 52 | + * @param string $methodName the name of the method that will be called on |
|
| 53 | + * the controller |
|
| 54 | + * @since 6.0.0 |
|
| 55 | + */ |
|
| 56 | + public function beforeController($controller, $methodName){ |
|
| 57 | 57 | |
| 58 | - } |
|
| 58 | + } |
|
| 59 | 59 | |
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * This is being run when either the beforeController method or the |
|
| 63 | - * controller method itself is throwing an exception. The middleware is |
|
| 64 | - * asked in reverse order to handle the exception and to return a response. |
|
| 65 | - * If the response is null, it is assumed that the exception could not be |
|
| 66 | - * handled and the error will be thrown again |
|
| 67 | - * |
|
| 68 | - * @param Controller $controller the controller that is being called |
|
| 69 | - * @param string $methodName the name of the method that will be called on |
|
| 70 | - * the controller |
|
| 71 | - * @param \Exception $exception the thrown exception |
|
| 72 | - * @throws \Exception the passed in exception if it can't handle it |
|
| 73 | - * @return Response a Response object in case that the exception was handled |
|
| 74 | - * @since 6.0.0 |
|
| 75 | - */ |
|
| 76 | - public function afterException($controller, $methodName, \Exception $exception){ |
|
| 77 | - throw $exception; |
|
| 78 | - } |
|
| 61 | + /** |
|
| 62 | + * This is being run when either the beforeController method or the |
|
| 63 | + * controller method itself is throwing an exception. The middleware is |
|
| 64 | + * asked in reverse order to handle the exception and to return a response. |
|
| 65 | + * If the response is null, it is assumed that the exception could not be |
|
| 66 | + * handled and the error will be thrown again |
|
| 67 | + * |
|
| 68 | + * @param Controller $controller the controller that is being called |
|
| 69 | + * @param string $methodName the name of the method that will be called on |
|
| 70 | + * the controller |
|
| 71 | + * @param \Exception $exception the thrown exception |
|
| 72 | + * @throws \Exception the passed in exception if it can't handle it |
|
| 73 | + * @return Response a Response object in case that the exception was handled |
|
| 74 | + * @since 6.0.0 |
|
| 75 | + */ |
|
| 76 | + public function afterException($controller, $methodName, \Exception $exception){ |
|
| 77 | + throw $exception; |
|
| 78 | + } |
|
| 79 | 79 | |
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * This is being run after a successful controllermethod call and allows |
|
| 83 | - * the manipulation of a Response object. The middleware is run in reverse order |
|
| 84 | - * |
|
| 85 | - * @param Controller $controller the controller that is being called |
|
| 86 | - * @param string $methodName the name of the method that will be called on |
|
| 87 | - * the controller |
|
| 88 | - * @param Response $response the generated response from the controller |
|
| 89 | - * @return Response a Response object |
|
| 90 | - * @since 6.0.0 |
|
| 91 | - */ |
|
| 92 | - public function afterController($controller, $methodName, Response $response){ |
|
| 93 | - return $response; |
|
| 94 | - } |
|
| 81 | + /** |
|
| 82 | + * This is being run after a successful controllermethod call and allows |
|
| 83 | + * the manipulation of a Response object. The middleware is run in reverse order |
|
| 84 | + * |
|
| 85 | + * @param Controller $controller the controller that is being called |
|
| 86 | + * @param string $methodName the name of the method that will be called on |
|
| 87 | + * the controller |
|
| 88 | + * @param Response $response the generated response from the controller |
|
| 89 | + * @return Response a Response object |
|
| 90 | + * @since 6.0.0 |
|
| 91 | + */ |
|
| 92 | + public function afterController($controller, $methodName, Response $response){ |
|
| 93 | + return $response; |
|
| 94 | + } |
|
| 95 | 95 | |
| 96 | 96 | |
| 97 | - /** |
|
| 98 | - * This is being run after the response object has been rendered and |
|
| 99 | - * allows the manipulation of the output. The middleware is run in reverse order |
|
| 100 | - * |
|
| 101 | - * @param Controller $controller the controller that is being called |
|
| 102 | - * @param string $methodName the name of the method that will be called on |
|
| 103 | - * the controller |
|
| 104 | - * @param string $output the generated output from a response |
|
| 105 | - * @return string the output that should be printed |
|
| 106 | - * @since 6.0.0 |
|
| 107 | - */ |
|
| 108 | - public function beforeOutput($controller, $methodName, $output){ |
|
| 109 | - return $output; |
|
| 110 | - } |
|
| 97 | + /** |
|
| 98 | + * This is being run after the response object has been rendered and |
|
| 99 | + * allows the manipulation of the output. The middleware is run in reverse order |
|
| 100 | + * |
|
| 101 | + * @param Controller $controller the controller that is being called |
|
| 102 | + * @param string $methodName the name of the method that will be called on |
|
| 103 | + * the controller |
|
| 104 | + * @param string $output the generated output from a response |
|
| 105 | + * @return string the output that should be printed |
|
| 106 | + * @since 6.0.0 |
|
| 107 | + */ |
|
| 108 | + public function beforeOutput($controller, $methodName, $output){ |
|
| 109 | + return $output; |
|
| 110 | + } |
|
| 111 | 111 | |
| 112 | 112 | } |