@@ -39,46 +39,46 @@ |
||
| 39 | 39 | */ |
| 40 | 40 | interface ICache { |
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Get a value from the user cache |
|
| 44 | - * @param string $key |
|
| 45 | - * @return mixed |
|
| 46 | - * @since 6.0.0 |
|
| 47 | - */ |
|
| 48 | - public function get($key); |
|
| 42 | + /** |
|
| 43 | + * Get a value from the user cache |
|
| 44 | + * @param string $key |
|
| 45 | + * @return mixed |
|
| 46 | + * @since 6.0.0 |
|
| 47 | + */ |
|
| 48 | + public function get($key); |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * Set a value in the user cache |
|
| 52 | - * @param string $key |
|
| 53 | - * @param mixed $value |
|
| 54 | - * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 55 | - * @return bool |
|
| 56 | - * @since 6.0.0 |
|
| 57 | - */ |
|
| 58 | - public function set($key, $value, $ttl = 0); |
|
| 50 | + /** |
|
| 51 | + * Set a value in the user cache |
|
| 52 | + * @param string $key |
|
| 53 | + * @param mixed $value |
|
| 54 | + * @param int $ttl Time To Live in seconds. Defaults to 60*60*24 |
|
| 55 | + * @return bool |
|
| 56 | + * @since 6.0.0 |
|
| 57 | + */ |
|
| 58 | + public function set($key, $value, $ttl = 0); |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * Check if a value is set in the user cache |
|
| 62 | - * @param string $key |
|
| 63 | - * @return bool |
|
| 64 | - * @since 6.0.0 |
|
| 65 | - * @deprecated 9.1.0 Directly read from GET to prevent race conditions |
|
| 66 | - */ |
|
| 67 | - public function hasKey($key); |
|
| 60 | + /** |
|
| 61 | + * Check if a value is set in the user cache |
|
| 62 | + * @param string $key |
|
| 63 | + * @return bool |
|
| 64 | + * @since 6.0.0 |
|
| 65 | + * @deprecated 9.1.0 Directly read from GET to prevent race conditions |
|
| 66 | + */ |
|
| 67 | + public function hasKey($key); |
|
| 68 | 68 | |
| 69 | - /** |
|
| 70 | - * Remove an item from the user cache |
|
| 71 | - * @param string $key |
|
| 72 | - * @return bool |
|
| 73 | - * @since 6.0.0 |
|
| 74 | - */ |
|
| 75 | - public function remove($key); |
|
| 69 | + /** |
|
| 70 | + * Remove an item from the user cache |
|
| 71 | + * @param string $key |
|
| 72 | + * @return bool |
|
| 73 | + * @since 6.0.0 |
|
| 74 | + */ |
|
| 75 | + public function remove($key); |
|
| 76 | 76 | |
| 77 | - /** |
|
| 78 | - * Clear the user cache of all entries starting with a prefix |
|
| 79 | - * @param string $prefix (optional) |
|
| 80 | - * @return bool |
|
| 81 | - * @since 6.0.0 |
|
| 82 | - */ |
|
| 83 | - public function clear($prefix = ''); |
|
| 77 | + /** |
|
| 78 | + * Clear the user cache of all entries starting with a prefix |
|
| 79 | + * @param string $prefix (optional) |
|
| 80 | + * @return bool |
|
| 81 | + * @since 6.0.0 |
|
| 82 | + */ |
|
| 83 | + public function clear($prefix = ''); |
|
| 84 | 84 | } |
@@ -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 | } |
@@ -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 | } |
@@ -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 | } |
@@ -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 | } |