The PHP Fiber::isRunning API performs a focused operation on an object or value. The examples below show its effect on actual data.
Reports whether the Fiber is currently executing its callback.
What Is Fiber::isRunning in PHP?
Reports whether the Fiber is currently executing its callback.
Syntax:
Fiber::isRunning(): bool
This operation has no parameters.
Return type declared by PHP: bool. 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;
});
var_dump($fiber->isRunning());
Output:
bool(false)
Reports whether the Fiber is currently executing its callback.
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;
});
var_dump($fiber->isRunning());
Output:
bool(false)
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;
});
var_dump($fiber->isRunning());
Output:
bool(false)
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.
- Reports whether the Fiber is currently executing its callback.
- Observe differences in empty inputs, invalid states and optional extension availability where relevant.
Comparison With Related Approaches
| Approach | Important Difference |
|---|---|
Fiber::isRunning | Reports whether the Fiber is currently executing its callback. |
| 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::isRunning | 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
- Reports whether the Fiber is currently executing its callback.
- 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::isRunning 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.