PHPackages                             ody/task - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. ody/task

ActiveLibrary[Framework](/categories/framework)

ody/task
========

Manage Swoole tasks in ODY framework

0.1.2(1y ago)041proprietaryPHP

Since Mar 21Pushed 1y ago1 watchersCompare

[ Source](https://github.com/ody-dev/task)[ Packagist](https://packagist.org/packages/ody/task)[ RSS](/packages/ody-task/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)DependenciesVersions (5)Used By (1)

TaskManager API Reference
=========================

[](#taskmanager-api-reference)

Table of Contents
-----------------

[](#table-of-contents)

- [Task Class](#task-class)
- [TaskInterface](#taskinterface)
- [TaskMiddlewareInterface](#taskmiddlewareinterface)
- [TaskGroup Class](#taskgroup-class)
- [TaskBatch Class](#taskbatch-class)
- [TaskManager Class](#taskmanager-class)
- [TaskHandler Class](#Taskhandler-class)

Task Class
----------

[](#task-class)

The primary entry point for creating and managing tasks in the system.

### Constants

[](#constants)

ConstantTypeValueDescription`PRIORITY_HIGH`int20High priority tasks are processed before normal and low priority tasks`PRIORITY_NORMAL`int10Default priority level`PRIORITY_LOW`int5Low priority tasks are processed after high and normal priority tasks`STATUS_PENDING`string'pending'Task is waiting to be processed`STATUS_PROCESSING`string'processing'Task is currently being processed`STATUS_COMPLETED`string'completed'Task has been completed successfully`STATUS_FAILED`string'failed'Task has failed`STATUS_CANCELLED`string'cancelled'Task has been cancelled`STATUS_RETRYING`string'retrying'Task failed but will be retried### Methods

[](#methods)

#### `execute(string $taskClass, array $params = [], int $priority = self::PRIORITY_NORMAL): int`

[](#executestring-taskclass-array-params---int-priority--selfpriority_normal-int)

Execute a task immediately.

**Parameters:**

- `$taskClass`: The full class name of the task to execute (must implement TaskInterface)
- `$params`: Parameters to pass to the task's handle method
- `$priority`: Priority level for the task

**Returns:** Task ID

**Example:**

```
$taskId = Task::execute(\App\Tasks\SendEmailTask::class, [
    'to' => 'user@example.com',
    'subject' => 'Welcome',
    'body' => 'Welcome to our service!'
]);
```

#### `later(string $taskClass, array $params = [], int $delayMs = 1000, int $priority = self::PRIORITY_NORMAL): int`

[](#laterstring-taskclass-array-params---int-delayms--1000-int-priority--selfpriority_normal-int)

Schedule a task to run after a delay.

**Parameters:**

- `$taskClass`: The full class name of the task to execute
- `$params`: Parameters to pass to the task's handle method
- `$delayMs`: Delay in milliseconds before executing the task
- `$priority`: Priority level for the task

**Returns:** Task ID

**Example:**

```
$taskId = Task::later(\App\Tasks\SendReminderTask::class,
    ['user_id' => 123],
    60000  // 60 seconds
);
```

#### `withRetry(string $taskClass, array $params = [], array $retryOptions = ['attempts' => 3, 'delay' => 1000, 'multiplier' => 2], int $priority = self::PRIORITY_NORMAL): int`

[](#withretrystring-taskclass-array-params---array-retryoptions--attempts--3-delay--1000-multiplier--2-int-priority--selfpriority_normal-int)

Execute a task with automatic retry on failure.

**Parameters:**

- `$taskClass`: The full class name of the task to execute
- `$params`: Parameters to pass to the task's handle method
- `$retryOptions`: Retry configuration
    - `attempts`: Maximum number of attempts (including the first attempt)
    - `delay`: Initial delay in milliseconds before retrying
    - `multiplier`: Multiplier for exponential backoff (each retry increases delay by this factor)
- `$priority`: Priority level for the task

**Returns:** Task ID

**Example:**

```
$taskId = Task::withRetry(\App\Tasks\APIRequestTask::class,
    ['endpoint' => '/api/data', 'method' => 'GET'],
    ['attempts' => 5, 'delay' => 1000, 'multiplier' => 2]
);
```

#### `group(string $name = null): TaskGroup`

[](#groupstring-name--null-taskgroup)

Create a new task group for organizing related tasks.

**Parameters:**

- `$name`: Optional name for the group (auto-generated if not provided)

**Returns:** A new TaskGroup instance

**Example:**

```
$group = Task::group('user-onboarding')
    ->add(\App\Tasks\CreateUserTask::class, ['email' => 'user@example.com'])
    ->add(\App\Tasks\SendWelcomeEmailTask::class, ['email' => 'user@example.com']);
```

#### `batch(array $tasks): TaskBatch`

[](#batcharray-tasks-taskbatch)

Create a batch for processing multiple similar tasks efficiently.

**Parameters:**

- `$tasks`: Array of task definitions (strings or arrays with 'class' and 'params' keys)

**Returns:** A new TaskBatch instance

**Example:**

```
$tasks = [];
foreach ($users as $user) {
    $tasks[] = [
        'class' => \App\Tasks\NotifyUserTask::class,
        'params' => ['user_id' => $user->id, 'message' => 'System maintenance']
    ];
}
$batch = Task::batch($tasks);
```

#### `cancel(int $taskId): bool`

[](#cancelint-taskid-bool)

Cancel a pending task.

**Parameters:**

- `$taskId`: The ID of the task to cancel

**Returns:** True if the task was cancelled, false otherwise

**Example:**

```
$cancelled = Task::cancel($taskId);
```

#### `status(int $taskId): array`

[](#statusint-taskid-array)

Get the current status of a task.

**Parameters:**

- `$taskId`: The ID of the task

**Returns:** Array with task status information

**Example:**

```
$status = Task::status($taskId);
// Returns: [
//   'id' => 123,
//   'class' => '\App\Tasks\SendEmailTask',
//   'status' => 'completed',
//   'attempts' => 1,
//   'created_at' => 1615480245.7843,
//   'started_at' => 1615480245.8421,
//   'completed_at' => 1615480246.0124,
//   'execution_time' => 0.1703,
//   'result' => [...],
//   'error' => null
// ]
```

TaskInterface
-------------

[](#taskinterface)

Interface that all task classes must implement.

### Methods

[](#methods-1)

#### `handle(array $params = [])`

[](#handlearray-params--)

Process the task.

**Parameters:**

- `$params`: Parameters passed to the task

**Returns:** Any value, which will be available in the task result

**Example:**

```
class SendEmailTask implements TaskInterface
{
    public function handle(array $params = [])
    {
        // Send email logic here
        $result = mail($params['to'], $params['subject'], $params['body']);

        return [
            'success' => $result,
            'to' => $params['to'],
            'sent_at' => date('Y-m-d H:i:s')
        ];
    }
}
```

TaskMiddlewareInterface
-----------------------

[](#taskmiddlewareinterface)

Interface for creating task middleware.

### Methods

[](#methods-2)

#### `process(array $task): array`

[](#processarray-task-array)

Process the task before it's enqueued.

**Parameters:**

- `$task`: Array containing task information
    - `params`: The task parameters

**Returns:** Modified task array

**Example:**

```
class LoggingMiddleware implements TaskMiddlewareInterface
{
    public function process(array $task): array
    {
        // Add logging metadata to the task
        $task['params']['__meta'] = [
            'logged_at' => time(),
            'request_id' => $_SERVER['REQUEST_ID'] ?? uniqid()
        ];

        return $task;
    }
}
```

TaskGroup Class
---------------

[](#taskgroup-class)

Manages a group of related tasks.

### Methods

[](#methods-3)

#### `__construct(?string $name = null)`

[](#__constructstring-name--null)

Create a new task group.

**Parameters:**

- `$name`: Optional name for the group (auto-generated if not provided)

#### `add(string $taskClass, array $params = [], int $priority = Task::PRIORITY_NORMAL): self`

[](#addstring-taskclass-array-params---int-priority--taskpriority_normal-self)

Add a task to the group.

**Parameters:**

- `$taskClass`: The full class name of the task to execute
- `$params`: Parameters to pass to the task's handle method
- `$priority`: Priority level for the task

**Returns:** $this (for method chaining)

#### `concurrency(?int $limit): self`

[](#concurrencyint-limit-self)

Set a concurrency limit for the group.

**Parameters:**

- `$limit`: Maximum number of tasks in the group that can run simultaneously (null for no limit)

**Returns:** $this (for method chaining)

#### `allowFailures(bool $allow = true): self`

[](#allowfailuresbool-allow--true-self)

Configure whether failures in one task should stop other tasks in the group.

**Parameters:**

- `$allow`: If true, other tasks will continue even if some tasks fail

**Returns:** $this (for method chaining)

#### `middleware($middleware): self`

[](#middlewaremiddleware-self)

Add middleware to all tasks in this group.

**Parameters:**

- `$middleware`: Middleware class name or callable

**Returns:** $this (for method chaining)

#### `dispatch(): array`

[](#dispatch-array)

Execute all tasks in the group.

**Returns:** Array of task IDs

#### `wait(int $timeout = 30000): array`

[](#waitint-timeout--30000-array)

Wait for all tasks in the group to complete.

**Parameters:**

- `$timeout`: Maximum time to wait in milliseconds

**Returns:** Array of task results, indexed by task ID

#### `cancel(): bool`

[](#cancel-bool)

Cancel all pending tasks in the group.

**Returns:** True if all tasks were cancelled, false otherwise

TaskBatch Class
---------------

[](#taskbatch-class)

Efficiently processes multiple similar tasks.

### Methods

[](#methods-4)

#### `__construct(array $tasks)`

[](#__constructarray-tasks)

Create a new task batch.

**Parameters:**

- `$tasks`: Array of task definitions (strings or arrays with 'class' and 'params' keys)

#### `dispatch(int $priority = Task::PRIORITY_NORMAL): array`

[](#dispatchint-priority--taskpriority_normal-array)

Execute all tasks in the batch.

**Parameters:**

- `$priority`: Priority level for all tasks in the batch

**Returns:** Array of task IDs

#### `wait(int $timeout = 30000): array`

[](#waitint-timeout--30000-array-1)

Wait for all tasks in the batch to complete.

**Parameters:**

- `$timeout`: Maximum time to wait in milliseconds

**Returns:** Array of task results, indexed by task ID

#### `cancel(): bool`

[](#cancel-bool-1)

Cancel all pending tasks in the batch.

**Returns:** True if all tasks were cancelled, false otherwise

TaskManager Class
-----------------

[](#taskmanager-class)

Core class managing task queues and processing.

### Methods

[](#methods-5)

#### `getInstance(): TaskManager`

[](#getinstance-taskmanager)

Get the singleton instance of the TaskManager.

**Returns:** TaskManager instance

#### `setServer(Server $server): void`

[](#setserverserver-server-void)

Set the Swoole server instance.

**Parameters:**

- `$server`: Swoole server instance

#### `registerMiddleware($middleware): self`

[](#registermiddlewaremiddleware-self)

Register global middleware that applies to all tasks.

**Parameters:**

- `$middleware`: Middleware class name or callable

**Returns:** $this (for method chaining)

#### `enqueue(string $taskClass, array $params = [], int $priority = Task::PRIORITY_NORMAL): int`

[](#enqueuestring-taskclass-array-params---int-priority--taskpriority_normal-int)

Add a task to the queue for immediate execution.

**Parameters:**

- `$taskClass`: The full class name of the task to execute
- `$params`: Parameters to pass to the task's handle method
- `$priority`: Priority level for the task

**Returns:** Task ID

#### `enqueueDelayed(string $taskClass, array $params = [], int $delayMs = 1000, int $priority = Task::PRIORITY_NORMAL): int`

[](#enqueuedelayedstring-taskclass-array-params---int-delayms--1000-int-priority--taskpriority_normal-int)

Add a task to be executed after a delay.

**Parameters:**

- `$taskClass`: The full class name of the task to execute
- `$params`: Parameters to pass to the task's handle method
- `$delayMs`: Delay in milliseconds before executing the task
- `$priority`: Priority level for the task

**Returns:** Task ID

#### `enqueueWithRetry(string $taskClass, array $params = [], array $retryOptions = ['attempts' => 3, 'delay' => 1000, 'multiplier' => 2], int $priority = Task::PRIORITY_NORMAL): int`

[](#enqueuewithretrystring-taskclass-array-params---array-retryoptions--attempts--3-delay--1000-multiplier--2-int-priority--taskpriority_normal-int)

Add a task with retry options.

**Parameters:**

- `$taskClass`: The full class name of the task to execute
- `$params`: Parameters to pass to the task's handle method
- `$retryOptions`: Retry configuration
    - `attempts`: Maximum number of attempts (including the first attempt)
    - `delay`: Initial delay in milliseconds before retrying
    - `multiplier`: Multiplier for exponential backoff
- `$priority`: Priority level for the task

**Returns:** Task ID

#### `getNextTask(): ?array`

[](#getnexttask-array)

Get the next task from the highest priority queue.

**Returns:** Task data array or null if queues are empty

#### `addTaskToGroup(int $taskId, string $groupName): void`

[](#addtasktogroupint-taskid-string-groupname-void)

Add a task to a group.

**Parameters:**

- `$taskId`: The ID of the task
- `$groupName`: The name of the group

#### `addTaskToBatch(int $taskId, string $batchId): void`

[](#addtasktobatchint-taskid-string-batchid-void)

Add a task to a batch.

**Parameters:**

- `$taskId`: The ID of the task
- `$batchId`: The ID of the batch

#### `waitForGroup(string $groupName, int $timeout = 30000): array`

[](#waitforgroupstring-groupname-int-timeout--30000-array)

Wait for all tasks in a group to complete.

**Parameters:**

- `$groupName`: The name of the group
- `$timeout`: Maximum time to wait in milliseconds

**Returns:** Array of task results, indexed by task ID

#### `waitForBatch(string $batchId, int $timeout = 30000): array`

[](#waitforbatchstring-batchid-int-timeout--30000-array)

Wait for all tasks in a batch to complete.

**Parameters:**

- `$batchId`: The ID of the batch
- `$timeout`: Maximum time to wait in milliseconds

**Returns:** Array of task results, indexed by task ID

#### `cancelTask(int $taskId): bool`

[](#canceltaskint-taskid-bool)

Cancel a specific task.

**Parameters:**

- `$taskId`: The ID of the task to cancel

**Returns:** True if the task was cancelled, false otherwise

#### `cancelGroup(string $groupName): bool`

[](#cancelgroupstring-groupname-bool)

Cancel all tasks in a group.

**Parameters:**

- `$groupName`: The name of the group

**Returns:** True if all tasks were cancelled, false otherwise

#### `cancelBatch(string $batchId): bool`

[](#cancelbatchstring-batchid-bool)

Cancel all tasks in a batch.

**Parameters:**

- `$batchId`: The ID of the batch

**Returns:** True if all tasks were cancelled, false otherwise

#### `getTaskStatus(int $taskId): array`

[](#gettaskstatusint-taskid-array)

Get the status of a task.

**Parameters:**

- `$taskId`: The ID of the task

**Returns:** Array with task status information

#### `getMetrics(): array`

[](#getmetrics-array)

Get metrics for monitoring.

**Returns:** Array with metrics:

- `total_tasks`: Total number of tasks created
- `completed_tasks`: Number of successfully completed tasks
- `failed_tasks`: Number of failed tasks
- `retried_tasks`: Number of retried tasks
- `cancelled_tasks`: Number of cancelled tasks
- `average_execution_time`: Average task execution time in seconds

TaskHandler Class
-----------------

[](#taskhandler-class)

Integrates the TaskManager with Swoole.

### Methods

[](#methods-6)

#### `init(Server $server): void`

[](#initserver-server-void)

Initialize the task handler with the server.

**Parameters:**

- `$server`: Swoole server instance

**Example:**

```
$server = new Swoole\Server('0.0.0.0', 9501);
$server->set([
    'worker_num' => 4,
    'task_worker_num' => 8,
    'task_enable_coroutine' => true,
]);

SwooleTaskHandler::init($server);
```

#### `handleTask(array $data)`

[](#handletaskarray-data)

Handle a task execution.

**Parameters:**

- `$data`: Task data array

**Returns:** The result from the task's handle method, or an error array

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance46

Moderate activity, may be stable

Popularity3

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity31

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~8 days

Total

3

Last Release

407d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/984734252c6b932be5ef737920c3d0f792283664e75ba405f3df268cc1da138c?d=identicon)[IlyasDeckers](/maintainers/IlyasDeckers)

---

Top Contributors

[![IlyasDeckers](https://avatars.githubusercontent.com/u/18727603?v=4)](https://github.com/IlyasDeckers "IlyasDeckers (8 commits)")

### Embed Badge

![Health badge](/badges/ody-task/health.svg)

```
[![Health](https://phpackages.com/badges/ody-task/health.svg)](https://phpackages.com/packages/ody-task)
```

###  Alternatives

[laravel/passport

Laravel Passport provides OAuth2 server support to Laravel.

3.4k85.0M532](/packages/laravel-passport)[nolimits4web/swiper

Most modern mobile touch slider and framework with hardware accelerated transitions

41.8k177.2k1](/packages/nolimits4web-swiper)[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k36.7M259](/packages/laravel-dusk)[laravel/prompts

Add beautiful and user-friendly forms to your command-line applications.

712181.8M596](/packages/laravel-prompts)[cakephp/chronos

A simple API extension for DateTime.

1.4k47.7M121](/packages/cakephp-chronos)[laravel/pail

Easily delve into your Laravel application's log files directly from the command line.

91545.3M590](/packages/laravel-pail)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)