<?php

/**
 * Result of executing a single workflow step.
 *
 * @package AfroIT_Messaging_WorkflowAutomations
 */

namespace AfroIT\Messaging\WorkflowAutomations\ExecutionEngine;

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Class ExecutionStepResult
 */
final class ExecutionStepResult {

	public const STATE_CONTINUE = 'continue';

	/**
	 * @var string
	 */
	public string $state;

	/**
	 * @var string
	 */
	public string $message;

	/**
	 * @var int
	 */
	public int $step_index;

	/**
	 * @param string $state      continue or a terminal/waiting status.
	 * @param string $message    Human-readable message.
	 * @param int    $step_index Step index.
	 */
	public function __construct( string $state, string $message, int $step_index ) {
		$this->state      = $state;
		$this->message    = $message;
		$this->step_index = $step_index;
	}

	/**
	 * @return bool
	 */
	public function should_continue(): bool {
		return self::STATE_CONTINUE === $this->state;
	}
}