CodeIgniter Tasks

https://github.com/codeigniter4/tasks
Admin
CodeIgniter Tasks is a task scheduler specifically designed for CodeIgniter 4 applications.
Tokens:10,670
Snippets:112
Trust Score:9
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/index.md

Install the codeigniter4/tasks package using Composer.

```console
composer require codeigniter4/tasks
```

--------------------------------

### Registering a task in app/Config/Tasks.php

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Example of using a closure within the init() method to refresh demo content every Monday.

```php
<?php

namespace Config;

use CodeIgniter\Tasks\Config\Tasks as BaseTasks;
use CodeIgniter\Tasks\Scheduler;

class Tasks extends BaseTasks
{
    /**
     * Register any tasks within this method for the application.
     *
     * @param Scheduler $schedule
     */
    public function init(Scheduler $schedule)
    {
        $schedule->call(function() {
            DemoContent::refresh();
        })->mondays();
    }
}
```

--------------------------------

### Define tasks in init() method

Source: https://github.com/codeigniter4/tasks/blob/develop/README.md

Example of defining a scheduled task in the init() method of the Tasks config file.

```php
// app/Config/Tasks.php
<?php

namespace Config;

use CodeIgniter\Tasks\Config\Tasks as BaseTasks;
use CodeIgniter\Tasks\Scheduler;

class Tasks extends BaseTasks
{
    /**
     * Register any tasks within this method for the application.
     *
     * @param Scheduler $schedule
     */
    public function init(Scheduler $schedule)
    {
        $schedule->command('demo:refresh --all')->mondays('11:00 pm');
    }
}
```

--------------------------------

### Schedule a task with Scheduler

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/index.md

Example of a Tasks class extending BaseTasks, with an init method that schedules a command to run on weekdays hourly.

```php
<?php
// ...
class Tasks extends BaseTasks
{
    // ...
    public function init(Scheduler $schedule)
    {
        $schedule->command('foo')->weekdays()->hourly();
    }
}
```

--------------------------------

### Manual installation: Autoload.php $psr4 array

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/installation.md

PHP configuration snippet showing how to add the CodeIgniter\Tasks and CodeIgniter\Settings namespaces to the $psr4 array in app/Config/Autoload.php.

```php
<?php

// ...

public $psr4 = [
    APP_NAMESPACE => APPPATH, // For custom app namespace
    'Config'      => APPPATH . 'Config',
    'CodeIgniter\Settings' => APPPATH . 'ThirdParty/settings/src',
    'CodeIgniter\Tasks'    => APPPATH . 'ThirdParty/tasks/src',
];

// ...
```

--------------------------------

### Schedule a command task (short form)

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/vision.md

Schedules a command task using the same syntax as the init() example, but shown as a standalone line. This is the command task type.

```php
	$schedule->command('foo:bar')->nightly();
```

--------------------------------

### Composer require codeigniter4/tasks:dev-develop

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/installation.md

Command to install the develop branch explicitly.

```console
composer require codeigniter4/tasks:dev-develop
```

--------------------------------

### Scheduling URL Calls

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Perform a GET request to a URL using the url() method.

```php
$schedule->url('https://my-status-cloud.com?site=foo.com')->everyFiveMinutes();
```

--------------------------------

### Schedule a URL task

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/vision.md

Schedules a URL task to access a remote URL, useful for interacting with APIs or coordinating tasks across servers. The example runs only in production and every Tuesday. Note: URL tasks perform a simple GET request; for more involved remote calls (like authentication), write a separate command.

```php
	$schedule->url('https://example.com/api/sync_remote_db')->environments('production')->everyTuesday(););
```

--------------------------------

### Schedule a shell command task

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/vision.md

Schedules a shell command to be executed via exec() or shell(). The example runs 'cp foo bar' daily at 11:00 pm.

```php
	$schedule->shell('cp foo bar')->daily()->at('11:00 pm');
```

--------------------------------

### Prevent overlapping task execution with singleInstance()

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Prevents overlapping executions of a scheduled task by using the singleInstance() method. The lock remains active until the task completes, so a new instance won't start until the running one finishes.

```php
$schedule->command('demo:heavy-task')->everyMinute()->singleInstance();
```

--------------------------------

### Migrate database for Unix

Source: https://github.com/codeigniter4/tasks/blob/develop/README.md

Run the database migration for Unix systems.

```bash
php spark migrate -n CodeIgniter\\Settings
```

--------------------------------

