Enveloppeur de flux Amazon S3 avec AWS SDK for PHP version 3

Le wrapper de flux Amazon S3 vous permet de stocker et de récupérer des données depuis Amazon S3 à l'aide de fonctions PHP intégréesfile_get_contents, telles que fopencopy,rename,, unlinkmkdir, etrmdir.

Vous devez enregistrer le wrapper de flux Amazon S3 pour l'utiliser.

$client = new Aws\S3\S3Client([/** options **/]);

// Register the stream wrapper from an S3Client object
$client->registerStreamWrapper();

Cela vous permet d'accéder aux compartiments et aux objets stockés dans Amazon S3 à l'aide du s3:// protocole. L'encapsuleur de flux Amazon S3 accepte les chaînes contenant un nom de compartiment suivi d'une barre oblique et d'une clé d'objet ou d'un préfixe facultatif :. s3://<bucket>[/<key-or-prefix>]

Télécharger les données

Vous pouvez saisir le contenu d'un objet en utilisant file_get_contents. Cependant, soyez prudent avec cette fonction, car elle charge tout le contenu de l'objet dans la mémoire.

// Download the body of the "key" object in the "bucket" bucket
$data = file_get_contents('s3://bucket/key');

fopen()À utiliser lorsque vous travaillez avec des fichiers plus volumineux ou si vous devez diffuser des données depuis Amazon S3.

// Open a stream in read-only mode
if ($stream = fopen('s3://bucket/key', 'r')) {
    // While the stream is still open
    while (!feof($stream)) {
        // Read 1,024 bytes from the stream
        echo fread($stream, 1024);
    }
    // Be sure to close the stream resource when you're done with it
    fclose($stream);
}

Streams consultables ouverts

Les flux ouverts en mode « r » autorisent uniquement la lecture de données depuis le flux, et ne peuvent pas être recherchés par défaut. Cela permet de télécharger les données depuis Amazon S3 de manière véritablement en streaming, les octets précédemment lus n'ayant pas besoin d'être mis en mémoire tampon. Si vous avez besoin qu’un flux puisse être recherché, vous pouvez transférer seekable dans les options de contexte de flux d’une fonction.

$context = stream_context_create([
    's3' => ['seekable' => true]
]);

if ($stream = fopen('s3://bucket/key', 'r', false, $context)) {
    // Read bytes from the stream
    fread($stream, 1024);
    // Seek back to the beginning of the stream
    fseek($stream, 0);
    // Read the same bytes that were previously read
    fread($stream, 1024);
    fclose($stream);
}

Ouvrir des flux pouvant être recherchés vous permet de rechercher des octets qui ont été lus auparavant. Vous ne pouvez pas passer directement aux octets qui n'ont pas encore été lus depuis le serveur distant. Pour autoriser le rappel de données précédemment lues, les données sont mises en mémoire tampon dans un flux PHP temporaire à l'aide d'un décorateur de flux. Lorsque la quantité de données mises en cache dépasse 2 Mo, les données dans le flux temporaire sont transférées de la mémoire au disque. Gardez cela à l'esprit lorsque vous téléchargez des fichiers volumineux depuis Amazon S3 à l'aide du paramètre de contexte de seekable flux.

Charger des données

Vous pouvez télécharger des données sur Amazon S3 à l'aide defile_put_contents().

file_put_contents('s3://bucket/key', 'Hello!');

Vous pouvez télécharger des fichiers plus volumineux en diffusant les données en streaming à l'aide de fopen() et d'un mode d'accès du flux « w », « x » ou « a ». L'encapsuleur de flux Amazon S3 ne prend pas en charge les flux de lecture et d'écriture simultanés (par exemple « r+ », « w+ », etc.). Cela est dû au fait que le protocole HTTP ne permet pas la lecture et l'écriture simultanées.

$stream = fopen('s3://bucket/key', 'w');
fwrite($stream, 'Hello!');
fclose($stream);

modes fopen

La fonction PHP fopen() nécessite que vous indiquiez une option $mode. L'option de mode spécifie si les données peuvent être lues ou écrites dans un flux, et si le fichier doit exister lors de l'ouverture d'un flux.

Le wrapper de flux Amazon S3 prend en charge les modes suivants pour les flux qui ciblent des objets Amazon S3.

Autres fonctions de l'objet

