PHP Fiber::getReturn() Method: Usage and Examples

The PHP Fiber::getReturn API performs a focused operation on an object or value. The examples below show its effect on actual data.

Returns the final result of a completed Generator or Fiber.

What Is Fiber::getReturn in PHP?

Returns the final result of a completed Generator or Fiber.

Syntax:

Fiber::getReturn(): mixed

This operation has no parameters.

Return type declared by PHP: mixed. The value or side effect is demonstrated in the examples below.

Example 1: Basic Usage

This example uses a small input to make the main behavior visible.

<?php

$fiber = new Fiber(function (): string {
    $input = Fiber::suspend("waiting");
    return "completed: " . $input;
});
$fiber->start();
$fiber->resume("approved");
var_dump($fiber->isTerminated());
echo $fiber->getReturn();

Output:

bool(true)
completed: approved

Returns the final result of a completed Generator or Fiber.

Example 2: A Different Input

A different set of values shows the same operation in another situation.

<?php

$fiber = new Fiber(function (): string {
    $input = Fiber::suspend("request");
    return "completed: " . $input;
});
$fiber->start();
$fiber->resume("accepted");
var_dump($fiber->isTerminated());
echo $fiber->getReturn();

Output:

bool(true)
completed: accepted

Trying to get the final return value before completion raises an exception.

Practical Example: Applying the Feature

This example shows an application-style use of the feature, with its surrounding setup visible.

<?php

$fiber = new Fiber(function (): string {
    $input = Fiber::suspend("pending");
    return "completed: " . $input;
});
$fiber->start();
$fiber->resume("verified");
var_dump($fiber->isTerminated());
echo $fiber->getReturn();

Output:

bool(true)
completed: verified

The code is shown for learning. Adjust the class names, inputs and error handling to suit your application.

Important Behavior and Edge Cases

• Trying to get the final return value before completion raises an exception.
• Returns the final result of a completed Generator or Fiber.
• Observe differences in empty inputs, invalid states and optional extension availability where relevant.

Comparison With Related Approaches

Common Beginner Mistakes

Key Takeaways

• Returns the final result of a completed Generator or Fiber.
• Trying to get the final return value before completion raises an exception.
• Use the example that matches the values, runtime version and dependencies in your application.

Fiber::getReturn is useful when its behavior matches the data structure and lifecycle of your PHP application. Choose it with a clear understanding of its preconditions and returned values.