### Migrate database for Windows

Source: https://github.com/codeigniter4/tasks/blob/develop/README.md

Run the database migration for Windows systems.

```bash
php spark migrate -n CodeIgniter\Settings
```

--------------------------------

### Run tasks with tasks:run

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/cli-commands.md

Primary entry point to the Tasks system. Should be called by a cron task every minute. Typically not run manually.

```console
php spark tasks:run
```

--------------------------------

### Combine frequency methods: weekdays(), hourly(), environments('development')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Combines frequency methods to run a command every hour on weekdays, restricted to the 'development' environment. Use this to create nuanced schedules by chaining methods from the frequency options table.

```php
$schedule->command('foo')
    ->weekdays()
    ->hourly()
    ->environments('development');
```

--------------------------------

### ->everyThirtyMinutes()

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every 30 minutes.

```APIDOC
## ->everyThirtyMinutes()

### Description
Runs every 30 minutes (12:00, 12:30, etc).

### Method
->everyThirtyMinutes()

### Parameters
None.

### Example
```php
$schedule->command('foo')->everyThirtyMinutes();
```
```

--------------------------------

### ->everyFifteenMinutes()

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every 15 minutes.

```APIDOC
## ->everyFifteenMinutes()

### Description
Runs every 15 minutes (12:00, 12:15, etc).

### Method
->everyFifteenMinutes()

### Parameters
None.

### Example
```php
$schedule->command('foo')->everyFifteenMinutes();
```
```

--------------------------------

### List tasks with tasks:list

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/cli-commands.md

Lists all defined tasks with their type, schedule, last run, next run, and run count. Output is a formatted table.

```console
php spark tasks:list
```

--------------------------------

### CRON job to run the scheduler

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/vision.md

Set up a cronjob on the server to run every minute, executing the `tasks:run` command via `php spark`.

```bash
* * * * * cd /path-to-your-project && php spark tasks:run
```

--------------------------------

### ->minutes([0,20,40])

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task at the specified minutes of each hour.

```APIDOC
## ->minutes([0,20,40])

### Description
Runs at the specified minutes (0-59) of each hour.

### Method
->minutes()

### Parameters
- **minutes** (array) - Required - An array of minutes (0-59) to run the task.

### Example
```php
$schedule->command('foo')->minutes([0,20,40]);
```
```

--------------------------------

### Publish Tasks config with tasks:publish

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/cli-commands.md

Publishes the Tasks config file into the current application.

```console
php spark tasks:publish
```

--------------------------------

### ->everyFiveMinutes()

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every 5 minutes.

```APIDOC
## ->everyFiveMinutes()

### Description
Runs every 5 minutes (12:00, 12:05, 12:10, etc).

### Method
->everyFiveMinutes()

### Parameters
None.

### Example
```php
$schedule->command('foo')->everyFiveMinutes();
```
```

--------------------------------

### Enable task runner with tasks:enable

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/cli-commands.md

Enables the task runner if previously disabled, allowing all tasks to resume running.

```console
php spark tasks:enable
```

--------------------------------

### ->everyMinute(20)

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every specified number of minutes.

```APIDOC
## ->everyMinute(20)

### Description
Runs every 20 minutes.

### Method
->everyMinute()

### Parameters
- **minutes** (int) - Required - The number of minutes between runs.

### Example
```php
$schedule->command('foo')->everyMinute(20);
```
```

--------------------------------

### ->daily('4:00 am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task daily at a specified time, defaulting to midnight if no time is provided.

```APIDOC
## ->daily('4:00 am')

### Description
Runs the task daily at 12:00am unless a time string is passed in.

### Method
->daily()

### Parameters
- **time** (string) - Optional - The time of day to run the task (e.g., '4:00 am').

### Example
```php
$schedule->command('foo')->daily('4:00 am');
```
```

--------------------------------

### Scheduling CLI Commands

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Use the command() method to run custom CLI commands with arguments or options.

```php
$schedule->command('demo:refresh --all');
```

--------------------------------

### Run a single task with tasks:run --task

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/cli-commands.md

Immediately runs a single task by name. The name can be set with ->named('foo') or auto-generated, and found via tasks:list.

```console
php spark tasks:run --task emails
```

--------------------------------

### ->quarterly('5:00am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task on the first day of each quarter at midnight or at a specified time.

