Geradores e Iteradores

Parte da seção Programação Orientada a Objetos do Journey de PHP da Coddy. Lição 62 de 91.

Geradores oferecem uma maneira simples de criar iteradores sem implementar a interface completa Iterator. Uma função geradora usa yield em vez de return para produzir valores um de cada vez, pausando a execução entre cada valor.

Aqui está um gerador básico que produz uma sequência de números:

<?php
function countTo(int $max): Generator {
    for ($i = 1; $i <= $max; $i++) {
        yield $i;
    }
}

foreach (countTo(3) as $number) {
    echo "$number\n";
}

Saída:

1
2
3

A principal vantagem é a eficiência de memória. Em vez de criar uma array inteira na memória, generators produzem valores sob demanda. Isso é crucial ao trabalhar com grandes conjuntos de dados — um generator que processa um milhão de registros usa a mesma quantidade de memória que um que processa dez.

Geradores também podem produzir pares de chave e valor:

<?php
function userGenerator(): Generator {
    yield 'admin' => 'Alice';
    yield 'editor' => 'Bob';
}

foreach (userGenerator() as $role => $name) {
    echo "$role: $name\n";
}

Saída:

admin: Alice
editor: Bob

Para tornar suas próprias classes iteráveis com foreach, implemente a interface Iterator. No entanto, na maioria dos casos, os geradores oferecem uma solução mais limpa, com menos código padrão. Eles são particularmente úteis em OOP quando uma classe precisa expor uma coleção de itens sem carregar tudo na memória de uma só vez.

Desafio

Fácil

Vamos criar um sistema de inventário de produtos que usa geradores para iterar eficientemente por grandes coleções sem carregar tudo na memória de uma só vez. Você criará uma classe que armazena produtos e fornece métodos geradores para iterar por eles de diferentes maneiras.

Você organizará seu código em três arquivos:

Product.php: Crie uma classe Product que represente um item do inventário. Use a promoção de construtor para definir um $sku (string) público, um $name (string) público e um $price (float) público.
Inventory.php: Crie uma classe Inventory que gerencie uma coleção de produtos e forneça métodos geradores para iterar por eles. Inclua o arquivo Product. A classe deve:
- Ter uma propriedade de array privada para armazenar os produtos
- Ter um método addProduct(Product $product) que adicione um produto à coleção
- Ter um método gerador allProducts(): Generator que produza cada produto um por vez
- Ter um método gerador expensiveProducts(float $minPrice): Generator que produza apenas produtos com preço maior ou igual ao mínimo informado, produzindo pares de chave e valor em que a chave é o SKU e o valor é o produto
main.php: Inclua o arquivo Inventory. Você receberá uma entrada: um limite mínimo de preço.
Crie um Inventory e adicione estes três produtos:
- SKU: "A001", Nome: "Laptop", Preço: 999.99
- SKU: "A002", Nome: "Mouse", Preço: 29.99
- SKU: "A003", Nome: "Monitor", Preço: 349.99
Primeiro, itere por allProducts() e imprima o nome de cada produto em sua própria linha.

Em seguida, imprima uma linha vazia e, depois, itere por expensiveProducts() usando o limite informado. Para cada produto caro, imprima "[sku]: [name] - $[price]" em sua própria linha. Formate o preço com exatamente 2 casas decimais.

Este desafio demonstra como os geradores permitem iterar por coleções de forma lazy: cada produto é produzido somente quando solicitado, tornando essa abordagem eficiente em termos de memória para inventários grandes. A produção de chave e valor em expensiveProducts() mostra como os geradores podem fornecer dados estruturados para iteração.

Experimente você mesmo

<?php

require_once 'Inventory.php';

// Ler entrada
$minPrice = floatval(trim(fgets(STDIN)));

// TODO: Crie uma instância de Inventory

// TODO: Adicione três produtos:
// SKU: "A001", Nome: "Laptop", Preço: 999.99
// SKU: "A002", Nome: "Mouse", Preço: 29.99
// SKU: "A003", Nome: "Monitor", Preço: 349.99

// TODO: Itere por allProducts() e imprima o nome de cada produto

// TODO: Imprima uma linha vazia

// TODO: Itere por expensiveProducts() usando $minPrice
// Para cada produto caro, imprima "[sku]: [name] - $[price]"
// Formate o preço com exatamente 2 casas decimais

?>