Skip to content

Commit

Permalink
chore: document adapter functions
Browse files Browse the repository at this point in the history
  • Loading branch information
nerg4l committed Apr 1, 2024
1 parent 78914f8 commit 98cb962
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions src/MultipartOfMadness.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,14 @@ public function temporaryUploadPartUrl($path, $uploadId, $partNumber, $expiratio
];
}

/**
* Lists the parts that have been uploaded for a specific multipart upload.
*
* @param string $path
* @param array $args
* @return \Aws\Result
* @see https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
*/
public function listParts($path, array $args = [])
{
return $this->client->listParts(array_merge([
Expand All @@ -63,6 +71,14 @@ public function listParts($path, array $args = [])
], $args));
}

/**
* Initiates a multipart upload.
*
* @param string $path
* @param array $args
* @return \Aws\Result
* @see https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
*/
public function createMultipartUpload($path, array $args = [])
{
return $this->client->createMultipartUpload(array_merge([
Expand All @@ -71,6 +87,14 @@ public function createMultipartUpload($path, array $args = [])
], $args));
}

/**
* Completes a multipart upload by assembling previously uploaded parts.
*
* @param string $path
* @param array $args
* @return \Aws\Result
* @see https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
*/
public function completeMultipartUpload($path, array $args = [])
{
return $this->client->completeMultipartUpload(array_merge([
Expand All @@ -79,6 +103,14 @@ public function completeMultipartUpload($path, array $args = [])
], $args));
}

/**
* Aborts a multipart upload.
*
* @param string $path
* @param array $args
* @return \Aws\Result
* @see https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
*/
public function abortMultipartUpload($path, array $args = [])
{
return $this->client->abortMultipartUpload(array_merge([
Expand Down

0 comments on commit 98cb962

Please sign in to comment.