```APIDOC
## ->quarterly('5:00am')

### Description
Runs the first day of each quarter (Jan 1, Apr 1, July 1, Oct 1) at 12:00am unless a time is passed in.

### Method
->quarterly()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '5:00am').

### Example
```php
$schedule->command('foo')->quarterly('5:00am');
```
```

--------------------------------

### ->monthly('12:21pm')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task on the first day of every month at midnight or at a specified time.

```APIDOC
## ->monthly('12:21pm')

### Description
Runs the first day of every month at 12:00am unless a time is passed in.

### Method
->monthly()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '12:21pm').

### Example
```php
$schedule->command('foo')->monthly('12:21pm');
```
```

--------------------------------

### ->hourly() / ->hourly(15)

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task at the top of every hour or at a specified minute.

```APIDOC
## ->hourly() / ->hourly(15)

### Description
Runs at the top of every hour or at the specified minute.

### Method
->hourly()

### Parameters
- **minute** (int) - Optional - The minute of the hour to run the task (e.g., 15).

### Example
```php
$schedule->command('foo')->hourly(15);
```
```

--------------------------------

### ->mondays('3:15am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every Monday at midnight or at a specified time.

```APIDOC
## ->mondays('3:15am')

### Description
Runs every Monday at midnight, unless a time is passed in.

### Method
->mondays()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '3:15am').

### Example
```php
$schedule->command('foo')->mondays('3:15am');
```
```

--------------------------------

### Composer error: minimum-stability

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/installation.md

Error message when the package version cannot be found due to minimum-stability settings.

```console
Could not find a version of package codeigniter4/tasks matching your minimum-stability (stable).
Require it with an explicit version constraint allowing its desired stability.
```

--------------------------------

### Scheduling Queue Jobs with singleInstance()

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Apply a lock to a queue job to ensure only one instance runs at a time.

```php
$schedule->queue('queue-name', 'jobName', ['data' => 'array'])
    ->hourly()
    ->singleInstance();
```

--------------------------------

### Composer config minimum-stability dev and prefer-stable

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/installation.md

Commands to change the minimum-stability and prefer-stable settings in composer.json.

```console
composer config minimum-stability dev
```

```console
composer config prefer-stable true
```

--------------------------------

### Cron job to run tasks every minute

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/configuration.md

Add this line to your cron job configuration. Replace /path-to-your-project with the actual path. It runs the tasks:run command every minute and discards output.

```console
* * * * * cd /path-to-your-project && php spark tasks:run >> /dev/null 2>&1
```

--------------------------------

### Scheduling Shell Commands

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Execute server commands using the shell() method, which utilizes PHP's exec(). Ensure exec access is enabled on your server.

```php
$schedule->shell('cp foo bar')->daily()->at('11:00 pm');
```

--------------------------------

### Scheduling Queue Jobs

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Schedule a job to the queue by specifying the queue name, job name, and data.

```php
$schedule->queue('queue-name', 'jobName', ['data' => 'array'])->hourly();
```

--------------------------------

### ->hours([0,10,16])

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task at the specified hours of the day.

```APIDOC
## ->hours([0,10,16])

### Description
Runs at the specified hours (0-23).

### Method
->hours()

### Parameters
- **hours** (array) - Required - An array of hours (0-23) to run the task.

### Example
```php
$schedule->command('foo')->hours([0,10,16]);
```
```

--------------------------------

### ->weekdays('1:23pm')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task Monday through Friday at midnight or at a specified time.

```APIDOC
## ->weekdays('1:23pm')

### Description
Runs Monday through Friday at 12:00am unless a time is passed in.

### Method
->weekdays()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '1:23pm').

### Example
```php
$schedule->command('foo')->weekdays('1:23pm');
```
```

--------------------------------

### ->environments('local', 'prod')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Restricts the task to run only in the specified environments.

```APIDOC
## ->environments('local', 'prod')

### Description
Restricts the task to run only in the specified environments.

### Method
->environments()

### Parameters
- **environments** (string...) - Required - One or more environment names (e.g., 'local', 'prod').

### Example
```php
$schedule->command('foo')->environments('local', 'prod');
```
```

--------------------------------

### ->everyHour(3, 15)

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every specified number of hours at a given minute.

```APIDOC
## ->everyHour(3, 15)

### Description
Runs every 3 hours at XX:15.

### Method
->everyHour()

### Parameters
- **hours** (int) - Required - The number of hours between runs.
- **minute** (int) - Optional - The minute of the hour to run (default 0).

### Example
```php
$schedule->command('foo')->everyHour(3, 15);
```
```

