MessageInterface.php
2 years ago
RequestInterface.php
2 years ago
ResponseInterface.php
2 years ago
ServerRequestInterface.php
2 years ago
StreamInterface.php
2 years ago
UploadedFileInterface.php
2 years ago
UriInterface.php
2 years ago
UploadedFileInterface.php
126 lines
| 1 | <?php |
| 2 | |
| 3 | declare(strict_types=1); |
| 4 | |
| 5 | namespace SureCartVendors\Psr\Http\Message; |
| 6 | |
| 7 | /** |
| 8 | * Value object representing a file uploaded through an HTTP request. |
| 9 | * |
| 10 | * Instances of this interface are considered immutable; all methods that |
| 11 | * might change state MUST be implemented such that they retain the internal |
| 12 | * state of the current instance and return an instance that contains the |
| 13 | * changed state. |
| 14 | */ |
| 15 | interface UploadedFileInterface |
| 16 | { |
| 17 | /** |
| 18 | * Retrieve a stream representing the uploaded file. |
| 19 | * |
| 20 | * This method MUST return a StreamInterface instance, representing the |
| 21 | * uploaded file. The purpose of this method is to allow utilizing native PHP |
| 22 | * stream functionality to manipulate the file upload, such as |
| 23 | * stream_copy_to_stream() (though the result will need to be decorated in a |
| 24 | * native PHP stream wrapper to work with such functions). |
| 25 | * |
| 26 | * If the moveTo() method has been called previously, this method MUST raise |
| 27 | * an exception. |
| 28 | * |
| 29 | * @return StreamInterface Stream representation of the uploaded file. |
| 30 | * @throws \RuntimeException in cases when no stream is available or can be |
| 31 | * created. |
| 32 | */ |
| 33 | public function getStream(); |
| 34 | |
| 35 | /** |
| 36 | * Move the uploaded file to a new location. |
| 37 | * |
| 38 | * Use this method as an alternative to move_uploaded_file(). This method is |
| 39 | * guaranteed to work in both SAPI and non-SAPI environments. |
| 40 | * Implementations must determine which environment they are in, and use the |
| 41 | * appropriate method (move_uploaded_file(), rename(), or a stream |
| 42 | * operation) to perform the operation. |
| 43 | * |
| 44 | * $targetPath may be an absolute path, or a relative path. If it is a |
| 45 | * relative path, resolution should be the same as used by PHP's rename() |
| 46 | * function. |
| 47 | * |
| 48 | * The original file or stream MUST be removed on completion. |
| 49 | * |
| 50 | * If this method is called more than once, any subsequent calls MUST raise |
| 51 | * an exception. |
| 52 | * |
| 53 | * When used in an SAPI environment where $_FILES is populated, when writing |
| 54 | * files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be |
| 55 | * used to ensure permissions and upload status are verified correctly. |
| 56 | * |
| 57 | * If you wish to move to a stream, use getStream(), as SAPI operations |
| 58 | * cannot guarantee writing to stream destinations. |
| 59 | * |
| 60 | * @see http://php.net/is_uploaded_file |
| 61 | * @see http://php.net/move_uploaded_file |
| 62 | * @param string $targetPath Path to which to move the uploaded file. |
| 63 | * @throws \InvalidArgumentException if the $targetPath specified is invalid. |
| 64 | * @throws \RuntimeException on any error during the move operation, or on |
| 65 | * the second or subsequent call to the method. |
| 66 | */ |
| 67 | public function moveTo(string $targetPath); |
| 68 | |
| 69 | /** |
| 70 | * Retrieve the file size. |
| 71 | * |
| 72 | * Implementations SHOULD return the value stored in the "size" key of |
| 73 | * the file in the $_FILES array if available, as PHP calculates this based |
| 74 | * on the actual size transmitted. |
| 75 | * |
| 76 | * @return int|null The file size in bytes or null if unknown. |
| 77 | */ |
| 78 | public function getSize(); |
| 79 | |
| 80 | /** |
| 81 | * Retrieve the error associated with the uploaded file. |
| 82 | * |
| 83 | * The return value MUST be one of PHP's UPLOAD_ERR_XXX constants. |
| 84 | * |
| 85 | * If the file was uploaded successfully, this method MUST return |
| 86 | * UPLOAD_ERR_OK. |
| 87 | * |
| 88 | * Implementations SHOULD return the value stored in the "error" key of |
| 89 | * the file in the $_FILES array. |
| 90 | * |
| 91 | * @see http://php.net/manual/en/features.file-upload.errors.php |
| 92 | * @return int One of PHP's UPLOAD_ERR_XXX constants. |
| 93 | */ |
| 94 | public function getError(); |
| 95 | |
| 96 | /** |
| 97 | * Retrieve the filename sent by the client. |
| 98 | * |
| 99 | * Do not trust the value returned by this method. A client could send |
| 100 | * a malicious filename with the intention to corrupt or hack your |
| 101 | * application. |
| 102 | * |
| 103 | * Implementations SHOULD return the value stored in the "name" key of |
| 104 | * the file in the $_FILES array. |
| 105 | * |
| 106 | * @return string|null The filename sent by the client or null if none |
| 107 | * was provided. |
| 108 | */ |
| 109 | public function getClientFilename(); |
| 110 | |
| 111 | /** |
| 112 | * Retrieve the media type sent by the client. |
| 113 | * |
| 114 | * Do not trust the value returned by this method. A client could send |
| 115 | * a malicious media type with the intention to corrupt or hack your |
| 116 | * application. |
| 117 | * |
| 118 | * Implementations SHOULD return the value stored in the "type" key of |
| 119 | * the file in the $_FILES array. |
| 120 | * |
| 121 | * @return string|null The media type sent by the client or null if none |
| 122 | * was provided. |
| 123 | */ |
| 124 | public function getClientMediaType(); |
| 125 | } |
| 126 |