Products

$envless->products->iterateProjects()

Stream the projects in a product one by one

php
/** @return \Generator<int, ProjectResource, mixed, void> */
public function iterateProjects(
    string $slug,
    ?int $limit = null,
    ?int $offset = null,
    ?string $search = null,
    ?string $order = null,
    int|float|null $timeout = null,
): \Generator

A Generator over the projects in a product, yielding one row at a time and fetching the next page only when the current one runs out. Break out of the loop to stop the walk.

Because the walk moves by offset, projects created or deleted mid-iteration can shift the window and cause a row to repeat or be missed. The scope requirement is the same as the page read: the key needs both products:read and projects:read.

Example

php
use Envless\Envless;

$envless = new Envless();

foreach ($envless->products->iterateProjects('billing') as $project) {
    echo $project['slug'], PHP_EOL;
}

Parameters

ParameterTypeRequiredDescription
$slugstringYesProduct slug, or the product uniqueId when the value is UUID shaped.
$limitintNoPage size for each underlying request, capped at 100.
$offsetintNoRow to start the walk from.
$searchstringNoCase-insensitive substring match against project name and slug.
$orderstringNoDefaults to name, which sorts A to Z. Pass asc for oldest first or desc for newest first on createdAt.
$timeoutint|floatNoSeconds each attempt of this call may take, the response body included, before it throws Envless\Exception\NetworkException with isTimeout() true. Overrides the client's timeout for this call, and 0 turns the limit off.

Returns

An Generator<int, ProjectResource> that yields each project in the product.

Reads the projects collection. list returns one page as an Envless\Result\Page with items and pagination, listAll collects every page into an array, and iterate returns a Generator that yields one item at a time, fetching the next page only when the loop gets there.

Worth knowing

  • The first request is not sent until the loop starts, so an unreachable product surfaces on the first iteration and not at call time.

Required scopes

products:read and projects:read

Underlying endpoint

GET /products/{slug}/projects

Request and response schema, every error code, and a live playground.

In TypeScript

envless.products.iterateProjects()

The same method in @goenvless/sdk, with the same request, retries and errors.