Operaciones de directorio

S3 Transfer Manager puede gestionar transferencias de directorios completos.

Cargar directorio

S3 Transfer Manager puede cargar un directorio completo en un bucket de S3. <Are the key values the filenames when uploaded?>

<?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";

Parámetros del método uploadDirectory

El uploadDirectory método acepta una instancia de UploadDirectoryRequest <add link> como argumento.

Parámetros UploadDirectoryRequest

Cuando el uploadDirectory método se ejecuta correctamente, devuelve un UploadDirectoryResult<add link>.

Directorio de descargas

Puede descargar un directorio desde un bucket de S3. <Are the filenames the key values when downloaded? If there is no extension in the key, is there also no extension on the file?>

<?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";

Parámetros del método downloadDirectory

El downloadDirectory método acepta una instancia de DownloadDirectoryRequest <add link> como argumento.

Parámetros DownloadDirectoryRequest

Cómo funcionan las operaciones de directorio

En esta sección se explica cómo el S3 Transfer Manager gestiona las rutas de los archivos y las claves de los objetos durante las operaciones de directorio.

Gestión de las rutas de carga

Al cargar un directorio, el SDK crea claves de objetos de S3 a partir de las rutas de los archivos:

La recursive opción controla si se incluyen los subdirectorios. Cuando false (predeterminado), solo se cargan los archivos de nivel superior. Cuandotrue, se cargan todos los archivos de los subdirectorios, conservando la estructura de directorios en las claves de objetos.

$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

Gestión de rutas de descarga

Al descargar un directorio, el SDK crea rutas de archivos locales a partir de claves de objetos de S3:

Las descargas son siempre recursivas. El SDK recupera todos los objetos con el prefijo especificado y crea subdirectorios según sea necesario. Valida que las rutas no se resuelvan fuera del directorio de destino por motivos de seguridad.

<?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