--------------------------------

### ->yearly('12:34am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task on the first day of the year at midnight or at a specified time.

```APIDOC
## ->yearly('12:34am')

### Description
Runs the first day of the year at 12:00am unless a time is passed in.

### Method
->yearly()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '12:34am').

### Example
```php
$schedule->command('foo')->yearly('12:34am');
```
```

--------------------------------

### Schedule a command task with nightly frequency

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/vision.md

Schedules a CLI command by its name (e.g., 'foo:bar') to run nightly. This is the basic pattern for command tasks.

```php
public function init(Scheduler $schedule)
{
	$schedule->command('foo:bar')->nightly();
}
```

--------------------------------

### ->saturdays('3:15am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every Saturday at midnight or at a specified time.

```APIDOC
## ->saturdays('3:15am')

### Description
Runs every Saturday at midnight, unless a time is passed in.

### Method
->saturdays()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '3:15am').

### Example
```php
$schedule->command('foo')->saturdays('3:15am');
```
```

--------------------------------

### ->fridays('3:15am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every Friday at midnight or at a specified time.

```APIDOC
## ->fridays('3:15am')

### Description
Runs every Friday at midnight, unless a time is passed in.

### Method
->fridays()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '3:15am').

### Example
```php
$schedule->command('foo')->fridays('3:15am');
```
```

--------------------------------

### ->sundays('3:15am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every Sunday at midnight or at a specified time.

```APIDOC
## ->sundays('3:15am')

### Description
Runs every Sunday at midnight, unless a time is passed in.

### Method
->sundays()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '3:15am').

### Example
```php
$schedule->command('foo')->sundays('3:15am');
```
```

--------------------------------

### ->weekends('2:34am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task on Saturday and Sunday at midnight or at a specified time.

```APIDOC
## ->weekends('2:34am')

### Description
Runs Saturday and Sunday at 12:00am unless a time is passed in.

### Method
->weekends()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '2:34am').

### Example
```php
$schedule->command('foo')->weekends('2:34am');
```
```

--------------------------------

### ->tuesdays('3:15am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every Tuesday at midnight or at a specified time.

```APIDOC
## ->tuesdays('3:15am')

### Description
Runs every Tuesday at midnight, unless a time is passed in.

### Method
->tuesdays()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '3:15am').

### Example
```php
$schedule->command('foo')->tuesdays('3:15am');
```
```

--------------------------------

### ->everyMonth(4)

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every specified number of months.

```APIDOC
## ->everyMonth(4)

### Description
Runs every 4 months.

### Method
->everyMonth()

### Parameters
- **months** (int) - Required - The number of months between runs.

### Example
```php
$schedule->command('foo')->everyMonth(4);
```
```

--------------------------------

### ->cron('* * * * *')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Sets a custom cron schedule for the task.

```APIDOC
## ->cron('* * * * *')

### Description
Runs the task on a custom cron schedule.

### Method
->cron()

### Parameters
- **schedule** (string) - Required - The cron expression defining the schedule.

### Example
```php
$schedule->command('foo')->cron('* * * * *');
```
```

--------------------------------

### Schedule a closure task

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/vision.md

Schedules an anonymous function to run on Mondays. The closure can contain any logic needed for the task.

```php
	$schedule->call(function() { 
		// do something.... 
	})->mondays();
```

--------------------------------

### Schedule an event task

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/vision.md

Schedules a pre-defined framework event to trigger on weekdays at 9:00 am. This allows for more dynamic actions from a single task.

```php
	$schedule->event('reminders')->weekdays()->at('9:00 am');
```

--------------------------------

### ->thursdays('3:15am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every Thursday at midnight or at a specified time.

```APIDOC
## ->thursdays('3:15am')

### Description
Runs every Thursday at midnight, unless a time is passed in.

### Method
->thursdays()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '3:15am').

### Example
```php
$schedule->command('foo')->thursdays('3:15am');
```
```

--------------------------------

### ->months([1,7])

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task only in the specified months.

```APIDOC
## ->months([1,7])

### Description
Runs only in the specified months (1-12).

### Method
->months()

### Parameters
- **months** (array) - Required - An array of month numbers (1-12) to run the task.

### Example
```php
$schedule->command('foo')->months([1,7]);
```
```

--------------------------------

### ->days([0,3])

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task only on the specified days of the week.

