@@ -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 | } |
@@ -33,65 +33,65 @@ |
||
| 33 | 33 | */ |
| 34 | 34 | class SabrePluginEvent extends Event { |
| 35 | 35 | |
| 36 | - /** @var int */ |
|
| 37 | - protected $statusCode; |
|
| 36 | + /** @var int */ |
|
| 37 | + protected $statusCode; |
|
| 38 | 38 | |
| 39 | - /** @var string */ |
|
| 40 | - protected $message; |
|
| 39 | + /** @var string */ |
|
| 40 | + protected $message; |
|
| 41 | 41 | |
| 42 | - /** @var Server */ |
|
| 43 | - protected $server; |
|
| 42 | + /** @var Server */ |
|
| 43 | + protected $server; |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * @since 8.2.0 |
|
| 47 | - */ |
|
| 48 | - public function __construct($server = null) { |
|
| 49 | - $this->message = ''; |
|
| 50 | - $this->statusCode = Http::STATUS_OK; |
|
| 51 | - $this->server = $server; |
|
| 52 | - } |
|
| 45 | + /** |
|
| 46 | + * @since 8.2.0 |
|
| 47 | + */ |
|
| 48 | + public function __construct($server = null) { |
|
| 49 | + $this->message = ''; |
|
| 50 | + $this->statusCode = Http::STATUS_OK; |
|
| 51 | + $this->server = $server; |
|
| 52 | + } |
|
| 53 | 53 | |
| 54 | - /** |
|
| 55 | - * @param int $statusCode |
|
| 56 | - * @return self |
|
| 57 | - * @since 8.2.0 |
|
| 58 | - */ |
|
| 59 | - public function setStatusCode($statusCode) { |
|
| 60 | - $this->statusCode = (int) $statusCode; |
|
| 61 | - return $this; |
|
| 62 | - } |
|
| 54 | + /** |
|
| 55 | + * @param int $statusCode |
|
| 56 | + * @return self |
|
| 57 | + * @since 8.2.0 |
|
| 58 | + */ |
|
| 59 | + public function setStatusCode($statusCode) { |
|
| 60 | + $this->statusCode = (int) $statusCode; |
|
| 61 | + return $this; |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @param string $message |
|
| 66 | - * @return self |
|
| 67 | - * @since 8.2.0 |
|
| 68 | - */ |
|
| 69 | - public function setMessage($message) { |
|
| 70 | - $this->message = (string) $message; |
|
| 71 | - return $this; |
|
| 72 | - } |
|
| 64 | + /** |
|
| 65 | + * @param string $message |
|
| 66 | + * @return self |
|
| 67 | + * @since 8.2.0 |
|
| 68 | + */ |
|
| 69 | + public function setMessage($message) { |
|
| 70 | + $this->message = (string) $message; |
|
| 71 | + return $this; |
|
| 72 | + } |
|
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * @return int |
|
| 76 | - * @since 8.2.0 |
|
| 77 | - */ |
|
| 78 | - public function getStatusCode() { |
|
| 79 | - return $this->statusCode; |
|
| 80 | - } |
|
| 74 | + /** |
|
| 75 | + * @return int |
|
| 76 | + * @since 8.2.0 |
|
| 77 | + */ |
|
| 78 | + public function getStatusCode() { |
|
| 79 | + return $this->statusCode; |
|
| 80 | + } |
|
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * @return string |
|
| 84 | - * @since 8.2.0 |
|
| 85 | - */ |
|
| 86 | - public function getMessage() { |
|
| 87 | - return $this->message; |
|
| 88 | - } |
|
| 82 | + /** |
|
| 83 | + * @return string |
|
| 84 | + * @since 8.2.0 |
|
| 85 | + */ |
|
| 86 | + public function getMessage() { |
|
| 87 | + return $this->message; |
|
| 88 | + } |
|
| 89 | 89 | |
| 90 | - /** |
|
| 91 | - * @return null|Server |
|
| 92 | - * @since 9.0.0 |
|
| 93 | - */ |
|
| 94 | - public function getServer() { |
|
| 95 | - return $this->server; |
|
| 96 | - } |
|
| 90 | + /** |
|
| 91 | + * @return null|Server |
|
| 92 | + * @since 9.0.0 |
|
| 93 | + */ |
|
| 94 | + public function getServer() { |
|
| 95 | + return $this->server; |
|
| 96 | + } |
|
| 97 | 97 | } |
@@ -29,11 +29,11 @@ |
||
| 29 | 29 | */ |
| 30 | 30 | interface IValidator { |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * @param string $subject |
|
| 34 | - * @param array[] $parameters |
|
| 35 | - * @throws InvalidObjectExeption |
|
| 36 | - * @since 11.0.0 |
|
| 37 | - */ |
|
| 38 | - public function validate($subject, array $parameters); |
|
| 32 | + /** |
|
| 33 | + * @param string $subject |
|
| 34 | + * @param array[] $parameters |
|
| 35 | + * @throws InvalidObjectExeption |
|
| 36 | + * @since 11.0.0 |
|
| 37 | + */ |
|
| 38 | + public function validate($subject, array $parameters); |
|
| 39 | 39 | } |
@@ -26,9 +26,9 @@ |
||
| 26 | 26 | * @since 8.2.0 |
| 27 | 27 | */ |
| 28 | 28 | interface IQueryFunction { |
| 29 | - /** |
|
| 30 | - * @return string |
|
| 31 | - * @since 8.2.0 |
|
| 32 | - */ |
|
| 33 | - public function __toString(); |
|
| 29 | + /** |
|
| 30 | + * @return string |
|
| 31 | + * @since 8.2.0 |
|
| 32 | + */ |
|
| 33 | + public function __toString(); |
|
| 34 | 34 | } |
@@ -26,9 +26,9 @@ |
||
| 26 | 26 | * @since 8.2.0 |
| 27 | 27 | */ |
| 28 | 28 | interface ILiteral { |
| 29 | - /** |
|
| 30 | - * @return string |
|
| 31 | - * @since 8.2.0 |
|
| 32 | - */ |
|
| 33 | - public function __toString(); |
|
| 29 | + /** |
|
| 30 | + * @return string |
|
| 31 | + * @since 8.2.0 |
|
| 32 | + */ |
|
| 33 | + public function __toString(); |
|
| 34 | 34 | } |
@@ -26,9 +26,9 @@ |
||
| 26 | 26 | * @since 8.2.0 |
| 27 | 27 | */ |
| 28 | 28 | interface IParameter { |
| 29 | - /** |
|
| 30 | - * @return string |
|
| 31 | - * @since 8.2.0 |
|
| 32 | - */ |
|
| 33 | - public function __toString(); |
|
| 29 | + /** |
|
| 30 | + * @return string |
|
| 31 | + * @since 8.2.0 |
|
| 32 | + */ |
|
| 33 | + public function __toString(); |
|
| 34 | 34 | } |
@@ -37,55 +37,55 @@ |
||
| 37 | 37 | * @since 8.1.0 |
| 38 | 38 | */ |
| 39 | 39 | interface IMemcache extends ICache { |
| 40 | - /** |
|
| 41 | - * Set a value in the cache if it's not already stored |
|
| 42 | - * |
|
| 43 | - * @param string $key |
|
| 44 | - * @param mixed $value |
|
| 45 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 46 | - * @return bool |
|
| 47 | - * @since 8.1.0 |
|
| 48 | - */ |
|
| 49 | - public function add($key, $value, $ttl = 0); |
|
| 40 | + /** |
|
| 41 | + * Set a value in the cache if it's not already stored |
|
| 42 | + * |
|
| 43 | + * @param string $key |
|
| 44 | + * @param mixed $value |
|
| 45 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 46 | + * @return bool |
|
| 47 | + * @since 8.1.0 |
|
| 48 | + */ |
|
| 49 | + public function add($key, $value, $ttl = 0); |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Increase a stored number |
|
| 53 | - * |
|
| 54 | - * @param string $key |
|
| 55 | - * @param int $step |
|
| 56 | - * @return int | bool |
|
| 57 | - * @since 8.1.0 |
|
| 58 | - */ |
|
| 59 | - public function inc($key, $step = 1); |
|
| 51 | + /** |
|
| 52 | + * Increase a stored number |
|
| 53 | + * |
|
| 54 | + * @param string $key |
|
| 55 | + * @param int $step |
|
| 56 | + * @return int | bool |
|
| 57 | + * @since 8.1.0 |
|
| 58 | + */ |
|
| 59 | + public function inc($key, $step = 1); |
|
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * Decrease a stored number |
|
| 63 | - * |
|
| 64 | - * @param string $key |
|
| 65 | - * @param int $step |
|
| 66 | - * @return int | bool |
|
| 67 | - * @since 8.1.0 |
|
| 68 | - */ |
|
| 69 | - public function dec($key, $step = 1); |
|
| 61 | + /** |
|
| 62 | + * Decrease a stored number |
|
| 63 | + * |
|
| 64 | + * @param string $key |
|
| 65 | + * @param int $step |
|
| 66 | + * @return int | bool |
|
| 67 | + * @since 8.1.0 |
|
| 68 | + */ |
|
| 69 | + public function dec($key, $step = 1); |
|
| 70 | 70 | |
| 71 | - /** |
|
| 72 | - * Compare and set |
|
| 73 | - * |
|
| 74 | - * @param string $key |
|
| 75 | - * @param mixed $old |
|
| 76 | - * @param mixed $new |
|
| 77 | - * @return bool |
|
| 78 | - * @since 8.1.0 |
|
| 79 | - */ |
|
| 80 | - public function cas($key, $old, $new); |
|
| 71 | + /** |
|
| 72 | + * Compare and set |
|
| 73 | + * |
|
| 74 | + * @param string $key |
|
| 75 | + * @param mixed $old |
|
| 76 | + * @param mixed $new |
|
| 77 | + * @return bool |
|
| 78 | + * @since 8.1.0 |
|
| 79 | + */ |
|
| 80 | + public function cas($key, $old, $new); |
|
| 81 | 81 | |
| 82 | - /** |
|
| 83 | - * Compare and delete |
|
| 84 | - * |
|
| 85 | - * @param string $key |
|
| 86 | - * @param mixed $old |
|
| 87 | - * @return bool |
|
| 88 | - * @since 8.1.0 |
|
| 89 | - */ |
|
| 90 | - public function cad($key, $old); |
|
| 82 | + /** |
|
| 83 | + * Compare and delete |
|
| 84 | + * |
|
| 85 | + * @param string $key |
|
| 86 | + * @param mixed $old |
|
| 87 | + * @return bool |
|
| 88 | + * @since 8.1.0 |
|
| 89 | + */ |
|
| 90 | + public function cad($key, $old); |
|
| 91 | 91 | } |
@@ -32,13 +32,13 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | interface IFile { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * get list of users with access to the file |
|
| 37 | - * |
|
| 38 | - * @param string $path to the file |
|
| 39 | - * @return array |
|
| 40 | - * @since 8.1.0 |
|
| 41 | - */ |
|
| 42 | - public function getAccessList($path); |
|
| 35 | + /** |
|
| 36 | + * get list of users with access to the file |
|
| 37 | + * |
|
| 38 | + * @param string $path to the file |
|
| 39 | + * @return array |
|
| 40 | + * @since 8.1.0 |
|
| 41 | + */ |
|
| 42 | + public function getAccessList($path); |
|
| 43 | 43 | |
| 44 | 44 | } |
@@ -34,67 +34,67 @@ |
||
| 34 | 34 | */ |
| 35 | 35 | interface IManager { |
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * Check if encryption is available (at least one encryption module needs to be enabled) |
|
| 39 | - * |
|
| 40 | - * @return bool true if enabled, false if not |
|
| 41 | - * @since 8.1.0 |
|
| 42 | - */ |
|
| 43 | - public function isEnabled(); |
|
| 37 | + /** |
|
| 38 | + * Check if encryption is available (at least one encryption module needs to be enabled) |
|
| 39 | + * |
|
| 40 | + * @return bool true if enabled, false if not |
|
| 41 | + * @since 8.1.0 |
|
| 42 | + */ |
|
| 43 | + public function isEnabled(); |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * Registers an callback function which must return an encryption module instance |
|
| 47 | - * |
|
| 48 | - * @param string $id |
|
| 49 | - * @param string $displayName |
|
| 50 | - * @param callable $callback |
|
| 51 | - * @throws ModuleAlreadyExistsException |
|
| 52 | - * @since 8.1.0 |
|
| 53 | - */ |
|
| 54 | - public function registerEncryptionModule($id, $displayName, callable $callback); |
|
| 45 | + /** |
|
| 46 | + * Registers an callback function which must return an encryption module instance |
|
| 47 | + * |
|
| 48 | + * @param string $id |
|
| 49 | + * @param string $displayName |
|
| 50 | + * @param callable $callback |
|
| 51 | + * @throws ModuleAlreadyExistsException |
|
| 52 | + * @since 8.1.0 |
|
| 53 | + */ |
|
| 54 | + public function registerEncryptionModule($id, $displayName, callable $callback); |
|
| 55 | 55 | |
| 56 | - /** |
|
| 57 | - * Unregisters an encryption module |
|
| 58 | - * |
|
| 59 | - * @param string $moduleId |
|
| 60 | - * @since 8.1.0 |
|
| 61 | - */ |
|
| 62 | - public function unregisterEncryptionModule($moduleId); |
|
| 56 | + /** |
|
| 57 | + * Unregisters an encryption module |
|
| 58 | + * |
|
| 59 | + * @param string $moduleId |
|
| 60 | + * @since 8.1.0 |
|
| 61 | + */ |
|
| 62 | + public function unregisterEncryptionModule($moduleId); |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * get a list of all encryption modules |
|
| 66 | - * |
|
| 67 | - * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
| 68 | - * @since 8.1.0 |
|
| 69 | - */ |
|
| 70 | - public function getEncryptionModules(); |
|
| 64 | + /** |
|
| 65 | + * get a list of all encryption modules |
|
| 66 | + * |
|
| 67 | + * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]] |
|
| 68 | + * @since 8.1.0 |
|
| 69 | + */ |
|
| 70 | + public function getEncryptionModules(); |
|
| 71 | 71 | |
| 72 | 72 | |
| 73 | - /** |
|
| 74 | - * get a specific encryption module |
|
| 75 | - * |
|
| 76 | - * @param string $moduleId Empty to get the default module |
|
| 77 | - * @return IEncryptionModule |
|
| 78 | - * @throws ModuleDoesNotExistsException |
|
| 79 | - * @since 8.1.0 |
|
| 80 | - */ |
|
| 81 | - public function getEncryptionModule($moduleId = ''); |
|
| 73 | + /** |
|
| 74 | + * get a specific encryption module |
|
| 75 | + * |
|
| 76 | + * @param string $moduleId Empty to get the default module |
|
| 77 | + * @return IEncryptionModule |
|
| 78 | + * @throws ModuleDoesNotExistsException |
|
| 79 | + * @since 8.1.0 |
|
| 80 | + */ |
|
| 81 | + public function getEncryptionModule($moduleId = ''); |
|
| 82 | 82 | |
| 83 | - /** |
|
| 84 | - * get default encryption module Id |
|
| 85 | - * |
|
| 86 | - * @return string |
|
| 87 | - * @since 8.1.0 |
|
| 88 | - */ |
|
| 89 | - public function getDefaultEncryptionModuleId(); |
|
| 83 | + /** |
|
| 84 | + * get default encryption module Id |
|
| 85 | + * |
|
| 86 | + * @return string |
|
| 87 | + * @since 8.1.0 |
|
| 88 | + */ |
|
| 89 | + public function getDefaultEncryptionModuleId(); |
|
| 90 | 90 | |
| 91 | - /** |
|
| 92 | - * set default encryption module Id |
|
| 93 | - * |
|
| 94 | - * @param string $moduleId |
|
| 95 | - * @return string |
|
| 96 | - * @since 8.1.0 |
|
| 97 | - */ |
|
| 98 | - public function setDefaultEncryptionModule($moduleId); |
|
| 91 | + /** |
|
| 92 | + * set default encryption module Id |
|
| 93 | + * |
|
| 94 | + * @param string $moduleId |
|
| 95 | + * @return string |
|
| 96 | + * @since 8.1.0 |
|
| 97 | + */ |
|
| 98 | + public function setDefaultEncryptionModule($moduleId); |
|
| 99 | 99 | |
| 100 | 100 | } |