duellsy/aws-sdk-php-laravel

一个简单的 Laravel 5/6/7/8 服务提供者,用于包括 AWS SDK for PHP。

3.6.0 2020-09-14 17:33 UTC

README

@awsforphp on Twitter Build Status Latest Stable Version Total Downloads Gitter

这是一个简单的 Laravel 服务提供者,用于轻松地将官方 AWS SDK for PHP 包含到您的 Laravel 和 Lumen 应用程序中。

此 README 是关于服务提供者的 3.x 版本,该版本是为与 AWS SDK for PHP 版本 3 和 Laravel 5.1 一起工作而实现的。

主要版本

  • 3.x (您在这里) - 对于 laravel/framework:~5.1|~6.0|~7.0|~8.0aws/aws-sdk-php:~3.0
  • 2.x (2.0 分支) - 对于 laravel/framework:5.0.*aws/aws-sdk-php:~2.4
  • 1.x (1.0 分支) - 对于 laravel/framework:4.*aws/aws-sdk-php:~2.4

跳转至

入门

安装

可以通过在项目的 composer.json 中要求 aws/aws-sdk-php-laravel 包来通过 Composer 安装 AWS 服务提供者。

{
    "require": {
        "aws/aws-sdk-php-laravel": "~3.0"
    }
}

然后运行 composer update

php composer.phar update

为了使用 AWS 服务提供者,您必须在引导应用程序时注册提供者。

Lumen

在 Lumen 中,在 bootstrap/app.php 中找到 Register Service Providers 并注册 AWS 服务提供者。

    $app->register(Aws\Laravel\AwsServiceProvider::class);

Laravel

在 Laravel 中,在 config/app.php 中找到 providers 键并注册 AWS 服务提供者。

    'providers' => array(
        // ...
        Aws\Laravel\AwsServiceProvider::class,
    )

config/app.php 中找到 aliases 键并添加 AWS 门面别名。

    'aliases' => array(
        // ...
        'AWS' => Aws\Laravel\AwsFacade::class,
    )

配置

默认情况下,该包使用以下环境变量来自动配置插件而无需修改

AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_REGION (default = us-east-1)

要自定义配置文件,请使用 Artisan 发布包配置。

php artisan vendor:publish  --provider="Aws\Laravel\AwsServiceProvider"

设置可以在生成的 config/aws.php 配置文件中找到。默认情况下,凭证和区域设置将来自您的 .env 文件。

return [
    'credentials' => [
        'key'    => env('AWS_ACCESS_KEY_ID', ''),
        'secret' => env('AWS_SECRET_ACCESS_KEY', ''),
    ],
    'region' => env('AWS_REGION', 'us-east-1'),
    'version' => 'latest',
    
    // You can override settings for specific services
    'Ses' => [
        'region' => 'us-east-1',
    ],
];

请注意,如果您想使用 默认 SDK 配置提供者链,则可以始终从该文件中删除 credentials 行。

有关使用 php artisan config:cache 时的配置文件替代环境变量选项的说明,请参阅 Laravel 5.2.0 升级指南

有关在 SDK 用户指南中配置 SDK 的更多信息,请参阅 配置 SDK

用法

为了在您的应用程序中使用 AWS SDK for PHP,您需要从 Laravel 服务容器 中检索它。以下示例使用 Amazon S3 客户端上传文件。

$s3 = App::make('aws')->createClient('s3');
$s3->putObject(array(
    'Bucket'     => 'YOUR_BUCKET',
    'Key'        => 'YOUR_OBJECT_KEY',
    'SourceFile' => '/the/path/to/the/file/you/are/uploading.ext',
));

如果 AWS 门面在应用程序配置的 aliases 部分中注册,您还可以使用以下技术。

$s3 = AWS::createClient('s3');
$s3->putObject(array(
    'Bucket'     => 'YOUR_BUCKET',
    'Key'        => 'YOUR_OBJECT_KEY',
    'SourceFile' => '/the/path/to/the/file/you/are/uploading.ext',
));

获取帮助

请使用以下社区资源获取帮助。我们使用 GitHub 的问题来跟踪错误和功能请求,并有限制的带宽来解决它们。

此SDK实现了AWS服务API。关于AWS服务和它们的限制的通用问题,您还可以查看 Amazon Web Services 讨论论坛

提交问题

如果您遇到了 aws-sdk-php-laravel 的bug,我们希望听到您的反馈。在提交新问题之前,请搜索现有问题,并确保您的问题尚未存在。如果适当,请包括 aws-sdk-php-laravel 版本、PHP版本和您使用的操作系统。如果适当,请包括堆栈跟踪和简化的重现案例。

GitHub问题用于bug报告和功能请求。对于使用 aws-sdk-php 的帮助和问题,请使用“获取帮助”部分中列出的资源。处理问题的资源有限,通过保持开放问题的列表精简,我们可以及时响应。

贡献

我们努力提供高质量且有用的SDK,并高度重视我们社区的反馈和贡献。在提交任何问题或拉取请求之前,请先查看我们的 贡献指南,以确保我们拥有有效响应您的bug报告或贡献所需的所有必要信息。

资源