WorkflowInboundCallsInterceptor.php

<?php

/**
 * This file is part of Temporal package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Temporal\Interceptor;

use Temporal\Interceptor\Trait\WorkflowInboundCallsInterceptorTrait;
use Temporal\Interceptor\WorkflowInbound\InitInput;
use Temporal\Interceptor\WorkflowInbound\QueryInput;
use Temporal\Interceptor\WorkflowInbound\SignalInput;
use Temporal\Interceptor\WorkflowInbound\UpdateInput;
use Temporal\Interceptor\WorkflowInbound\WorkflowInput;
use Temporal\Internal\Interceptor\Interceptor;

/**
 * It's recommended to use `WorkflowInboundCallsInterceptorTrait` when implementing this interface because
 * the interface might be extended in the future. The trait will provide forward compatibility.
 *
 * ```php
 * class MyWorkflowInboundCallsInterceptor implements WorkflowInboundCallsInterceptor
 * {
 *     use WorkflowInboundCallsInterceptorTrait;
 *
 *     public function handleSignal(SignalInput $input, callable $next): void
 *     {
 *         Workflow::getLogger()->info('Workflow received signal: ' . $input->signalName);
 *
 *         $next($input);
 *     }
 * }
 * ```
 *
 * @see WorkflowInboundCallsInterceptorTrait
 */
interface WorkflowInboundCallsInterceptor extends Interceptor
{
    /**
     * Called when workflow instance is initialized, before {@see execute()}.
     * Allows interceptors to perform per-workflow-execution setup.
     *
     * @param callable(InitInput): void $next
     */
    public function init(InitInput $input, callable $next): void;

    /**
     * @param callable(WorkflowInput): void $next
     */
    public function execute(WorkflowInput $input, callable $next): void;

    /**
     * @param callable(SignalInput): void $next
     */
    public function handleSignal(SignalInput $input, callable $next): void;

    /**
     * @param callable(QueryInput): mixed $next
     */
    public function handleQuery(QueryInput $input, callable $next): mixed;

    /**
     * @param callable(UpdateInput): mixed $next
     */
    public function handleUpdate(UpdateInput $input, callable $next): mixed;

    /**
     * @param callable(UpdateInput): void $next
     */
    public function validateUpdate(UpdateInput $input, callable $next): void;
}