@@ -10,8 +10,7 @@ |
||
| 10 | 10 | * state of the current instance and return an instance that contains the |
| 11 | 11 | * changed state. |
| 12 | 12 | */ |
| 13 | -interface UploadedFileInterface |
|
| 14 | -{ |
|
| 13 | +interface UploadedFileInterface { |
|
| 15 | 14 | /** |
| 16 | 15 | * Retrieve a stream representing the uploaded file. |
| 17 | 16 | * |
@@ -12,107 +12,107 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | interface UploadedFileInterface |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Retrieve a stream representing the uploaded file. |
|
| 17 | - * |
|
| 18 | - * This method MUST return a StreamInterface instance, representing the |
|
| 19 | - * uploaded file. The purpose of this method is to allow utilizing native PHP |
|
| 20 | - * stream functionality to manipulate the file upload, such as |
|
| 21 | - * stream_copy_to_stream() (though the result will need to be decorated in a |
|
| 22 | - * native PHP stream wrapper to work with such functions). |
|
| 23 | - * |
|
| 24 | - * If the moveTo() method has been called previously, this method MUST raise |
|
| 25 | - * an exception. |
|
| 26 | - * |
|
| 27 | - * @return StreamInterface Stream representation of the uploaded file. |
|
| 28 | - * @throws \RuntimeException in cases when no stream is available or can be |
|
| 29 | - * created. |
|
| 30 | - */ |
|
| 31 | - public function getStream() : StreamInterface; |
|
| 32 | - /** |
|
| 33 | - * Move the uploaded file to a new location. |
|
| 34 | - * |
|
| 35 | - * Use this method as an alternative to move_uploaded_file(). This method is |
|
| 36 | - * guaranteed to work in both SAPI and non-SAPI environments. |
|
| 37 | - * Implementations must determine which environment they are in, and use the |
|
| 38 | - * appropriate method (move_uploaded_file(), rename(), or a stream |
|
| 39 | - * operation) to perform the operation. |
|
| 40 | - * |
|
| 41 | - * $targetPath may be an absolute path, or a relative path. If it is a |
|
| 42 | - * relative path, resolution should be the same as used by PHP's rename() |
|
| 43 | - * function. |
|
| 44 | - * |
|
| 45 | - * The original file or stream MUST be removed on completion. |
|
| 46 | - * |
|
| 47 | - * If this method is called more than once, any subsequent calls MUST raise |
|
| 48 | - * an exception. |
|
| 49 | - * |
|
| 50 | - * When used in an SAPI environment where $_FILES is populated, when writing |
|
| 51 | - * files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be |
|
| 52 | - * used to ensure permissions and upload status are verified correctly. |
|
| 53 | - * |
|
| 54 | - * If you wish to move to a stream, use getStream(), as SAPI operations |
|
| 55 | - * cannot guarantee writing to stream destinations. |
|
| 56 | - * |
|
| 57 | - * @see http://php.net/is_uploaded_file |
|
| 58 | - * @see http://php.net/move_uploaded_file |
|
| 59 | - * @param string $targetPath Path to which to move the uploaded file. |
|
| 60 | - * @throws \InvalidArgumentException if the $targetPath specified is invalid. |
|
| 61 | - * @throws \RuntimeException on any error during the move operation, or on |
|
| 62 | - * the second or subsequent call to the method. |
|
| 63 | - */ |
|
| 64 | - public function moveTo(string $targetPath) : void; |
|
| 65 | - /** |
|
| 66 | - * Retrieve the file size. |
|
| 67 | - * |
|
| 68 | - * Implementations SHOULD return the value stored in the "size" key of |
|
| 69 | - * the file in the $_FILES array if available, as PHP calculates this based |
|
| 70 | - * on the actual size transmitted. |
|
| 71 | - * |
|
| 72 | - * @return int|null The file size in bytes or null if unknown. |
|
| 73 | - */ |
|
| 74 | - public function getSize() : ?int; |
|
| 75 | - /** |
|
| 76 | - * Retrieve the error associated with the uploaded file. |
|
| 77 | - * |
|
| 78 | - * The return value MUST be one of PHP's UPLOAD_ERR_XXX constants. |
|
| 79 | - * |
|
| 80 | - * If the file was uploaded successfully, this method MUST return |
|
| 81 | - * UPLOAD_ERR_OK. |
|
| 82 | - * |
|
| 83 | - * Implementations SHOULD return the value stored in the "error" key of |
|
| 84 | - * the file in the $_FILES array. |
|
| 85 | - * |
|
| 86 | - * @see http://php.net/manual/en/features.file-upload.errors.php |
|
| 87 | - * @return int One of PHP's UPLOAD_ERR_XXX constants. |
|
| 88 | - */ |
|
| 89 | - public function getError() : int; |
|
| 90 | - /** |
|
| 91 | - * Retrieve the filename sent by the client. |
|
| 92 | - * |
|
| 93 | - * Do not trust the value returned by this method. A client could send |
|
| 94 | - * a malicious filename with the intention to corrupt or hack your |
|
| 95 | - * application. |
|
| 96 | - * |
|
| 97 | - * Implementations SHOULD return the value stored in the "name" key of |
|
| 98 | - * the file in the $_FILES array. |
|
| 99 | - * |
|
| 100 | - * @return string|null The filename sent by the client or null if none |
|
| 101 | - * was provided. |
|
| 102 | - */ |
|
| 103 | - public function getClientFilename() : ?string; |
|
| 104 | - /** |
|
| 105 | - * Retrieve the media type sent by the client. |
|
| 106 | - * |
|
| 107 | - * Do not trust the value returned by this method. A client could send |
|
| 108 | - * a malicious media type with the intention to corrupt or hack your |
|
| 109 | - * application. |
|
| 110 | - * |
|
| 111 | - * Implementations SHOULD return the value stored in the "type" key of |
|
| 112 | - * the file in the $_FILES array. |
|
| 113 | - * |
|
| 114 | - * @return string|null The media type sent by the client or null if none |
|
| 115 | - * was provided. |
|
| 116 | - */ |
|
| 117 | - public function getClientMediaType() : ?string; |
|
| 15 | + /** |
|
| 16 | + * Retrieve a stream representing the uploaded file. |
|
| 17 | + * |
|
| 18 | + * This method MUST return a StreamInterface instance, representing the |
|
| 19 | + * uploaded file. The purpose of this method is to allow utilizing native PHP |
|
| 20 | + * stream functionality to manipulate the file upload, such as |
|
| 21 | + * stream_copy_to_stream() (though the result will need to be decorated in a |
|
| 22 | + * native PHP stream wrapper to work with such functions). |
|
| 23 | + * |
|
| 24 | + * If the moveTo() method has been called previously, this method MUST raise |
|
| 25 | + * an exception. |
|
| 26 | + * |
|
| 27 | + * @return StreamInterface Stream representation of the uploaded file. |
|
| 28 | + * @throws \RuntimeException in cases when no stream is available or can be |
|
| 29 | + * created. |
|
| 30 | + */ |
|
| 31 | + public function getStream() : StreamInterface; |
|
| 32 | + /** |
|
| 33 | + * Move the uploaded file to a new location. |
|
| 34 | + * |
|
| 35 | + * Use this method as an alternative to move_uploaded_file(). This method is |
|
| 36 | + * guaranteed to work in both SAPI and non-SAPI environments. |
|
| 37 | + * Implementations must determine which environment they are in, and use the |
|
| 38 | + * appropriate method (move_uploaded_file(), rename(), or a stream |
|
| 39 | + * operation) to perform the operation. |
|
| 40 | + * |
|
| 41 | + * $targetPath may be an absolute path, or a relative path. If it is a |
|
| 42 | + * relative path, resolution should be the same as used by PHP's rename() |
|
| 43 | + * function. |
|
| 44 | + * |
|
| 45 | + * The original file or stream MUST be removed on completion. |
|
| 46 | + * |
|
| 47 | + * If this method is called more than once, any subsequent calls MUST raise |
|
| 48 | + * an exception. |
|
| 49 | + * |
|
| 50 | + * When used in an SAPI environment where $_FILES is populated, when writing |
|
| 51 | + * files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be |
|
| 52 | + * used to ensure permissions and upload status are verified correctly. |
|
| 53 | + * |
|
| 54 | + * If you wish to move to a stream, use getStream(), as SAPI operations |
|
| 55 | + * cannot guarantee writing to stream destinations. |
|
| 56 | + * |
|
| 57 | + * @see http://php.net/is_uploaded_file |
|
| 58 | + * @see http://php.net/move_uploaded_file |
|
| 59 | + * @param string $targetPath Path to which to move the uploaded file. |
|
| 60 | + * @throws \InvalidArgumentException if the $targetPath specified is invalid. |
|
| 61 | + * @throws \RuntimeException on any error during the move operation, or on |
|
| 62 | + * the second or subsequent call to the method. |
|
| 63 | + */ |
|
| 64 | + public function moveTo(string $targetPath) : void; |
|
| 65 | + /** |
|
| 66 | + * Retrieve the file size. |
|
| 67 | + * |
|
| 68 | + * Implementations SHOULD return the value stored in the "size" key of |
|
| 69 | + * the file in the $_FILES array if available, as PHP calculates this based |
|
| 70 | + * on the actual size transmitted. |
|
| 71 | + * |
|
| 72 | + * @return int|null The file size in bytes or null if unknown. |
|
| 73 | + */ |
|
| 74 | + public function getSize() : ?int; |
|
| 75 | + /** |
|
| 76 | + * Retrieve the error associated with the uploaded file. |
|
| 77 | + * |
|
| 78 | + * The return value MUST be one of PHP's UPLOAD_ERR_XXX constants. |
|
| 79 | + * |
|
| 80 | + * If the file was uploaded successfully, this method MUST return |
|
| 81 | + * UPLOAD_ERR_OK. |
|
| 82 | + * |
|
| 83 | + * Implementations SHOULD return the value stored in the "error" key of |
|
| 84 | + * the file in the $_FILES array. |
|
| 85 | + * |
|
| 86 | + * @see http://php.net/manual/en/features.file-upload.errors.php |
|
| 87 | + * @return int One of PHP's UPLOAD_ERR_XXX constants. |
|
| 88 | + */ |
|
| 89 | + public function getError() : int; |
|
| 90 | + /** |
|
| 91 | + * Retrieve the filename sent by the client. |
|
| 92 | + * |
|
| 93 | + * Do not trust the value returned by this method. A client could send |
|
| 94 | + * a malicious filename with the intention to corrupt or hack your |
|
| 95 | + * application. |
|
| 96 | + * |
|
| 97 | + * Implementations SHOULD return the value stored in the "name" key of |
|
| 98 | + * the file in the $_FILES array. |
|
| 99 | + * |
|
| 100 | + * @return string|null The filename sent by the client or null if none |
|
| 101 | + * was provided. |
|
| 102 | + */ |
|
| 103 | + public function getClientFilename() : ?string; |
|
| 104 | + /** |
|
| 105 | + * Retrieve the media type sent by the client. |
|
| 106 | + * |
|
| 107 | + * Do not trust the value returned by this method. A client could send |
|
| 108 | + * a malicious media type with the intention to corrupt or hack your |
|
| 109 | + * application. |
|
| 110 | + * |
|
| 111 | + * Implementations SHOULD return the value stored in the "type" key of |
|
| 112 | + * the file in the $_FILES array. |
|
| 113 | + * |
|
| 114 | + * @return string|null The media type sent by the client or null if none |
|
| 115 | + * was provided. |
|
| 116 | + */ |
|
| 117 | + public function getClientMediaType() : ?string; |
|
| 118 | 118 | } |
@@ -2,8 +2,7 @@ |
||
| 2 | 2 | |
| 3 | 3 | namespace OCA\FullTextSearch_Elasticsearch\Vendor\Psr\Http\Message; |
| 4 | 4 | |
| 5 | -interface ServerRequestFactoryInterface |
|
| 6 | -{ |
|
| 5 | +interface ServerRequestFactoryInterface { |
|
| 7 | 6 | /** |
| 8 | 7 | * Create a new server request. |
| 9 | 8 | * |
@@ -4,21 +4,21 @@ |
||
| 4 | 4 | |
| 5 | 5 | interface ServerRequestFactoryInterface |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * Create a new server request. |
|
| 9 | - * |
|
| 10 | - * Note that server-params are taken precisely as given - no parsing/processing |
|
| 11 | - * of the given values is performed, and, in particular, no attempt is made to |
|
| 12 | - * determine the HTTP method or URI, which must be provided explicitly. |
|
| 13 | - * |
|
| 14 | - * @param string $method The HTTP method associated with the request. |
|
| 15 | - * @param UriInterface|string $uri The URI associated with the request. If |
|
| 16 | - * the value is a string, the factory MUST create a UriInterface |
|
| 17 | - * instance based on it. |
|
| 18 | - * @param array $serverParams Array of SAPI parameters with which to seed |
|
| 19 | - * the generated request instance. |
|
| 20 | - * |
|
| 21 | - * @return ServerRequestInterface |
|
| 22 | - */ |
|
| 23 | - public function createServerRequest(string $method, $uri, array $serverParams = []) : ServerRequestInterface; |
|
| 7 | + /** |
|
| 8 | + * Create a new server request. |
|
| 9 | + * |
|
| 10 | + * Note that server-params are taken precisely as given - no parsing/processing |
|
| 11 | + * of the given values is performed, and, in particular, no attempt is made to |
|
| 12 | + * determine the HTTP method or URI, which must be provided explicitly. |
|
| 13 | + * |
|
| 14 | + * @param string $method The HTTP method associated with the request. |
|
| 15 | + * @param UriInterface|string $uri The URI associated with the request. If |
|
| 16 | + * the value is a string, the factory MUST create a UriInterface |
|
| 17 | + * instance based on it. |
|
| 18 | + * @param array $serverParams Array of SAPI parameters with which to seed |
|
| 19 | + * the generated request instance. |
|
| 20 | + * |
|
| 21 | + * @return ServerRequestInterface |
|
| 22 | + */ |
|
| 23 | + public function createServerRequest(string $method, $uri, array $serverParams = []) : ServerRequestInterface; |
|
| 24 | 24 | } |
@@ -17,8 +17,7 @@ |
||
| 17 | 17 | * be implemented such that they retain the internal state of the current |
| 18 | 18 | * message and return an instance that contains the changed state. |
| 19 | 19 | */ |
| 20 | -interface ResponseInterface extends MessageInterface |
|
| 21 | -{ |
|
| 20 | +interface ResponseInterface extends MessageInterface { |
|
| 22 | 21 | /** |
| 23 | 22 | * Gets the response status code. |
| 24 | 23 | * |
@@ -19,48 +19,48 @@ |
||
| 19 | 19 | */ |
| 20 | 20 | interface ResponseInterface extends MessageInterface |
| 21 | 21 | { |
| 22 | - /** |
|
| 23 | - * Gets the response status code. |
|
| 24 | - * |
|
| 25 | - * The status code is a 3-digit integer result code of the server's attempt |
|
| 26 | - * to understand and satisfy the request. |
|
| 27 | - * |
|
| 28 | - * @return int Status code. |
|
| 29 | - */ |
|
| 30 | - public function getStatusCode() : int; |
|
| 31 | - /** |
|
| 32 | - * Return an instance with the specified status code and, optionally, reason phrase. |
|
| 33 | - * |
|
| 34 | - * If no reason phrase is specified, implementations MAY choose to default |
|
| 35 | - * to the RFC 7231 or IANA recommended reason phrase for the response's |
|
| 36 | - * status code. |
|
| 37 | - * |
|
| 38 | - * This method MUST be implemented in such a way as to retain the |
|
| 39 | - * immutability of the message, and MUST return an instance that has the |
|
| 40 | - * updated status and reason phrase. |
|
| 41 | - * |
|
| 42 | - * @link http://tools.ietf.org/html/rfc7231#section-6 |
|
| 43 | - * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
|
| 44 | - * @param int $code The 3-digit integer result code to set. |
|
| 45 | - * @param string $reasonPhrase The reason phrase to use with the |
|
| 46 | - * provided status code; if none is provided, implementations MAY |
|
| 47 | - * use the defaults as suggested in the HTTP specification. |
|
| 48 | - * @return static |
|
| 49 | - * @throws \InvalidArgumentException For invalid status code arguments. |
|
| 50 | - */ |
|
| 51 | - public function withStatus(int $code, string $reasonPhrase = '') : ResponseInterface; |
|
| 52 | - /** |
|
| 53 | - * Gets the response reason phrase associated with the status code. |
|
| 54 | - * |
|
| 55 | - * Because a reason phrase is not a required element in a response |
|
| 56 | - * status line, the reason phrase value MAY be null. Implementations MAY |
|
| 57 | - * choose to return the default RFC 7231 recommended reason phrase (or those |
|
| 58 | - * listed in the IANA HTTP Status Code Registry) for the response's |
|
| 59 | - * status code. |
|
| 60 | - * |
|
| 61 | - * @link http://tools.ietf.org/html/rfc7231#section-6 |
|
| 62 | - * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
|
| 63 | - * @return string Reason phrase; must return an empty string if none present. |
|
| 64 | - */ |
|
| 65 | - public function getReasonPhrase() : string; |
|
| 22 | + /** |
|
| 23 | + * Gets the response status code. |
|
| 24 | + * |
|
| 25 | + * The status code is a 3-digit integer result code of the server's attempt |
|
| 26 | + * to understand and satisfy the request. |
|
| 27 | + * |
|
| 28 | + * @return int Status code. |
|
| 29 | + */ |
|
| 30 | + public function getStatusCode() : int; |
|
| 31 | + /** |
|
| 32 | + * Return an instance with the specified status code and, optionally, reason phrase. |
|
| 33 | + * |
|
| 34 | + * If no reason phrase is specified, implementations MAY choose to default |
|
| 35 | + * to the RFC 7231 or IANA recommended reason phrase for the response's |
|
| 36 | + * status code. |
|
| 37 | + * |
|
| 38 | + * This method MUST be implemented in such a way as to retain the |
|
| 39 | + * immutability of the message, and MUST return an instance that has the |
|
| 40 | + * updated status and reason phrase. |
|
| 41 | + * |
|
| 42 | + * @link http://tools.ietf.org/html/rfc7231#section-6 |
|
| 43 | + * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
|
| 44 | + * @param int $code The 3-digit integer result code to set. |
|
| 45 | + * @param string $reasonPhrase The reason phrase to use with the |
|
| 46 | + * provided status code; if none is provided, implementations MAY |
|
| 47 | + * use the defaults as suggested in the HTTP specification. |
|
| 48 | + * @return static |
|
| 49 | + * @throws \InvalidArgumentException For invalid status code arguments. |
|
| 50 | + */ |
|
| 51 | + public function withStatus(int $code, string $reasonPhrase = '') : ResponseInterface; |
|
| 52 | + /** |
|
| 53 | + * Gets the response reason phrase associated with the status code. |
|
| 54 | + * |
|
| 55 | + * Because a reason phrase is not a required element in a response |
|
| 56 | + * status line, the reason phrase value MAY be null. Implementations MAY |
|
| 57 | + * choose to return the default RFC 7231 recommended reason phrase (or those |
|
| 58 | + * listed in the IANA HTTP Status Code Registry) for the response's |
|
| 59 | + * status code. |
|
| 60 | + * |
|
| 61 | + * @link http://tools.ietf.org/html/rfc7231#section-6 |
|
| 62 | + * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml |
|
| 63 | + * @return string Reason phrase; must return an empty string if none present. |
|
| 64 | + */ |
|
| 65 | + public function getReasonPhrase() : string; |
|
| 66 | 66 | } |
@@ -40,8 +40,7 @@ |
||
| 40 | 40 | * be implemented such that they retain the internal state of the current |
| 41 | 41 | * message and return an instance that contains the changed state. |
| 42 | 42 | */ |
| 43 | -interface ServerRequestInterface extends RequestInterface |
|
| 44 | -{ |
|
| 43 | +interface ServerRequestInterface extends RequestInterface { |
|
| 45 | 44 | /** |
| 46 | 45 | * Retrieve server parameters. |
| 47 | 46 | * |
@@ -42,208 +42,208 @@ |
||
| 42 | 42 | */ |
| 43 | 43 | interface ServerRequestInterface extends RequestInterface |
| 44 | 44 | { |
| 45 | - /** |
|
| 46 | - * Retrieve server parameters. |
|
| 47 | - * |
|
| 48 | - * Retrieves data related to the incoming request environment, |
|
| 49 | - * typically derived from PHP's $_SERVER superglobal. The data IS NOT |
|
| 50 | - * REQUIRED to originate from $_SERVER. |
|
| 51 | - * |
|
| 52 | - * @return array |
|
| 53 | - */ |
|
| 54 | - public function getServerParams() : array; |
|
| 55 | - /** |
|
| 56 | - * Retrieve cookies. |
|
| 57 | - * |
|
| 58 | - * Retrieves cookies sent by the client to the server. |
|
| 59 | - * |
|
| 60 | - * The data MUST be compatible with the structure of the $_COOKIE |
|
| 61 | - * superglobal. |
|
| 62 | - * |
|
| 63 | - * @return array |
|
| 64 | - */ |
|
| 65 | - public function getCookieParams() : array; |
|
| 66 | - /** |
|
| 67 | - * Return an instance with the specified cookies. |
|
| 68 | - * |
|
| 69 | - * The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST |
|
| 70 | - * be compatible with the structure of $_COOKIE. Typically, this data will |
|
| 71 | - * be injected at instantiation. |
|
| 72 | - * |
|
| 73 | - * This method MUST NOT update the related Cookie header of the request |
|
| 74 | - * instance, nor related values in the server params. |
|
| 75 | - * |
|
| 76 | - * This method MUST be implemented in such a way as to retain the |
|
| 77 | - * immutability of the message, and MUST return an instance that has the |
|
| 78 | - * updated cookie values. |
|
| 79 | - * |
|
| 80 | - * @param array $cookies Array of key/value pairs representing cookies. |
|
| 81 | - * @return static |
|
| 82 | - */ |
|
| 83 | - public function withCookieParams(array $cookies) : ServerRequestInterface; |
|
| 84 | - /** |
|
| 85 | - * Retrieve query string arguments. |
|
| 86 | - * |
|
| 87 | - * Retrieves the deserialized query string arguments, if any. |
|
| 88 | - * |
|
| 89 | - * Note: the query params might not be in sync with the URI or server |
|
| 90 | - * params. If you need to ensure you are only getting the original |
|
| 91 | - * values, you may need to parse the query string from `getUri()->getQuery()` |
|
| 92 | - * or from the `QUERY_STRING` server param. |
|
| 93 | - * |
|
| 94 | - * @return array |
|
| 95 | - */ |
|
| 96 | - public function getQueryParams() : array; |
|
| 97 | - /** |
|
| 98 | - * Return an instance with the specified query string arguments. |
|
| 99 | - * |
|
| 100 | - * These values SHOULD remain immutable over the course of the incoming |
|
| 101 | - * request. They MAY be injected during instantiation, such as from PHP's |
|
| 102 | - * $_GET superglobal, or MAY be derived from some other value such as the |
|
| 103 | - * URI. In cases where the arguments are parsed from the URI, the data |
|
| 104 | - * MUST be compatible with what PHP's parse_str() would return for |
|
| 105 | - * purposes of how duplicate query parameters are handled, and how nested |
|
| 106 | - * sets are handled. |
|
| 107 | - * |
|
| 108 | - * Setting query string arguments MUST NOT change the URI stored by the |
|
| 109 | - * request, nor the values in the server params. |
|
| 110 | - * |
|
| 111 | - * This method MUST be implemented in such a way as to retain the |
|
| 112 | - * immutability of the message, and MUST return an instance that has the |
|
| 113 | - * updated query string arguments. |
|
| 114 | - * |
|
| 115 | - * @param array $query Array of query string arguments, typically from |
|
| 116 | - * $_GET. |
|
| 117 | - * @return static |
|
| 118 | - */ |
|
| 119 | - public function withQueryParams(array $query) : ServerRequestInterface; |
|
| 120 | - /** |
|
| 121 | - * Retrieve normalized file upload data. |
|
| 122 | - * |
|
| 123 | - * This method returns upload metadata in a normalized tree, with each leaf |
|
| 124 | - * an instance of Psr\Http\Message\UploadedFileInterface. |
|
| 125 | - * |
|
| 126 | - * These values MAY be prepared from $_FILES or the message body during |
|
| 127 | - * instantiation, or MAY be injected via withUploadedFiles(). |
|
| 128 | - * |
|
| 129 | - * @return array An array tree of UploadedFileInterface instances; an empty |
|
| 130 | - * array MUST be returned if no data is present. |
|
| 131 | - */ |
|
| 132 | - public function getUploadedFiles() : array; |
|
| 133 | - /** |
|
| 134 | - * Create a new instance with the specified uploaded files. |
|
| 135 | - * |
|
| 136 | - * This method MUST be implemented in such a way as to retain the |
|
| 137 | - * immutability of the message, and MUST return an instance that has the |
|
| 138 | - * updated body parameters. |
|
| 139 | - * |
|
| 140 | - * @param array $uploadedFiles An array tree of UploadedFileInterface instances. |
|
| 141 | - * @return static |
|
| 142 | - * @throws \InvalidArgumentException if an invalid structure is provided. |
|
| 143 | - */ |
|
| 144 | - public function withUploadedFiles(array $uploadedFiles) : ServerRequestInterface; |
|
| 145 | - /** |
|
| 146 | - * Retrieve any parameters provided in the request body. |
|
| 147 | - * |
|
| 148 | - * If the request Content-Type is either application/x-www-form-urlencoded |
|
| 149 | - * or multipart/form-data, and the request method is POST, this method MUST |
|
| 150 | - * return the contents of $_POST. |
|
| 151 | - * |
|
| 152 | - * Otherwise, this method may return any results of deserializing |
|
| 153 | - * the request body content; as parsing returns structured content, the |
|
| 154 | - * potential types MUST be arrays or objects only. A null value indicates |
|
| 155 | - * the absence of body content. |
|
| 156 | - * |
|
| 157 | - * @return null|array|object The deserialized body parameters, if any. |
|
| 158 | - * These will typically be an array or object. |
|
| 159 | - */ |
|
| 160 | - public function getParsedBody(); |
|
| 161 | - /** |
|
| 162 | - * Return an instance with the specified body parameters. |
|
| 163 | - * |
|
| 164 | - * These MAY be injected during instantiation. |
|
| 165 | - * |
|
| 166 | - * If the request Content-Type is either application/x-www-form-urlencoded |
|
| 167 | - * or multipart/form-data, and the request method is POST, use this method |
|
| 168 | - * ONLY to inject the contents of $_POST. |
|
| 169 | - * |
|
| 170 | - * The data IS NOT REQUIRED to come from $_POST, but MUST be the results of |
|
| 171 | - * deserializing the request body content. Deserialization/parsing returns |
|
| 172 | - * structured data, and, as such, this method ONLY accepts arrays or objects, |
|
| 173 | - * or a null value if nothing was available to parse. |
|
| 174 | - * |
|
| 175 | - * As an example, if content negotiation determines that the request data |
|
| 176 | - * is a JSON payload, this method could be used to create a request |
|
| 177 | - * instance with the deserialized parameters. |
|
| 178 | - * |
|
| 179 | - * This method MUST be implemented in such a way as to retain the |
|
| 180 | - * immutability of the message, and MUST return an instance that has the |
|
| 181 | - * updated body parameters. |
|
| 182 | - * |
|
| 183 | - * @param null|array|object $data The deserialized body data. This will |
|
| 184 | - * typically be in an array or object. |
|
| 185 | - * @return static |
|
| 186 | - * @throws \InvalidArgumentException if an unsupported argument type is |
|
| 187 | - * provided. |
|
| 188 | - */ |
|
| 189 | - public function withParsedBody($data) : ServerRequestInterface; |
|
| 190 | - /** |
|
| 191 | - * Retrieve attributes derived from the request. |
|
| 192 | - * |
|
| 193 | - * The request "attributes" may be used to allow injection of any |
|
| 194 | - * parameters derived from the request: e.g., the results of path |
|
| 195 | - * match operations; the results of decrypting cookies; the results of |
|
| 196 | - * deserializing non-form-encoded message bodies; etc. Attributes |
|
| 197 | - * will be application and request specific, and CAN be mutable. |
|
| 198 | - * |
|
| 199 | - * @return array Attributes derived from the request. |
|
| 200 | - */ |
|
| 201 | - public function getAttributes() : array; |
|
| 202 | - /** |
|
| 203 | - * Retrieve a single derived request attribute. |
|
| 204 | - * |
|
| 205 | - * Retrieves a single derived request attribute as described in |
|
| 206 | - * getAttributes(). If the attribute has not been previously set, returns |
|
| 207 | - * the default value as provided. |
|
| 208 | - * |
|
| 209 | - * This method obviates the need for a hasAttribute() method, as it allows |
|
| 210 | - * specifying a default value to return if the attribute is not found. |
|
| 211 | - * |
|
| 212 | - * @see getAttributes() |
|
| 213 | - * @param string $name The attribute name. |
|
| 214 | - * @param mixed $default Default value to return if the attribute does not exist. |
|
| 215 | - * @return mixed |
|
| 216 | - */ |
|
| 217 | - public function getAttribute(string $name, $default = null); |
|
| 218 | - /** |
|
| 219 | - * Return an instance with the specified derived request attribute. |
|
| 220 | - * |
|
| 221 | - * This method allows setting a single derived request attribute as |
|
| 222 | - * described in getAttributes(). |
|
| 223 | - * |
|
| 224 | - * This method MUST be implemented in such a way as to retain the |
|
| 225 | - * immutability of the message, and MUST return an instance that has the |
|
| 226 | - * updated attribute. |
|
| 227 | - * |
|
| 228 | - * @see getAttributes() |
|
| 229 | - * @param string $name The attribute name. |
|
| 230 | - * @param mixed $value The value of the attribute. |
|
| 231 | - * @return static |
|
| 232 | - */ |
|
| 233 | - public function withAttribute(string $name, $value) : ServerRequestInterface; |
|
| 234 | - /** |
|
| 235 | - * Return an instance that removes the specified derived request attribute. |
|
| 236 | - * |
|
| 237 | - * This method allows removing a single derived request attribute as |
|
| 238 | - * described in getAttributes(). |
|
| 239 | - * |
|
| 240 | - * This method MUST be implemented in such a way as to retain the |
|
| 241 | - * immutability of the message, and MUST return an instance that removes |
|
| 242 | - * the attribute. |
|
| 243 | - * |
|
| 244 | - * @see getAttributes() |
|
| 245 | - * @param string $name The attribute name. |
|
| 246 | - * @return static |
|
| 247 | - */ |
|
| 248 | - public function withoutAttribute(string $name) : ServerRequestInterface; |
|
| 45 | + /** |
|
| 46 | + * Retrieve server parameters. |
|
| 47 | + * |
|
| 48 | + * Retrieves data related to the incoming request environment, |
|
| 49 | + * typically derived from PHP's $_SERVER superglobal. The data IS NOT |
|
| 50 | + * REQUIRED to originate from $_SERVER. |
|
| 51 | + * |
|
| 52 | + * @return array |
|
| 53 | + */ |
|
| 54 | + public function getServerParams() : array; |
|
| 55 | + /** |
|
| 56 | + * Retrieve cookies. |
|
| 57 | + * |
|
| 58 | + * Retrieves cookies sent by the client to the server. |
|
| 59 | + * |
|
| 60 | + * The data MUST be compatible with the structure of the $_COOKIE |
|
| 61 | + * superglobal. |
|
| 62 | + * |
|
| 63 | + * @return array |
|
| 64 | + */ |
|
| 65 | + public function getCookieParams() : array; |
|
| 66 | + /** |
|
| 67 | + * Return an instance with the specified cookies. |
|
| 68 | + * |
|
| 69 | + * The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST |
|
| 70 | + * be compatible with the structure of $_COOKIE. Typically, this data will |
|
| 71 | + * be injected at instantiation. |
|
| 72 | + * |
|
| 73 | + * This method MUST NOT update the related Cookie header of the request |
|
| 74 | + * instance, nor related values in the server params. |
|
| 75 | + * |
|
| 76 | + * This method MUST be implemented in such a way as to retain the |
|
| 77 | + * immutability of the message, and MUST return an instance that has the |
|
| 78 | + * updated cookie values. |
|
| 79 | + * |
|
| 80 | + * @param array $cookies Array of key/value pairs representing cookies. |
|
| 81 | + * @return static |
|
| 82 | + */ |
|
| 83 | + public function withCookieParams(array $cookies) : ServerRequestInterface; |
|
| 84 | + /** |
|
| 85 | + * Retrieve query string arguments. |
|
| 86 | + * |
|
| 87 | + * Retrieves the deserialized query string arguments, if any. |
|
| 88 | + * |
|
| 89 | + * Note: the query params might not be in sync with the URI or server |
|
| 90 | + * params. If you need to ensure you are only getting the original |
|
| 91 | + * values, you may need to parse the query string from `getUri()->getQuery()` |
|
| 92 | + * or from the `QUERY_STRING` server param. |
|
| 93 | + * |
|
| 94 | + * @return array |
|
| 95 | + */ |
|
| 96 | + public function getQueryParams() : array; |
|
| 97 | + /** |
|
| 98 | + * Return an instance with the specified query string arguments. |
|
| 99 | + * |
|
| 100 | + * These values SHOULD remain immutable over the course of the incoming |
|
| 101 | + * request. They MAY be injected during instantiation, such as from PHP's |
|
| 102 | + * $_GET superglobal, or MAY be derived from some other value such as the |
|
| 103 | + * URI. In cases where the arguments are parsed from the URI, the data |
|
| 104 | + * MUST be compatible with what PHP's parse_str() would return for |
|
| 105 | + * purposes of how duplicate query parameters are handled, and how nested |
|
| 106 | + * sets are handled. |
|
| 107 | + * |
|
| 108 | + * Setting query string arguments MUST NOT change the URI stored by the |
|
| 109 | + * request, nor the values in the server params. |
|
| 110 | + * |
|
| 111 | + * This method MUST be implemented in such a way as to retain the |
|
| 112 | + * immutability of the message, and MUST return an instance that has the |
|
| 113 | + * updated query string arguments. |
|
| 114 | + * |
|
| 115 | + * @param array $query Array of query string arguments, typically from |
|
| 116 | + * $_GET. |
|
| 117 | + * @return static |
|
| 118 | + */ |
|
| 119 | + public function withQueryParams(array $query) : ServerRequestInterface; |
|
| 120 | + /** |
|
| 121 | + * Retrieve normalized file upload data. |
|
| 122 | + * |
|
| 123 | + * This method returns upload metadata in a normalized tree, with each leaf |
|
| 124 | + * an instance of Psr\Http\Message\UploadedFileInterface. |
|
| 125 | + * |
|
| 126 | + * These values MAY be prepared from $_FILES or the message body during |
|
| 127 | + * instantiation, or MAY be injected via withUploadedFiles(). |
|
| 128 | + * |
|
| 129 | + * @return array An array tree of UploadedFileInterface instances; an empty |
|
| 130 | + * array MUST be returned if no data is present. |
|
| 131 | + */ |
|
| 132 | + public function getUploadedFiles() : array; |
|
| 133 | + /** |
|
| 134 | + * Create a new instance with the specified uploaded files. |
|
| 135 | + * |
|
| 136 | + * This method MUST be implemented in such a way as to retain the |
|
| 137 | + * immutability of the message, and MUST return an instance that has the |
|
| 138 | + * updated body parameters. |
|
| 139 | + * |
|
| 140 | + * @param array $uploadedFiles An array tree of UploadedFileInterface instances. |
|
| 141 | + * @return static |
|
| 142 | + * @throws \InvalidArgumentException if an invalid structure is provided. |
|
| 143 | + */ |
|
| 144 | + public function withUploadedFiles(array $uploadedFiles) : ServerRequestInterface; |
|
| 145 | + /** |
|
| 146 | + * Retrieve any parameters provided in the request body. |
|
| 147 | + * |
|
| 148 | + * If the request Content-Type is either application/x-www-form-urlencoded |
|
| 149 | + * or multipart/form-data, and the request method is POST, this method MUST |
|
| 150 | + * return the contents of $_POST. |
|
| 151 | + * |
|
| 152 | + * Otherwise, this method may return any results of deserializing |
|
| 153 | + * the request body content; as parsing returns structured content, the |
|
| 154 | + * potential types MUST be arrays or objects only. A null value indicates |
|
| 155 | + * the absence of body content. |
|
| 156 | + * |
|
| 157 | + * @return null|array|object The deserialized body parameters, if any. |
|
| 158 | + * These will typically be an array or object. |
|
| 159 | + */ |
|
| 160 | + public function getParsedBody(); |
|
| 161 | + /** |
|
| 162 | + * Return an instance with the specified body parameters. |
|
| 163 | + * |
|
| 164 | + * These MAY be injected during instantiation. |
|
| 165 | + * |
|
| 166 | + * If the request Content-Type is either application/x-www-form-urlencoded |
|
| 167 | + * or multipart/form-data, and the request method is POST, use this method |
|
| 168 | + * ONLY to inject the contents of $_POST. |
|
| 169 | + * |
|
| 170 | + * The data IS NOT REQUIRED to come from $_POST, but MUST be the results of |
|
| 171 | + * deserializing the request body content. Deserialization/parsing returns |
|
| 172 | + * structured data, and, as such, this method ONLY accepts arrays or objects, |
|
| 173 | + * or a null value if nothing was available to parse. |
|
| 174 | + * |
|
| 175 | + * As an example, if content negotiation determines that the request data |
|
| 176 | + * is a JSON payload, this method could be used to create a request |
|
| 177 | + * instance with the deserialized parameters. |
|
| 178 | + * |
|
| 179 | + * This method MUST be implemented in such a way as to retain the |
|
| 180 | + * immutability of the message, and MUST return an instance that has the |
|
| 181 | + * updated body parameters. |
|
| 182 | + * |
|
| 183 | + * @param null|array|object $data The deserialized body data. This will |
|
| 184 | + * typically be in an array or object. |
|
| 185 | + * @return static |
|
| 186 | + * @throws \InvalidArgumentException if an unsupported argument type is |
|
| 187 | + * provided. |
|
| 188 | + */ |
|
| 189 | + public function withParsedBody($data) : ServerRequestInterface; |
|
| 190 | + /** |
|
| 191 | + * Retrieve attributes derived from the request. |
|
| 192 | + * |
|
| 193 | + * The request "attributes" may be used to allow injection of any |
|
| 194 | + * parameters derived from the request: e.g., the results of path |
|
| 195 | + * match operations; the results of decrypting cookies; the results of |
|
| 196 | + * deserializing non-form-encoded message bodies; etc. Attributes |
|
| 197 | + * will be application and request specific, and CAN be mutable. |
|
| 198 | + * |
|
| 199 | + * @return array Attributes derived from the request. |
|
| 200 | + */ |
|
| 201 | + public function getAttributes() : array; |
|
| 202 | + /** |
|
| 203 | + * Retrieve a single derived request attribute. |
|
| 204 | + * |
|
| 205 | + * Retrieves a single derived request attribute as described in |
|
| 206 | + * getAttributes(). If the attribute has not been previously set, returns |
|
| 207 | + * the default value as provided. |
|
| 208 | + * |
|
| 209 | + * This method obviates the need for a hasAttribute() method, as it allows |
|
| 210 | + * specifying a default value to return if the attribute is not found. |
|
| 211 | + * |
|
| 212 | + * @see getAttributes() |
|
| 213 | + * @param string $name The attribute name. |
|
| 214 | + * @param mixed $default Default value to return if the attribute does not exist. |
|
| 215 | + * @return mixed |
|
| 216 | + */ |
|
| 217 | + public function getAttribute(string $name, $default = null); |
|
| 218 | + /** |
|
| 219 | + * Return an instance with the specified derived request attribute. |
|
| 220 | + * |
|
| 221 | + * This method allows setting a single derived request attribute as |
|
| 222 | + * described in getAttributes(). |
|
| 223 | + * |
|
| 224 | + * This method MUST be implemented in such a way as to retain the |
|
| 225 | + * immutability of the message, and MUST return an instance that has the |
|
| 226 | + * updated attribute. |
|
| 227 | + * |
|
| 228 | + * @see getAttributes() |
|
| 229 | + * @param string $name The attribute name. |
|
| 230 | + * @param mixed $value The value of the attribute. |
|
| 231 | + * @return static |
|
| 232 | + */ |
|
| 233 | + public function withAttribute(string $name, $value) : ServerRequestInterface; |
|
| 234 | + /** |
|
| 235 | + * Return an instance that removes the specified derived request attribute. |
|
| 236 | + * |
|
| 237 | + * This method allows removing a single derived request attribute as |
|
| 238 | + * described in getAttributes(). |
|
| 239 | + * |
|
| 240 | + * This method MUST be implemented in such a way as to retain the |
|
| 241 | + * immutability of the message, and MUST return an instance that removes |
|
| 242 | + * the attribute. |
|
| 243 | + * |
|
| 244 | + * @see getAttributes() |
|
| 245 | + * @param string $name The attribute name. |
|
| 246 | + * @return static |
|
| 247 | + */ |
|
| 248 | + public function withoutAttribute(string $name) : ServerRequestInterface; |
|
| 249 | 249 | } |
@@ -2,8 +2,7 @@ |
||
| 2 | 2 | |
| 3 | 3 | namespace OCA\FullTextSearch_Elasticsearch\Vendor\Psr\Http\Message; |
| 4 | 4 | |
| 5 | -interface UriFactoryInterface |
|
| 6 | -{ |
|
| 5 | +interface UriFactoryInterface { |
|
| 7 | 6 | /** |
| 8 | 7 | * Create a new URI. |
| 9 | 8 | * |
@@ -4,14 +4,14 @@ |
||
| 4 | 4 | |
| 5 | 5 | interface UriFactoryInterface |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * Create a new URI. |
|
| 9 | - * |
|
| 10 | - * @param string $uri |
|
| 11 | - * |
|
| 12 | - * @return UriInterface |
|
| 13 | - * |
|
| 14 | - * @throws \InvalidArgumentException If the given URI cannot be parsed. |
|
| 15 | - */ |
|
| 16 | - public function createUri(string $uri = '') : UriInterface; |
|
| 7 | + /** |
|
| 8 | + * Create a new URI. |
|
| 9 | + * |
|
| 10 | + * @param string $uri |
|
| 11 | + * |
|
| 12 | + * @return UriInterface |
|
| 13 | + * |
|
| 14 | + * @throws \InvalidArgumentException If the given URI cannot be parsed. |
|
| 15 | + */ |
|
| 16 | + public function createUri(string $uri = '') : UriInterface; |
|
| 17 | 17 | } |
@@ -2,8 +2,7 @@ |
||
| 2 | 2 | |
| 3 | 3 | namespace OCA\FullTextSearch_Elasticsearch\Vendor\Psr\Http\Message; |
| 4 | 4 | |
| 5 | -interface ResponseFactoryInterface |
|
| 6 | -{ |
|
| 5 | +interface ResponseFactoryInterface { |
|
| 7 | 6 | /** |
| 8 | 7 | * Create a new response. |
| 9 | 8 | * |
@@ -4,15 +4,15 @@ |
||
| 4 | 4 | |
| 5 | 5 | interface ResponseFactoryInterface |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * Create a new response. |
|
| 9 | - * |
|
| 10 | - * @param int $code HTTP status code; defaults to 200 |
|
| 11 | - * @param string $reasonPhrase Reason phrase to associate with status code |
|
| 12 | - * in generated response; if none is provided implementations MAY use |
|
| 13 | - * the defaults as suggested in the HTTP specification. |
|
| 14 | - * |
|
| 15 | - * @return ResponseInterface |
|
| 16 | - */ |
|
| 17 | - public function createResponse(int $code = 200, string $reasonPhrase = '') : ResponseInterface; |
|
| 7 | + /** |
|
| 8 | + * Create a new response. |
|
| 9 | + * |
|
| 10 | + * @param int $code HTTP status code; defaults to 200 |
|
| 11 | + * @param string $reasonPhrase Reason phrase to associate with status code |
|
| 12 | + * in generated response; if none is provided implementations MAY use |
|
| 13 | + * the defaults as suggested in the HTTP specification. |
|
| 14 | + * |
|
| 15 | + * @return ResponseInterface |
|
| 16 | + */ |
|
| 17 | + public function createResponse(int $code = 200, string $reasonPhrase = '') : ResponseInterface; |
|
| 18 | 18 | } |
@@ -9,8 +9,7 @@ |
||
| 9 | 9 | * a wrapper around the most common operations, including serialization of |
| 10 | 10 | * the entire stream to a string. |
| 11 | 11 | */ |
| 12 | -interface StreamInterface |
|
| 13 | -{ |
|
| 12 | +interface StreamInterface { |
|
| 14 | 13 | /** |
| 15 | 14 | * Reads all data from the stream into a string, from the beginning to end. |
| 16 | 15 | * |
@@ -11,134 +11,134 @@ |
||
| 11 | 11 | */ |
| 12 | 12 | interface StreamInterface |
| 13 | 13 | { |
| 14 | - /** |
|
| 15 | - * Reads all data from the stream into a string, from the beginning to end. |
|
| 16 | - * |
|
| 17 | - * This method MUST attempt to seek to the beginning of the stream before |
|
| 18 | - * reading data and read the stream until the end is reached. |
|
| 19 | - * |
|
| 20 | - * Warning: This could attempt to load a large amount of data into memory. |
|
| 21 | - * |
|
| 22 | - * This method MUST NOT raise an exception in order to conform with PHP's |
|
| 23 | - * string casting operations. |
|
| 24 | - * |
|
| 25 | - * @see http://php.net/manual/en/language.oop5.magic.php#object.tostring |
|
| 26 | - * @return string |
|
| 27 | - */ |
|
| 28 | - public function __toString() : string; |
|
| 29 | - /** |
|
| 30 | - * Closes the stream and any underlying resources. |
|
| 31 | - * |
|
| 32 | - * @return void |
|
| 33 | - */ |
|
| 34 | - public function close() : void; |
|
| 35 | - /** |
|
| 36 | - * Separates any underlying resources from the stream. |
|
| 37 | - * |
|
| 38 | - * After the stream has been detached, the stream is in an unusable state. |
|
| 39 | - * |
|
| 40 | - * @return resource|null Underlying PHP stream, if any |
|
| 41 | - */ |
|
| 42 | - public function detach(); |
|
| 43 | - /** |
|
| 44 | - * Get the size of the stream if known. |
|
| 45 | - * |
|
| 46 | - * @return int|null Returns the size in bytes if known, or null if unknown. |
|
| 47 | - */ |
|
| 48 | - public function getSize() : ?int; |
|
| 49 | - /** |
|
| 50 | - * Returns the current position of the file read/write pointer |
|
| 51 | - * |
|
| 52 | - * @return int Position of the file pointer |
|
| 53 | - * @throws \RuntimeException on error. |
|
| 54 | - */ |
|
| 55 | - public function tell() : int; |
|
| 56 | - /** |
|
| 57 | - * Returns true if the stream is at the end of the stream. |
|
| 58 | - * |
|
| 59 | - * @return bool |
|
| 60 | - */ |
|
| 61 | - public function eof() : bool; |
|
| 62 | - /** |
|
| 63 | - * Returns whether or not the stream is seekable. |
|
| 64 | - * |
|
| 65 | - * @return bool |
|
| 66 | - */ |
|
| 67 | - public function isSeekable() : bool; |
|
| 68 | - /** |
|
| 69 | - * Seek to a position in the stream. |
|
| 70 | - * |
|
| 71 | - * @link http://www.php.net/manual/en/function.fseek.php |
|
| 72 | - * @param int $offset Stream offset |
|
| 73 | - * @param int $whence Specifies how the cursor position will be calculated |
|
| 74 | - * based on the seek offset. Valid values are identical to the built-in |
|
| 75 | - * PHP $whence values for `fseek()`. SEEK_SET: Set position equal to |
|
| 76 | - * offset bytes SEEK_CUR: Set position to current location plus offset |
|
| 77 | - * SEEK_END: Set position to end-of-stream plus offset. |
|
| 78 | - * @throws \RuntimeException on failure. |
|
| 79 | - */ |
|
| 80 | - public function seek(int $offset, int $whence = \SEEK_SET) : void; |
|
| 81 | - /** |
|
| 82 | - * Seek to the beginning of the stream. |
|
| 83 | - * |
|
| 84 | - * If the stream is not seekable, this method will raise an exception; |
|
| 85 | - * otherwise, it will perform a seek(0). |
|
| 86 | - * |
|
| 87 | - * @see seek() |
|
| 88 | - * @link http://www.php.net/manual/en/function.fseek.php |
|
| 89 | - * @throws \RuntimeException on failure. |
|
| 90 | - */ |
|
| 91 | - public function rewind() : void; |
|
| 92 | - /** |
|
| 93 | - * Returns whether or not the stream is writable. |
|
| 94 | - * |
|
| 95 | - * @return bool |
|
| 96 | - */ |
|
| 97 | - public function isWritable() : bool; |
|
| 98 | - /** |
|
| 99 | - * Write data to the stream. |
|
| 100 | - * |
|
| 101 | - * @param string $string The string that is to be written. |
|
| 102 | - * @return int Returns the number of bytes written to the stream. |
|
| 103 | - * @throws \RuntimeException on failure. |
|
| 104 | - */ |
|
| 105 | - public function write(string $string) : int; |
|
| 106 | - /** |
|
| 107 | - * Returns whether or not the stream is readable. |
|
| 108 | - * |
|
| 109 | - * @return bool |
|
| 110 | - */ |
|
| 111 | - public function isReadable() : bool; |
|
| 112 | - /** |
|
| 113 | - * Read data from the stream. |
|
| 114 | - * |
|
| 115 | - * @param int $length Read up to $length bytes from the object and return |
|
| 116 | - * them. Fewer than $length bytes may be returned if underlying stream |
|
| 117 | - * call returns fewer bytes. |
|
| 118 | - * @return string Returns the data read from the stream, or an empty string |
|
| 119 | - * if no bytes are available. |
|
| 120 | - * @throws \RuntimeException if an error occurs. |
|
| 121 | - */ |
|
| 122 | - public function read(int $length) : string; |
|
| 123 | - /** |
|
| 124 | - * Returns the remaining contents in a string |
|
| 125 | - * |
|
| 126 | - * @return string |
|
| 127 | - * @throws \RuntimeException if unable to read or an error occurs while |
|
| 128 | - * reading. |
|
| 129 | - */ |
|
| 130 | - public function getContents() : string; |
|
| 131 | - /** |
|
| 132 | - * Get stream metadata as an associative array or retrieve a specific key. |
|
| 133 | - * |
|
| 134 | - * The keys returned are identical to the keys returned from PHP's |
|
| 135 | - * stream_get_meta_data() function. |
|
| 136 | - * |
|
| 137 | - * @link http://php.net/manual/en/function.stream-get-meta-data.php |
|
| 138 | - * @param string|null $key Specific metadata to retrieve. |
|
| 139 | - * @return array|mixed|null Returns an associative array if no key is |
|
| 140 | - * provided. Returns a specific key value if a key is provided and the |
|
| 141 | - * value is found, or null if the key is not found. |
|
| 142 | - */ |
|
| 143 | - public function getMetadata(?string $key = null); |
|
| 14 | + /** |
|
| 15 | + * Reads all data from the stream into a string, from the beginning to end. |
|
| 16 | + * |
|
| 17 | + * This method MUST attempt to seek to the beginning of the stream before |
|
| 18 | + * reading data and read the stream until the end is reached. |
|
| 19 | + * |
|
| 20 | + * Warning: This could attempt to load a large amount of data into memory. |
|
| 21 | + * |
|
| 22 | + * This method MUST NOT raise an exception in order to conform with PHP's |
|
| 23 | + * string casting operations. |
|
| 24 | + * |
|
| 25 | + * @see http://php.net/manual/en/language.oop5.magic.php#object.tostring |
|
| 26 | + * @return string |
|
| 27 | + */ |
|
| 28 | + public function __toString() : string; |
|
| 29 | + /** |
|
| 30 | + * Closes the stream and any underlying resources. |
|
| 31 | + * |
|
| 32 | + * @return void |
|
| 33 | + */ |
|
| 34 | + public function close() : void; |
|
| 35 | + /** |
|
| 36 | + * Separates any underlying resources from the stream. |
|
| 37 | + * |
|
| 38 | + * After the stream has been detached, the stream is in an unusable state. |
|
| 39 | + * |
|
| 40 | + * @return resource|null Underlying PHP stream, if any |
|
| 41 | + */ |
|
| 42 | + public function detach(); |
|
| 43 | + /** |
|
| 44 | + * Get the size of the stream if known. |
|
| 45 | + * |
|
| 46 | + * @return int|null Returns the size in bytes if known, or null if unknown. |
|
| 47 | + */ |
|
| 48 | + public function getSize() : ?int; |
|
| 49 | + /** |
|
| 50 | + * Returns the current position of the file read/write pointer |
|
| 51 | + * |
|
| 52 | + * @return int Position of the file pointer |
|
| 53 | + * @throws \RuntimeException on error. |
|
| 54 | + */ |
|
| 55 | + public function tell() : int; |
|
| 56 | + /** |
|
| 57 | + * Returns true if the stream is at the end of the stream. |
|
| 58 | + * |
|
| 59 | + * @return bool |
|
| 60 | + */ |
|
| 61 | + public function eof() : bool; |
|
| 62 | + /** |
|
| 63 | + * Returns whether or not the stream is seekable. |
|
| 64 | + * |
|
| 65 | + * @return bool |
|
| 66 | + */ |
|
| 67 | + public function isSeekable() : bool; |
|
| 68 | + /** |
|
| 69 | + * Seek to a position in the stream. |
|
| 70 | + * |
|
| 71 | + * @link http://www.php.net/manual/en/function.fseek.php |
|
| 72 | + * @param int $offset Stream offset |
|
| 73 | + * @param int $whence Specifies how the cursor position will be calculated |
|
| 74 | + * based on the seek offset. Valid values are identical to the built-in |
|
| 75 | + * PHP $whence values for `fseek()`. SEEK_SET: Set position equal to |
|
| 76 | + * offset bytes SEEK_CUR: Set position to current location plus offset |
|
| 77 | + * SEEK_END: Set position to end-of-stream plus offset. |
|
| 78 | + * @throws \RuntimeException on failure. |
|
| 79 | + */ |
|
| 80 | + public function seek(int $offset, int $whence = \SEEK_SET) : void; |
|
| 81 | + /** |
|
| 82 | + * Seek to the beginning of the stream. |
|
| 83 | + * |
|
| 84 | + * If the stream is not seekable, this method will raise an exception; |
|
| 85 | + * otherwise, it will perform a seek(0). |
|
| 86 | + * |
|
| 87 | + * @see seek() |
|
| 88 | + * @link http://www.php.net/manual/en/function.fseek.php |
|
| 89 | + * @throws \RuntimeException on failure. |
|
| 90 | + */ |
|
| 91 | + public function rewind() : void; |
|
| 92 | + /** |
|
| 93 | + * Returns whether or not the stream is writable. |
|
| 94 | + * |
|
| 95 | + * @return bool |
|
| 96 | + */ |
|
| 97 | + public function isWritable() : bool; |
|
| 98 | + /** |
|
| 99 | + * Write data to the stream. |
|
| 100 | + * |
|
| 101 | + * @param string $string The string that is to be written. |
|
| 102 | + * @return int Returns the number of bytes written to the stream. |
|
| 103 | + * @throws \RuntimeException on failure. |
|
| 104 | + */ |
|
| 105 | + public function write(string $string) : int; |
|
| 106 | + /** |
|
| 107 | + * Returns whether or not the stream is readable. |
|
| 108 | + * |
|
| 109 | + * @return bool |
|
| 110 | + */ |
|
| 111 | + public function isReadable() : bool; |
|
| 112 | + /** |
|
| 113 | + * Read data from the stream. |
|
| 114 | + * |
|
| 115 | + * @param int $length Read up to $length bytes from the object and return |
|
| 116 | + * them. Fewer than $length bytes may be returned if underlying stream |
|
| 117 | + * call returns fewer bytes. |
|
| 118 | + * @return string Returns the data read from the stream, or an empty string |
|
| 119 | + * if no bytes are available. |
|
| 120 | + * @throws \RuntimeException if an error occurs. |
|
| 121 | + */ |
|
| 122 | + public function read(int $length) : string; |
|
| 123 | + /** |
|
| 124 | + * Returns the remaining contents in a string |
|
| 125 | + * |
|
| 126 | + * @return string |
|
| 127 | + * @throws \RuntimeException if unable to read or an error occurs while |
|
| 128 | + * reading. |
|
| 129 | + */ |
|
| 130 | + public function getContents() : string; |
|
| 131 | + /** |
|
| 132 | + * Get stream metadata as an associative array or retrieve a specific key. |
|
| 133 | + * |
|
| 134 | + * The keys returned are identical to the keys returned from PHP's |
|
| 135 | + * stream_get_meta_data() function. |
|
| 136 | + * |
|
| 137 | + * @link http://php.net/manual/en/function.stream-get-meta-data.php |
|
| 138 | + * @param string|null $key Specific metadata to retrieve. |
|
| 139 | + * @return array|mixed|null Returns an associative array if no key is |
|
| 140 | + * provided. Returns a specific key value if a key is provided and the |
|
| 141 | + * value is found, or null if the key is not found. |
|
| 142 | + */ |
|
| 143 | + public function getMetadata(?string $key = null); |
|
| 144 | 144 | } |
@@ -2,8 +2,7 @@ |
||
| 2 | 2 | |
| 3 | 3 | namespace OCA\FullTextSearch_Elasticsearch\Vendor\Psr\Http\Message; |
| 4 | 4 | |
| 5 | -interface RequestFactoryInterface |
|
| 6 | -{ |
|
| 5 | +interface RequestFactoryInterface { |
|
| 7 | 6 | /** |
| 8 | 7 | * Create a new request. |
| 9 | 8 | * |
@@ -4,15 +4,15 @@ |
||
| 4 | 4 | |
| 5 | 5 | interface RequestFactoryInterface |
| 6 | 6 | { |
| 7 | - /** |
|
| 8 | - * Create a new request. |
|
| 9 | - * |
|
| 10 | - * @param string $method The HTTP method associated with the request. |
|
| 11 | - * @param UriInterface|string $uri The URI associated with the request. If |
|
| 12 | - * the value is a string, the factory MUST create a UriInterface |
|
| 13 | - * instance based on it. |
|
| 14 | - * |
|
| 15 | - * @return RequestInterface |
|
| 16 | - */ |
|
| 17 | - public function createRequest(string $method, $uri) : RequestInterface; |
|
| 7 | + /** |
|
| 8 | + * Create a new request. |
|
| 9 | + * |
|
| 10 | + * @param string $method The HTTP method associated with the request. |
|
| 11 | + * @param UriInterface|string $uri The URI associated with the request. If |
|
| 12 | + * the value is a string, the factory MUST create a UriInterface |
|
| 13 | + * instance based on it. |
|
| 14 | + * |
|
| 15 | + * @return RequestInterface |
|
| 16 | + */ |
|
| 17 | + public function createRequest(string $method, $uri) : RequestInterface; |
|
| 18 | 18 | } |
@@ -11,8 +11,7 @@ |
||
| 11 | 11 | * - Request is invalid (e.g. method is missing) |
| 12 | 12 | * - Runtime request errors (e.g. the body stream is not seekable) |
| 13 | 13 | */ |
| 14 | -interface RequestExceptionInterface extends ClientExceptionInterface |
|
| 15 | -{ |
|
| 14 | +interface RequestExceptionInterface extends ClientExceptionInterface { |
|
| 16 | 15 | /** |
| 17 | 16 | * Returns the request. |
| 18 | 17 | * |
@@ -12,12 +12,12 @@ |
||
| 12 | 12 | */ |
| 13 | 13 | interface RequestExceptionInterface extends ClientExceptionInterface |
| 14 | 14 | { |
| 15 | - /** |
|
| 16 | - * Returns the request. |
|
| 17 | - * |
|
| 18 | - * The request object MAY be a different object from the one passed to ClientInterface::sendRequest() |
|
| 19 | - * |
|
| 20 | - * @return RequestInterface |
|
| 21 | - */ |
|
| 22 | - public function getRequest() : RequestInterface; |
|
| 15 | + /** |
|
| 16 | + * Returns the request. |
|
| 17 | + * |
|
| 18 | + * The request object MAY be a different object from the one passed to ClientInterface::sendRequest() |
|
| 19 | + * |
|
| 20 | + * @return RequestInterface |
|
| 21 | + */ |
|
| 22 | + public function getRequest() : RequestInterface; |
|
| 23 | 23 | } |