sunaoka/laravel-aws-sdk-php

AWS Service Provider for Laravel

1.3.0 2024-12-12 03:00 UTC

Requires

• php: ^7.2 || ^8.0
• aws/aws-sdk-php: ^3.17.0
• illuminate/support: ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0

Requires (Dev)

• orchestra/testbench: ^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0
• phpstan/phpstan: ^1.9 || ^2.0

Apache-2.0

• sunaoka

• php
• sdk
• aws
• laravel

README

Installation

composer require sunaoka/laravel-aws-sdk-php

Configurations

php artisan vendor:publish --tag=aws-config

The settings can be found in the generated config/aws.php configuration file.

<?php

return [
    'credentials' => [
        'key'    => env('AWS_ACCESS_KEY_ID'),
        'secret' => env('AWS_SECRET_ACCESS_KEY'),
        'token'  => env('AWS_SESSION_TOKEN'),
    ],
    'region'      => env('AWS_DEFAULT_REGION'),
    'version'     => env('AWS_API_VERSION', 'latest'),
    'endpoint'    => env('AWS_ENDPOINT'),

    // Override Configuration for specific services
    // 'S3' => [
    //     'use_path_style_endpoint' => false,
    // ],
];

Usage

$s3 = \AWS::createS3();

$result = $s3->getObject([
    'Bucket' => 'Bucket',
    'Key'    => 'Key',
]);

echo $result['Body'];

Testing

You may use the AWS facade's fake method to apply the mock handler.

For more information on mock handlers, please refer to the Developer Guide.

use Aws\Result;
use Aws\MockHandler;
use Aws\CommandInterface;
use Psr\Http\Message\RequestInterface;
use Aws\Exception\AwsException;

$mock = new MockHandler();
$mock->append(new Result(['Body' => 'foo']));
$mock->append(function (CommandInterface $cmd, RequestInterface $req) {
    return new AwsException('Mock exception', $cmd);
});

\AWS::fake($mock);

$s3 = \AWS::createS3();

$result = $s3->getObject([
    'Bucket' => 'Bucket',
    'Key'    => 'Key',
]);

echo $result['Body']; // foo

Mock handlers can also be set for each client.

use Aws\DynamoDB\DynamoDbClient;
use Aws\MockHandler;
use Aws\Result;
use Aws\S3\S3Client;

$mockHandlers = [
    S3Client::class => new MockHandler([
        new Result(['Body' => __METHOD__]),
    ]),
    DynamoDbClient::class => new MockHandler([
        new Result(['TableNames' => ['Table1', 'Table2', 'Table3']]),
    ]),
];

\AWS::fake($mockHandlers);

$s3 = \AWS::createS3();

$result = $s3->getObject([
    'Bucket' => 'Bucket',
    'Key'    => 'Key',
]);

echo $result['Body']; // foo

$dynamoDb = \AWS::createDynamoDb();

$result = $dynamoDb->listTables();

echo $result['TableNames'][0]; // Table1