Les wrappers de flux permettent à de nombreuses fonctions PHP intégrées de fonctionner avec un système personnalisé tel qu'Amazon S3. Voici quelques-unes des fonctions que le wrapper de flux Amazon S3 vous permet d'exécuter avec des objets stockés dans Amazon S3.

// Delete an object from a bucket
unlink('s3://bucket/key');

// Delete a specific version of an object from a bucket
unlink('s3://bucket/key', stream_context_create([
    's3' => ['VersionId' => '123']
]);

// Get the Content-Length of an object
$size = filesize('s3://bucket/key', );

if (is_file('s3://bucket/key')) {
    echo 'It is a file!';
}

if (file_exists('s3://bucket/key')) {
    echo 'It exists!';
}

Travaillez avec des compartiments et des dossiers

Utilisable mkdir() pour travailler avec des seaux

Vous pouvez créer et parcourir des compartiments Amazon S3 de la même manière que PHP vous permet de créer et de parcourir des répertoires sur votre système de fichiers.

Voici un exemple de création d'un bucket.

mkdir('s3://my-bucket');

Vous pouvez transmettre des options de contexte de flux à la mkdir() méthode pour modifier la façon dont le bucket est créé à l'aide des paramètres disponibles pour l'CreateBucketopération.

// Create a bucket in the EU (Ireland) Region
mkdir('s3://my-bucket', 0500, true,
        stream_context_create([
            's3' => ['LocationConstraint' => 'eu-west-1']
        ]));

Vous pouvez supprimer des compartiments à l'aide de la fonction rmdir().

// Delete a bucket
rmdir('s3://my-bucket);

mkdir()À utiliser pour travailler avec des dossiers

Après avoir créé un bucket, vous pouvez l'utiliser mkdir() pour créer des objets qui fonctionnent comme des dossiers, comme dans un système de fichiers.

L'extrait de code suivant ajoute un objet de dossier nommé « my-folder » au bucket existant nommé « my-bucket ». Utilisez la barre oblique (/) pour séparer le nom d'un objet de dossier du nom du compartiment et de tout autre nom de dossier supplémentaire.

mkdir('s3://my-bucket/my-folder')

La remarque précédente concernant les modifications d'autorisation après avril 2023 entre également en ligne de compte lorsque vous créez des objets de dossier. Ce billet de blog contient des informations sur la façon d'ajuster les autorisations si nécessaire.

Utilisez cette rmdir() fonction pour supprimer un objet de dossier vide, comme indiqué dans l'extrait suivant.

rmdir('s3://my-bucket/my-folder')

Répertorier le contenu d'un bucket

Vous pouvez utiliser les fonctions PHP opendir (), readdir (), rewinddir () et closedir () avec le wrapper de flux Amazon S3 pour parcourir le contenu d'un bucket. Vous pouvez transmettre les paramètres disponibles pour l'ListObjectsopération sous forme d'options contextuelles de flux personnalisées à la opendir() fonction afin de modifier la façon dont les objets sont répertoriés.

$dir = "s3://bucket/";

if (is_dir($dir) && ($dh = opendir($dir))) {
    while (($file = readdir($dh)) !== false) {
        echo "filename: {$file} : filetype: " . filetype($dir . $file) . "\n";
    }
    closedir($dh);
}

Vous pouvez répertorier de manière récursive chaque objet et chaque préfixe d'un bucket à l'aide de PHP. RecursiveDirectoryIterator

$dir = 's3://bucket';
$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir));

foreach ($iterator as $file) {
    echo $file->getType() . ': ' . $file . "\n";
}

Une autre façon de répertorier de façon récursive les contenus d'un compartiment, qui entraîne moins de requêtes HTTP, est d'utiliser la fonction Aws\recursive_dir_iterator($path, $context = null).

<?php
require 'vendor/autoload.php';

$iter = Aws\recursive_dir_iterator('s3://bucket/key');
foreach ($iter as $filename) {
    echo $filename . "\n";
}

Options de contexte de diffusion

Vous pouvez personnaliser le client utilisé par l'encapsuleur de flux, ou le cache utilisé pour mettre en cache les informations précédemment chargées sur les compartiments et les clés, en transmettant les options de contexte de flux personnalisé.

L'encapsuleur de flux prend en charge les options de contexte de flux suivantes au niveau de chaque opération.