Scheduling

Scheduling PHP

Ecotone comes with support for running period tasks or cron jobs.

Scheduled Method

class NotificationService
{
    #[Scheduled(endpointId: "notificationSender")]
    #[Poller(fixedRateInMilliseconds: 1000)]
    public function sendNotifications(): void
    {
        echo "Sending notifications...\n";
    }
}

endpointId - it's name which identifies process to run poller - Configuration how to execute this method read more in next section. Above configuration tells Ecotone to execute this method every second.

Symfony

console ecotone:list
+--------------------+
| Endpoint Names     |
+--------------------+
| notificationSender |
+--------------------+

Laravel

artisan ecotone:list
+--------------------+
| Endpoint Names     |
+--------------------+
| notificationSender |
+--------------------+

Lite

$consumers = $messagingSystem->list()

After setting up Scheduled endpoint we can run the endpoint:

Symfony

console ecotone:run notificationSender -vvv

Laravel

artisan ecotone:run notificationSender -vvv

Lite

$messagingSystem->run("notificationSender");

Scheduled Handler

You can run Scheduled for given Handler. Right now method return Message which is send to given routing.

class CurrencyExchanger
{
    #[Scheduled(requestChannelName: "exchange", endpointId: "currencyExchanger")] 
    #[Poller(fixedRateInMilliseconds=1000)]
    public function callExchange() : array
    {
        return ["currency" => "EUR", "ratio" => 1.23];
    }
}

#[CommandHandler("exchange")] 
public function exchange(ExchangeCommand $command) : void;

requestChannelName - The channel name to which Message should be send.

When the Message will arrive on the Command Handler it will be automatically converted to ExchangeCommand. If you want to understand how the conversion works, you may read about it in Conversion section.

Expression Language

We can also set up cron and fixed rate using expression language. This gives us ability to set it up differently based on the environment we are currently in.

class CurrencyExchanger
{
    #[Scheduled(requestChannelName: "exchange", endpointId: "currencyExchanger")] 
    #[Poller(fixedRateExpression="reference('timerService').getFixedRate()")]
    public function callExchange() : array
    {
        return ["currency" => "EUR", "ratio" => 1.23];
    }
}

Timing will be evaluated once, and then preserved as timing configuration. The evaluation will happen when ecotone:run will be executed.

Materials

Demo implementation

You may find demo implementation here.

Links

• Scheduling Execution in PHP