Blame view

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