Wrapper de stream do Amazon S3 com versão 3 AWS SDK for PHP

O wrapper de stream do Amazon S3 permite que você armazene e recupere dados do Amazon S3 usando PHP funções integradas, como,,file_get_contents,fopen, e. copy rename unlink mkdir rmdir

Você precisa registrar o wrapper de fluxo do Amazon S3 para usá-lo.

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

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

Desse modo, é possível acessar buckets e objetos armazenados no Amazon S3 por meio do protocolo s3://. O wrapper de fluxo do Amazon S3 aceita strings que contêm um nome do bucket seguido por uma barra e uma chave de objeto ou prefixo opcional: s3://<bucket>[/<key-or-prefix>].

Download de dados

Você pode capturar o conteúdo de um objeto usando file_get_contents. No entanto, tenha cuidado com essa função; ela carrega todo o conteúdo do objeto na memória.

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

Use fopen() ao trabalhar com arquivos maiores ou se precisar fazer fluxos de dados do 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);
}

Abrir fluxos pesquisáveis

Os streams abertos no modo "r" só permitem que os dados sejam lidos no stream e não são pesquisáveis por padrão. Isso é para que o download dos dados possa ser feito no Amazon S3 na forma de streaming verdadeiro, onde os bytes lidos anteriormente não precisam ser armazenados em buffer na memória. Se você precisar que um stream seja pesquisável, você pode passar seekable para as opções do contexto de stream de uma função.

$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);
}

A abertura de streams pesquisáveis permite que você busque bytes que tenham sido lidos anteriormente. Você não pode pular para bytes que ainda não tenham sido lidos no servidor remoto. Para permitir que dados lidos anteriormente sejam recuperados, os dados são armazenados em buffer em um fluxo PHP temporário usando um decorador de fluxo. Quando a quantidade de dados em cache excede 2 MB, os dados no stream temporário são transferidos da memória para o disco. Lembre-se disso ao baixar arquivos grandes do Amazon S3 usando a configuração de contexto de fluxo seekable.

Carregar dados

Você pode fazer upload dos dados para o Amazon S3 usando file_put_contents().

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

Você pode fazer upload de arquivos maiores por dados de streaming usando fopen() e um modo de acesso de stream "w", "x" ou "a". O wrapper de fluxo do Amazon S3 não é compatível com fluxos de leitura e gravação simultâneas (por exemplo, “r+”, “w+” etc.). Isso ocorre porque o HTTP protocolo não permite leitura e gravação simultâneas.

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

Modos fopen

PHPA função fopen () requer que você especifique uma $mode opção. O opção do modo especifica se os dados podem ser lidos ou gravados em um stream, e se o arquivo deve existir ao abrir um stream.

O wrapper de fluxo do Amazon S3 permite os seguintes modos para fluxos que têm como alvo objetos do Amazon S3.

Outras funções de objetos

Os streampers permitem que muitas PHP funções integradas diferentes funcionem com um sistema personalizado, como o Amazon S3. Estas são algumas das funções que o stream wrapper do Amazon S3 permite que você execute com objetos armazenados no 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!';
}

Trabalhar com buckets e pastas

Usar mkdir() para trabalhar com buckets

Você pode criar e navegar por buckets do Amazon S3 da mesma forma PHP que permite criar e percorrer diretórios em seu sistema de arquivos.

Aqui está um exemplo que cria um bucket.

mkdir('s3://amzn-s3-demo-bucket');

Você pode passar as opções de contexto do stream para o mkdir() método para modificar a forma como o bucket é criado usando os parâmetros disponíveis para a CreateBucketoperação.

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

Você pode excluir buckets usando a função rmdir().

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

Usar mkdir() para trabalhar com pastas

Depois de criar um bucket, você pode usar mkdir() para criar objetos que funcionam como pastas como em um sistema de arquivos.

O trecho de código a seguir adiciona um objeto de pasta chamado 'my-folder' ao bucket existente chamado 'amzn-s3-demo-bucket'. Use o caractere de barra (/) para separar um nome de objeto de pasta do nome do bucket e de qualquer nome de pasta adicional.

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

A observação anterior sobre alterações de permissão após abril de 2023 também entra em ação quando você cria objetos de pasta. Esta publicação do blog tem informações sobre como ajustar as permissões, se necessário.

Use a função rmdir() para excluir um objeto de pasta vazio, como mostrado no trecho a seguir.

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

Listar o conteúdo de um bucket

Você pode usar as funções opendir (), readdir (), rewinddir () e closedir () com PHP o wrapper de stream do Amazon S3 para percorrer o conteúdo de um bucket. Você pode passar os parâmetros disponíveis para a ListObjectsoperação como opções personalizadas de contexto de fluxo para a opendir() função para modificar a forma como os objetos são listados.

$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);
}

Você pode listar recursivamente cada objeto e prefixo em um bucket usando PHP's. RecursiveDirectoryIterator

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

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

Outra forma de listar recursivamente o conteúdo de um bucket que gera menos HTTP solicitações é usar a Aws\recursive_dir_iterator($path, $context = null) função.

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

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

Opções de contexto de fluxo

Você pode personalizar o cliente usado pelo stream wrapper ou o cache usado para armazenar em cache as informações carregadas anteriormente sobre buckets e chaves, passando as opções de contexto de stream personalizado.

O stream wrapper é compatível com as seguintes opções de contexto de stream em cada operação.