Geradores e Iteradores

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

Geradores fornecem uma maneira simples de criar iteradores sem implementar a interface Iterator completa. 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 construir um array inteiro na memória, os geradores produzem valores sob demanda. Isso é crucial ao trabalhar com grandes conjuntos de dados — um gerador que processa um milhão de registros usa a mesma memória que um que processa dez.

Geradores também podem produzir pares de chave-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 repetitivo. 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 construir um sistema de inventário de produtos que utiliza 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 representa um item no 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 gerencia uma coleção de produtos e fornece métodos geradores para iterar por eles. Inclua o arquivo Product. A classe deve:
- Ter uma propriedade de array privada para armazenar produtos
- Ter um método addProduct(Product $product) que adiciona um produto à coleção
- Ter um método gerador allProducts(): Generator que produz (yields) cada produto um por vez
- Ter um método gerador expensiveProducts(float $minPrice): Generator que produz apenas produtos com um preço maior ou igual ao mínimo informado, produzindo pares chave-valor onde a chave é o SKU e o valor é o produto
main.php — Inclua o arquivo Inventory. Você receberá uma entrada: um limite de preço mínimo.
Crie um Inventory e adicione estes três produtos:
- SKU: "A001", Name: "Laptop", Price: 999.99
- SKU: "A002", Name: "Mouse", Price: 29.99
- SKU: "A003", Name: "Monitor", Price: 349.99
Primeiro, itere por allProducts() e imprima o nome de cada produto em sua própria linha.

Em seguida, imprima uma linha vazia, seguida pela iteração por expensiveProducts() usando o limite de entrada. 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 que você itere por coleções de forma preguiçosa (lazy) — cada produto é produzido apenas quando solicitado, tornando essa abordagem eficiente em termos de memória para grandes inventários. A produção de chave-valor em expensiveProducts() mostra como os geradores podem fornecer dados de iteração estruturados.

Folha de consulta

Generators fornecem uma maneira eficiente em termos de memória para criar iteradores usando yield em vez de return. Eles produzem valores um de cada vez, pausando a execução entre cada valor.

Função geradora básica:

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

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

Generators podem produzir pares de chave-valor:

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

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

A principal vantagem é a eficiência de memória - generators produzem valores sob demanda, em vez de construir arrays inteiros na memória. Isso é especialmente útil ao trabalhar com grandes conjuntos de dados ou coleções em contextos de OOP.

Experimente você mesmo

<?php

require_once 'Inventory.php';

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

// TODO: Criar uma instância de Inventory

// TODO: Adicionar 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: Iterar por allProducts() e imprimir o nome de cada produto

// TODO: Imprimir uma linha vazia

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

?>