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.

console ecotone:list
| Endpoint Names     |
| notificationSender |

After setting up Scheduled endpoint we can run the endpoint:

console ecotone:run notificationSender -vvv

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")] 
    public function callExchange() : array
        return ["currency" => "EUR", "ratio" => 1.23];

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.


Demo implementation

You may find demo implementation here.

Last updated