```APIDOC
## ->days([0,3])

### Description
Runs only on the specified days of the week (0=Sunday, 6=Saturday).

### Method
->days()

### Parameters
- **days** (array) - Required - An array of day numbers (0-6) to run the task.

### Example
```php
$schedule->command('foo')->days([0,3]);
```
```

--------------------------------

### Scheduling Queue Jobs with singleInstance() and TTL

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Limit the duration of a queue job lock by passing a TTL value to singleInstance().

```php
$schedule->queue('queue-name', 'jobName', ['data' => 'array'])
    ->hourly()
    ->singleInstance(30 * MINUTE);
```

--------------------------------

### ->wednesdays('3:15am')

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task every Wednesday at midnight or at a specified time.

```APIDOC
## ->wednesdays('3:15am')

### Description
Runs every Wednesday at midnight, unless a time is passed in.

### Method
->wednesdays()

### Parameters
- **time** (string) - Optional - The time of day to run (e.g., '3:15am').

### Example
```php
$schedule->command('foo')->wednesdays('3:15am');
```
```

--------------------------------

### ->betweenMinutes(0,30)

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Restricts the task to run only between the specified minutes of an hour.

```APIDOC
## ->betweenMinutes(0,30)

### Description
Runs only between the given minutes (0-59) of each hour.

### Method
->betweenMinutes()

### Parameters
- **start** (int) - Required - The starting minute (0-59).
- **end** (int) - Required - The ending minute (0-59).

### Example
```php
$schedule->command('foo')->betweenMinutes(0,30);
```
```

--------------------------------

### ->daysOfMonth([1,15])

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Runs the task only on the specified days of the month.

```APIDOC
## ->daysOfMonth([1,15])

### Description
Runs only on the specified days of the month.

### Method
->daysOfMonth()

### Parameters
- **days** (array) - Required - An array of day numbers (1-31) to run the task.

### Example
```php
$schedule->command('foo')->daysOfMonth([1,15]);
```
```

--------------------------------

### Scheduling Events

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Trigger a defined Event using the event() method.

```php
$schedule->event('Foo')->hourly();
```

--------------------------------

### Set lock duration with singleInstance(30 * MINUTE)

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Sets a maximum lock duration (TTL) for the singleInstance() lock. If the task crashes unexpectedly, the lock expires after the TTL, preventing stuck locks. If the task completes before the TTL, the lock is released immediately.

```php
// Lock for a maximum of 30 minutes (1800 seconds)
$schedule->command('demo:heavy-task')
    ->everyFifteenMinutes()
    ->singleInstance(30 * MINUTE);
```

--------------------------------

### ->singleInstance() / ->singleInstance(HOUR)

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Prevents concurrent executions of the same task.

```APIDOC
## ->singleInstance() / ->singleInstance(HOUR)

### Description
Prevents concurrent executions of the same task. Optionally specify a number of hours to keep the lock.

### Method
->singleInstance()

### Parameters
- **hours** (int) - Optional - The number of hours to keep the lock.

### Example
```php
$schedule->command('foo')->singleInstance();
```
```

--------------------------------

### ->betweenMonths(4,7)

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Restricts the task to run only between the specified months.

```APIDOC
## ->betweenMonths(4,7)

### Description
Runs only between the given months (1-12).

### Method
->betweenMonths()

### Parameters
- **start** (int) - Required - The starting month (1-12).
- **end** (int) - Required - The ending month (1-12).

### Example
```php
$schedule->command('foo')->betweenMonths(4,7);
```
```

--------------------------------

### Assigning a name to a scheduled task

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Use the named() method to assign a unique identifier to a command, allowing it to be referenced later via the CLI.

```php
$schedule->command('foo')->nightly()->named('foo-task');
```

--------------------------------

### Disable task runner with tasks:disable

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/cli-commands.md

Manually disables the task runner until re-enabled. Stores the setting in the default database via the Settings library.

```console
php spark tasks:disable
```

--------------------------------

### ->betweenHours(6,12)

Source: https://github.com/codeigniter4/tasks/blob/develop/docs/basic-usage.md

Restricts the task to run only between the specified hours.

```APIDOC
## ->betweenHours(6,12)

### Description
Runs the task only between the given hours (inclusive).

### Method
->betweenHours()

### Parameters
- **start** (int) - Required - The starting hour (0-23).
- **end** (int) - Required - The ending hour (0-23).

### Example
```php
$schedule->command('foo')->betweenHours(6,12);
```
```
Tokens:
Raw