Action.php
11 months ago
Filter.php
2 years ago
Payload.php
3 years ago
Step.php
1 year ago
Subject.php
3 years ago
SubjectTransformer.php
2 years ago
Trigger.php
1 year ago
ValidationException.php
3 years ago
index.php
3 years ago
Trigger.php
44 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Automation\Engine\Integration; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Automation\Engine\Data\StepRunArgs; |
| 9 | |
| 10 | /** |
| 11 | * Trigger Interface |
| 12 | * |
| 13 | * Triggers are the entry points of automations that determine when an automation |
| 14 | * should start executing based on specific events or conditions. |
| 15 | * |
| 16 | */ |
| 17 | interface Trigger extends Step { |
| 18 | /** |
| 19 | * Register WordPress hooks to listen for trigger events. |
| 20 | * |
| 21 | * This method is called when automations using this trigger are activated. |
| 22 | * Implementations should use WordPress action/filter hooks to listen for |
| 23 | * specific events that should trigger the automation. |
| 24 | * |
| 25 | * @return void |
| 26 | */ |
| 27 | public function registerHooks(): void; |
| 28 | |
| 29 | /** |
| 30 | * Determine if the trigger should fire based on the current context. |
| 31 | * |
| 32 | * This method is called when a trigger event occurs to determine if the |
| 33 | * automation should actually start. It receives the step run arguments |
| 34 | * containing automation data, subjects, and other context information. |
| 35 | * |
| 36 | * The method should return true if the automation should proceed, false otherwise. |
| 37 | * This allows for fine-grained control over when automations execute. |
| 38 | * |
| 39 | * @param StepRunArgs $args The step run arguments containing automation context |
| 40 | * @return bool True if the automation should proceed, false otherwise |
| 41 | */ |
| 42 | public function isTriggeredBy(StepRunArgs $args): bool; |
| 43 | } |
| 44 |