indielab/yii2s3

There is no license information available for the latest version (2.1.1) of this package.

Yii 2 S3 Component

Installs: 18 599

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 4

Forks: 0

Open Issues: 0

Type:yii2-extension

2.1.1 2024-10-14 09:18 UTC

This package is auto-updated.

Last update: 2024-10-14 09:19:12 UTC


README

This component allows you to work with the amazon AWS S3 buckets for uploading and finding files.

Installation

Add the the package to your composer file:

composer require indielab/yii2s3

Add the component to your application configuration file:

'components' => [
    // ...
    's3' => [
        'class' => \indielab\yii2s3\S3::class,
        'bucket' => 'mybucket',
        'key' => 'KEY',
        'secret' => 'SECRET',
        'region' => 'eu-central-1',
    ],
    // ...
]

Usage

Using the component in order to upload a file:

Yii::$app->s3->upload('path/to/the/file.jpg');

Where file.jpg will be used as the key of the uploading file. Now in order to get the url to a key use:

$url = Yii::$app->s3->url('file.jpg');

Configure Uploading

You can also provide more options to the uploading configuration method:

Yii::$app->s3->upload('path/to/the/file.jpg', [
    'override' => true, // whether existing file should be overriden or not
    'Key' => 'CacheControlTestFile.txt', // Define a specific name for the file instead of the source file name
    'CacheControl' => 'max-age=' . strtotime('+1 year')  // Add cache controler options
]);