mmockelyn / aws-sdk-php-laravel
一个简单的Laravel 5/6/7/8服务提供程序,用于包含PHP的AWS SDK。
Requires
- php: >=5.5.9
- aws/aws-sdk-php: ~3.0
- illuminate/support: ^5.1 || ^6.0 || ^7.0 || ^8.0 || ^9.0
Requires (Dev)
- phpunit/phpunit: ^4.0 || ^5.0
- vlucas/phpdotenv: ^1.0 || ^2.0 || ^3.0 || ^4.0 || ^5.0
Suggests
- laravel/framework: To test the Laravel bindings
- laravel/lumen-framework: To test the Lumen bindings
This package is not auto-updated.
Last update: 2024-10-01 23:18:59 UTC
README
这是一个简单的Laravel服务提供程序,使得在Laravel和Lumen应用中包含官方的AWS SDK for PHP变得容易。
此README是为服务提供程序的3.x版本,该版本是为与PHP的AWS SDK的3.0版本和Laravel 5.1版本一起使用而实现的。
主要版本
- 3.x (您在这里) - 对于
laravel/framework:~5.1|~6.0|~7.0|~8.0
和aws/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
行。
根据Laravel 5.2.0 升级指南,如果您使用php artisan config:cache
,则必须使用配置文件而不是环境变量选项。
有关如何在SDK的用户指南中配置SDK的更多信息,请参阅。
用法
为了在您的应用中使用PHP的AWS SDK,您需要从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问题跟踪错误和功能请求,并且处理它们的带宽有限。
- 在StackOverflow上提问并使用
aws-php-sdk
标签。 - 加入 AWS SDK for PHP gitter
- 通过 AWS Support 打开支持工单
- 如果发现可能存在bug,请 提交问题
此SDK实现了AWS服务API。有关AWS服务和它们的限制的一般问题,您还可以查看 Amazon Web Services 讨论论坛。
提交问题
如果您在 aws-sdk-php-laravel
中遇到bug,我们希望了解它。搜索现有的问题,并在打开新问题之前确保您的问题尚未存在。如果您能提供 aws-sdk-php-laravel
的版本、使用的PHP版本和操作系统信息将很有帮助。在适当的情况下,请包括堆栈跟踪和简化的重现案例。
GitHub问题用于提交bug报告和功能请求。有关使用 aws-sdk-php
的帮助和问题,请使用“获取帮助”部分中列出的资源。处理问题的资源有限,通过保持开放问题列表精简,我们可以及时响应。
贡献
我们努力提供高质量且有用的SDK,以服务于我们的AWS服务,并高度重视社区反馈和贡献。在提交任何问题或pull请求之前,请先查看我们的 贡献指南,以确保我们拥有处理您的bug报告或贡献所需的所有必要信息。