Skip to content

Available Functions

Ramesh Mhetre edited this page Aug 9, 2017 · 1 revision

List of available functions

createBucket - Returns a bucket details

$bucket = $client->createBucket([
    'BucketName' => 'my-special-bucket',
    'BucketType' => Bucket::TYPE_PRIVATE // or TYPE_PUBLIC
]);

updateBucket - Change the bucket Type

$updatedBucket = $client->updateBucket([
    'BucketId' => $bucket->getId(),
    'BucketType' => Bucket::TYPE_PUBLIC
]);

listBuckets - List all buckets

$buckets = $client->listBuckets();

deleteBucket - Delete a bucket

$client->deleteBucket([
    'BucketId' => 'YOUR_BUCKET_ID'
]);

upload - File Upload

$file = $client->upload([
    'BucketName' => 'my-special-bucket',
    'FileName' => 'path/to/upload/to',
    'Body' => 'I am the file content'

    // The file content can also be provided via a resource.
    // 'Body' => fopen('/path/to/input', 'r')
]);

download - File Download

$fileContent = $client->download([
    'FileId' => $file->getId()

    // Can also identify the file via bucket and path:
    // 'BucketName' => 'my-special-bucket',
    // 'FileName' => 'path/to/file'

    // Can also save directly to a location on disk. This will cause download() to not return file content.
    // 'SaveAs' => '/path/to/save/location'
]);

deleteFile - File Delete

$fileDelete = $client->deleteFile([
    'FileId' => $file->getId()
    
    // Can also identify the file via bucket and path:
    // 'BucketName' => 'my-special-bucket',
    // 'FileName' => 'path/to/file'
]);

listFiles - List all files

$fileList = $client->listFiles([
    'BucketId' => 'YOUR_BUCKET_ID'
]);
Clone this wiki locally