Shapecode Cron Bundle

https://github.com/shapecode/cron-bundle
Admin
Shapecode Cron Bundle is a Symfony bundle that provides scheduled execution and management of...
Tokens:1,158
Snippets:20
Trust Score:5.8
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/shapecode/cron-bundle/blob/master/docs/README.md

Add the bundle to your project dependencies using the Composer package manager.

```bash
composer require shapecode/cron-bundle
```

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

### Register and Run Cron Jobs via Console

Source: https://github.com/shapecode/cron-bundle/blob/master/docs/README.md

Commands to scan for new cron annotations and execute scheduled tasks manually.

```bash
$ php bin/console shapecode:cron:scan
$ php bin/console shapecode:cron:run
```

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

### Configure System Cron for Automatic Execution

Source: https://github.com/shapecode/cron-bundle/blob/master/docs/README.md

Add a system-level crontab entry to trigger the bundle's runner at a specific interval.

```bash
*/5 * * * * php /path/to/symfony/bin/console shapecode:cron:run
```

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

### Register Bundle in Symfony

Source: https://github.com/shapecode/cron-bundle/blob/master/docs/README.md

Manually register the bundle in your configuration file if Symfony Flex does not perform the registration automatically.

```php
<?php

// config/bundles.php
return [
    // ...
    Shapecode\Bundle\CronBundle\ShapecodeCronBundle::class,
    // ...
];
```

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

### Update Database Schema

Source: https://github.com/shapecode/cron-bundle/blob/master/docs/README.md

Apply the necessary database schema changes required by the bundle using the Doctrine console command.

```bash
php bin/console doctrine:schema:update --force
```

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

### Define a Cron Job with AsCronJob

Source: https://github.com/shapecode/cron-bundle/blob/master/docs/README.md

Use the AsCronJob attribute on a Symfony Command class to schedule it. Ensure the cron interval string is escaped if it contains a forward slash.

```php
<?php

declare(strict_types=1);

namespace App\DemoBundle\Command;

use Shapecode\Bundle\CronBundle\Attribute\AsCronJob;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

#[AsCronJob('*/5 * * * *')]
class DemoCommand extends Command
{
    
    public function configure() : void
    {
		// Must have a name configured
		// ...
    }
    
    public function execute(InputInterface $input, OutputInterface $output) : void
    {
		// Your code here
    }
}
```

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

### Configure Global CronJob Timeout

Source: https://github.com/shapecode/cron-bundle/blob/master/docs/README.md

Set the timeout in seconds for all cron jobs. A value of null uses the default Symfony Process component timeout.

```yaml
shapecode_cron:
    timeout: null # default. A number (of type float) can be specified
```

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

### Migrate CronJob Annotation to AsCronJob Attribute

Source: https://github.com/shapecode/cron-bundle/blob/master/UPGRADE-6.0.md

Replace the deprecated CronJob annotation with the AsCronJob attribute for defining cron jobs.

```php
<?php

// ....
use Shapecode\Bundle\CronBundle\Annotation\CronJob;
// ....

/**
 * @CronJob("*\/5 * * * *")
 */
class DemoCommand extends Command
{
    // ...
}
```

```php
<?php

// ....
use Shapecode\Bundle\CronBundle\Attribute\AsCronJob;
// ....

#[AsCronJob('* * * * *')]
class DemoCommand extends Command
{
    // ...
}
```

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

### Disable and Enable CronJobs via CLI

Source: https://github.com/shapecode/cron-bundle/blob/master/docs/README.md

Use these commands to toggle the active status of a specific CronJob by its name.

```bash
bin/console shapecode:cron:disable your:cron:job
```

```bash
bin/console shapecode:cron:enable your:cron:job
```
Tokens:
Raw