Skip to content

Commit 0923411

Browse files
andreiaandreia
committed
StyleCI
1 parent f441caa commit 0923411

File tree

1 file changed

+28
-36
lines changed

1 file changed

+28
-36
lines changed

‎src/Http/Controllers/UppyS3MultipartController.php‎

Lines changed: 28 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ public function __construct()
2323
/**
2424
* Encode URI.
2525
*
26-
* @param string $str
27-
* @return string The encoded URI string
26+
* @param string $str
27+
*
28+
* @return string The encoded URI string
2829
*/
2930
protected function encodeURIComponent(string $str)
3031
{
@@ -40,7 +41,7 @@ protected function encodeURIComponent(string $str)
4041
/**
4142
* Add the preflight response header so it's possible to use the X-CSRF-TOKEN on Uppy request header.
4243
*
43-
* @return string JSON with 204 status no content
44+
* @return string JSON with 204 status no content
4445
*/
4546
public function createPreflightHeader(Request $request)
4647
{
@@ -57,7 +58,6 @@ public function createPreflightHeader(Request $request)
5758
*
5859
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#createmultipartupload S3 Syntax
5960
* @see https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html S3 Syntax
60-
*
6161
* $result = $client->createMultipartUpload([
6262
* 'ACL' => 'private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
6363
* 'Bucket' => '<string>', // REQUIRED
@@ -89,17 +89,16 @@ public function createPreflightHeader(Request $request)
8989
* 'Tagging' => '<string>',
9090
* 'WebsiteRedirectLocation' => '<string>',
9191
* ]);
92-
*
9392
* @see https://github.com/transloadit/uppy/blob/master/packages/%40uppy/aws-s3-multipart/src/index.js Uppy call to this endpoint
94-
*
9593
* return this.#client.post('s3/multipart', {
9694
* filename: file.name,
9795
* type: file.type,
9896
* metadata,
9997
* }, { signal }).then(assertServerError)
10098
*
101-
* @param \Illuminate\Http\Request $request
102-
* @return string JSON with the uploaded parts
99+
* @param \Illuminate\Http\Request $request
100+
*
101+
* @return string JSON with the uploaded parts
103102
*/
104103
public function createMultipartUpload(Request $request)
105104
{
@@ -134,9 +133,10 @@ public function createMultipartUpload(Request $request)
134133
/**
135134
* List the multipart uploaded parts.
136135
*
137-
* @param \Illuminate\Http\Request $request
138-
* @param string $uploadId
139-
* @return string JSON with the uploaded parts
136+
* @param \Illuminate\Http\Request $request
137+
* @param string $uploadId
138+
*
139+
* @return string JSON with the uploaded parts
140140
*/
141141
public function getUploadedParts(Request $request, string $uploadId)
142142
{
@@ -151,9 +151,7 @@ public function getUploadedParts(Request $request, string $uploadId)
151151
/**
152152
* Get the uploaded parts. Retry the part if it's truncated.
153153
*
154-
*
155154
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#listparts S3 Syntax
156-
*
157155
* $result = $client->listParts([
158156
* 'Bucket' => '<string>', // REQUIRED
159157
* 'ExpectedBucketOwner' => '<string>',
@@ -163,15 +161,14 @@ public function getUploadedParts(Request $request, string $uploadId)
163161
* 'RequestPayer' => 'requester',
164162
* 'UploadId' => '<string>', // REQUIRED
165163
* ]);
166-
*
167164
* @see https://github.com/transloadit/uppy/blob/master/packages/%40uppy/aws-s3-multipart/src/index.js Uppy call to this endpoint
168-
*
169165
* return this.#client.get(`s3/multipart/${uploadId}?key=${filename}`, { signal })
170166
* .then(assertServerError)
171167
*
172-
* @param string $key
173-
* @param string $uploadId
174-
* @param int $partIndex
168+
* @param string $key
169+
* @param string $uploadId
170+
* @param int $partIndex
171+
*
175172
* @return \Illuminate\Support\Collection
176173
*/
177174
private function listPartsPage(string $key, string $uploadId, int $partIndex, $parts = null)
@@ -201,7 +198,6 @@ private function listPartsPage(string $key, string $uploadId, int $partIndex, $p
201198
* Completes a multipart upload by assembling previously uploaded parts.
202199
*
203200
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#completemultipartupload S3 Syntax
204-
*
205201
* $result = $client->completeMultipartUpload([
206202
* 'Bucket' => '<string>', // REQUIRED
207203
* 'ExpectedBucketOwner' => '<string>',
@@ -218,14 +214,13 @@ private function listPartsPage(string $key, string $uploadId, int $partIndex, $p
218214
* 'RequestPayer' => 'requester',
219215
* 'UploadId' => '<string>', // REQUIRED
220216
* ]);
221-
*
222217
* @see https://github.com/transloadit/uppy/blob/master/packages/%40uppy/aws-s3-multipart/src/index.js Uppy call to this endpoint
223-
*
224218
* return this.#client.post(`s3/multipart/${uploadIdEnc}/complete?key=${filename}`, { parts }, { signal })
225219
* .then(assertServerError)
226220
*
227-
* @param \Illuminate\Http\Request $request
228-
* @param string $uploadId
221+
* @param \Illuminate\Http\Request $request
222+
* @param string $uploadId
223+
*
229224
* @return string
230225
*/
231226
public function completeMultipartUpload(Request $request, string $uploadId)
@@ -264,23 +259,21 @@ public function completeMultipartUpload(Request $request, string $uploadId)
264259
* Aborts a multipart upload, deleting the uploaded parts.
265260
*
266261
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#abortmultipartupload S3 Syntax
267-
*
268262
* $result = $client->abortMultipartUpload([
269263
* 'Bucket' => '<string>', // REQUIRED
270264
* 'ExpectedBucketOwner' => '<string>',
271265
* 'Key' => '<string>', // REQUIRED
272266
* 'RequestPayer' => 'requester',
273267
* 'UploadId' => '<string>', // REQUIRED
274268
* ]);
275-
*
276269
* @see https://github.com/transloadit/uppy/blob/master/packages/%40uppy/aws-s3-multipart/src/index.js Uppy call to this endpoint
277-
*
278270
* return this.#client.delete(`s3/multipart/${uploadIdEnc}?key=${filename}`, undefined, { signal })
279271
* .then(assertServerError)
280272
*
281-
* @param \Illuminate\Http\Request $request
282-
* @param string $uploadId
283-
* @return string JSON empty
273+
* @param \Illuminate\Http\Request $request
274+
* @param string $uploadId
275+
*
276+
* @return string JSON empty
284277
*/
285278
public function abortMultipartUpload(Request $request, string $uploadId)
286279
{
@@ -299,8 +292,9 @@ public function abortMultipartUpload(Request $request, string $uploadId)
299292
/**
300293
* Presign a URL for a part.
301294
*
302-
* @param \Illuminate\Http\Request $request
303-
* @return string JSON with the URL
295+
* @param \Illuminate\Http\Request $request
296+
*
297+
* @return string JSON with the URL
304298
*/
305299
public function signPartUpload(Request $request)
306300
{
@@ -316,7 +310,6 @@ public function signPartUpload(Request $request)
316310
* Get the presigned URL for a part.
317311
*
318312
* @see https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-s3-2006-03-01.html#uploadpart S3 Syntax
319-
*
320313
* $result = $client->uploadPart([
321314
* 'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
322315
* 'Bucket' => '<string>', // REQUIRED
@@ -332,14 +325,13 @@ public function signPartUpload(Request $request)
332325
* 'SourceFile' => '<string>',
333326
* 'UploadId' => '<string>', // REQUIRED
334327
* ]);
335-
*
336328
* @see https://github.com/transloadit/uppy/blob/master/packages/%40uppy/aws-s3-multipart/src/index.js Uppy call to this endpoint
337-
*
338329
* return this.#client.get(`s3/multipart/${uploadId}/${partNumber}?key=${filename}`, { signal })
339330
* .then(assertServerError)
340331
*
341-
* @param \Illuminate\Http\Request $request
342-
* @param int $partNumber
332+
* @param \Illuminate\Http\Request $request
333+
* @param int $partNumber
334+
*
343335
* @return string
344336
*/
345337
public function getSignedUrl(Request $request, int $partNumber)

0 commit comments

Comments
 (0)