ディレクトリオペレーション

S3 Transfer Manager はディレクトリ転送全体を処理できます。

ディレクトリをアップロードする

S3 Transfer Manager は、ディレクトリ全体を S3 バケットにアップロードできます。<キー値はアップロード時にファイル名になりますか?>

<?php

use Aws\S3\S3Transfer\Models\UploadDirectoryRequest;
use Aws\S3\S3Transfer\S3TransferManager;

require __DIR__ . '/../vendor/autoload.php';


$transferManager = new S3TransferManager(null, [
    'default_region' => 'us-west-2'
]);

$uploadDirPromise = $transferManager->uploadDirectory(
    new UploadDirectoryRequest(
        '/path/to/local/directory',
        'amzn-s3-demo-bucket',
        [
            // Additional `putObject` parameters that apply to all files.
            'ACL'          => 'public-read',
            'CacheControl' => 'max-age=3600',
        ],
        [
            // Configuration options.
            'recursive'                      => true,
            'follow_symbolic_links'          => false,
            's3_prefix'                      => 'uploads/2023/',
            's3_delimiter'                   => '/',
            'track_progress'                 => true,
            'filter'                         => function ($file) {
                // Upload only .jpg files.
                return pathinfo($file, PATHINFO_EXTENSION) === 'jpg';
            },
            'upload_object_request_modifier' => function ($args) {
                // Customize request arguments for each file.
                $args['ContentType'] = 'image/jpeg';
            },
        ]
    )
);

// Wait for the upload process to complete.
$result = $uploadDirPromise->wait();

$uploaded = $result->getObjectsUploaded();
$failed = $result->getObjectsFailed();
echo "Uploaded {$uploaded} files. Failed: {$failed}\n";

uploadDirectory メソッドのパラメータ

uploadDirectory メソッドは <UploadDirectoryRequestadd link> のインスタンスを引数として受け入れます。

UploadDirectoryRequest 個のパラメータ

uploadDirectory メソッドが正常に実行されると、UploadDirectoryResult<add link> が返されます。

ディレクトリのダウンロード

ディレクトリは S3 バケットからダウンロードできます。<ダウンロード時にファイル名はキー値ですか? キーに拡張子がない場合、ファイルにも拡張子はありませんか?>

<?php

use Aws\S3\S3Transfer\Models\DownloadDirectoryRequest;
use Aws\S3\S3Transfer\S3TransferManager;

require __DIR__ . '/../vendor/autoload.php';


$transferManager = new S3TransferManager(null, [
    'default_region' => 'us-west-2'
]);

$downloadDirPromise = $transferManager->downloadDirectory(
    new DownloadDirectoryRequest(
        'amzn-s3-demo-bucket',
        '/path/to/local/directory',
        [
            // Additional `getObject` parameters that apply to all files.
        ],
        [
            // Configuration options.
            's3_prefix'                        => 'uploads/2023/',
            's3_delimiter'                     => '/',
            'track_progress'                   => true,
            'filter'                           => function ($key) {
                // Download only .jpg files.
                return pathinfo($key, PATHINFO_EXTENSION) === 'jpg';
            },
            'download_object_request_modifier' => function ($args) {
                // Customize request arguments for each file.
                $args['ResponseContentType'] = 'image/jpeg';
            },
            'list_objects_v2_args'              => [
                'MaxKeys' => 1000,
                'Prefix'  => 'uploads/2023/',
            ],
            'fails_when_destination_exists'    => true,
        ]
    )
);

// Wait for the download process to complete.
$result = $downloadDirPromise->wait();

$downloaded = $result->getObjectsDownloaded();
$failed = $result->getObjectsFailed();
echo "Downloaded {$downloaded} files. Failed: {$failed}\n";

downloadDirectory メソッドのパラメータ

downloadDirectory メソッドは <DownloadDirectoryRequestadd link> のインスタンスを引数として受け入れます。

DownloadDirectoryRequest 個のパラメータ

ディレクトリオペレーションの仕組み

このセクションでは、S3 Transfer Manager がディレクトリオペレーション中にファイルパスとオブジェクトキーを処理する方法について説明します。

アップロードパスの処理

ディレクトリをアップロードすると、SDK はファイルパスから S3 オブジェクトキーを構築します。

recursive オプションは、サブディレクトリを含めるかどうかを制御します。false (デフォルト) の場合、最上位ファイルのみがアップロードされます。の場合true、サブディレクトリ内のすべてのファイルがアップロードされ、オブジェクトキーのディレクトリ構造が保持されます。

$sourceDirectory = "/opt/my-upload-directory";
$s3Prefix = "important/";
$s3Delimiter = "/"; // Default value

/opt/my-upload-directory/
-- my-file1.txt
-- my-file-2.txt
-- sub-dir/
---- my-another-file1.txt
---- my-another-file2.txt

$s3Prefix + $fileRelativePath;

- important/my-file1.txt
- important/my-file-2.txt
- important/sub-dir/my-another-file1.txt
- important/sub-dir/my-another-file2.txt

$sourceDirectory = "/opt/my-docs";
$s3Prefix = ''; // No provided and it will defaulted to empty string
$s3Delimiter = "/"; // Default value

/opt/my-docs/
-- my-file1.txt
-- my-file-2.txt
-- sub-dir/
---- my-another-file1.txt
---- my-another-file2.txt

$s3Prefix + $fileRelativePath;

- my-file1.txt
- my-file-2.txt
- sub-dir/my-another-file1.txt
- sub-dir/my-another-file2.txt

<?php
// Source directory: /home/user/photos/
//   fla/beach.jpg
//   fla/sunset.jpg
//   fla/pool/party.jpg
// With s3_prefix: '2023' and recursive: true
// Results:
//   2023/fla/beach.jpg
//   2023/fla/sunset.jpg
//   2023/fla/pool/party.jpg

ダウンロードパスの処理

ディレクトリをダウンロードすると、SDK は S3 オブジェクトキーからローカルファイルパスを構築します。

ダウンロードは常に再帰的です。SDK は、指定されたプレフィックスのすべてのオブジェクトを取得し、必要に応じてサブディレクトリを作成します。セキュリティのためにパスが送信先ディレクトリの外部で解決されないことを検証します。

<?php
// S3 objects:
//   2023/fla/beach.jpg
//   2023/fla/sunset.jpg
//   2023/fla/pool/party.jpg
// With s3_prefix: '2023' and destination: /home/user/downloads
// Results:
//   /home/user/downloads/fla/beach.jpg
//   /home/user/downloads/fla/sunset.jpg
//   /home/user/downloads/fla/pool/party.jpg

$s3Prefix = "my-prefix";
$s3Objects = [
    "my-prefix/file-1.txt", 
    "my-prefix/file-2.txt", 
    "my-prefix/subdir/file-1.txt"
];
$targetDirectory = "/opt/bucket/downloads/";

/opt/bucket/downloads/
-- file-1.txt
-- file-2.txt
-- subdir/
---- file-1.txt

$s3Prefix = ""; // No provided
$s3Objects = [
    "README.md",
    "my-docs/file-1.txt", 
    "my-docs/file-2.txt", 
    "my-docs/statements/file-1.txt"
];
$targetDirectory = "/opt/bucket/downloads/";

/opt/bucket/downloads/
-- README.md
-- my-docs/
---- file-1.txt
---- file-2.txt
---- statements/
------ file-1.txt