urbanindo / yii2-s3cache
Yii2 Component for Caching in S3
Installs: 18 043
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 6
Forks: 3
Open Issues: 1
Requires
- php: >=5.5.0
- aws/aws-sdk-php: ^3.28.0
- yiisoft/yii2: *
This package is auto-updated.
Last update: 2024-10-22 16:56:36 UTC
README
File caching component for Yii2 using AWS Simple Storage Service
This is intended for large and long-lived objects.
Requirement
- PHP >= 5.5
- AWS SDK >= 3.28.0
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist urbanindo/yii2-s3cache "*"
or add
"urbanindo/yii2-s3cache": "*"
to the require section of your composer.json
file.
Setting Up
Add the component in the configuration.
'components' => [ 's3Cache' => [ 'class' => 'UrbanIndo\Yii2\S3Cache\Cache', 'bucket' => 'mybucket', 'cachePrefix' => '123456', 'config' => [ 'key' => 'AKIA1234567890123456', 'secret' => '1234567890123456789012345678901234567890', 'region' => 'ap-southeast-1', ], ] ]
Usage
This is similar like regular data caching.
$cache = Yii::$app->get('s3Cache'); // try retrieving $data from cache $data = $cache->get($key); if ($data === false) { // $data is not found in cache, calculate it from scratch // store $data in cache so that it can be retrieved next time $cache->set($key, $data); } // $data is available here