The PHP Fiber::throw API performs a focused operation on an object or value. The examples below show its effect on actual data.
Injects a Throwable into a suspended Fiber or Generator at the point where it resumes.
What Is Fiber::throw in PHP?
Injects a Throwable into a suspended Fiber or Generator at the point where it resumes.
Syntax:
Fiber::throw(Throwable $exception): mixed
The method accepts the following parameters:
$exception— Required. A Throwable parameter named exception; the examples below show a supported value.
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();
try { $fiber->throw(new RuntimeException("Cancelled")); } catch (RuntimeException $error) { echo $error->getMessage(); }
Output:
Cancelled
Injects a Throwable into a suspended Fiber or Generator at the point where it resumes.
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();
try { $fiber->throw(new RuntimeException("Aborted")); } catch (RuntimeException $error) { echo $error->getMessage(); }
Output:
Aborted
A fiber must be suspended before resume() or throw(); getReturn() is available only after successful termination.
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();
try { $fiber->throw(new RuntimeException("Stopped")); } catch (RuntimeException $error) { echo $error->getMessage(); }
Output:
Stopped
The code is shown for learning. Adjust the class names, inputs and error handling to suit your application.
Important Behavior and Edge Cases
- A fiber must be suspended before resume() or throw(); getReturn() is available only after successful termination.
- Injects a Throwable into a suspended Fiber or Generator at the point where it resumes.
- Observe differences in empty inputs, invalid states and optional extension availability where relevant.
Comparison With Related Approaches
| Approach | Important Difference |
|---|---|
Fiber::throw | Injects a Throwable into a suspended Fiber or Generator at the point where it resumes. |
| Generator | A Fiber suspends a whole call stack and supports resume() and throw(), while a Generator primarily yields sequence values. |
Common Beginner Mistakes
| Mistake | Correct Approach |
|---|---|
Ignoring the documented state or precondition of Fiber::throw | A fiber must be suspended before resume() or throw(); getReturn() is available only after successful termination. |
| Expecting a different type of result | Read the declared return type and distinguish returned values from changes to the source object. |
| Assuming a related API works identically | A Fiber suspends a whole call stack and supports resume() and throw(), while a Generator primarily yields sequence values. |
Key Takeaways
- Injects a Throwable into a suspended Fiber or Generator at the point where it resumes.
- A fiber must be suspended before resume() or throw(); getReturn() is available only after successful termination.
- Use the example that matches the values, runtime version and dependencies in your application.
Fiber::throw 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.