atk4/ui

<?php

declare(strict_types=1);

namespace Atk4\Ui\UserAction;

use Atk4\Core\HookTrait;
use Atk4\Data\Model;
use Atk4\Ui\Js\Jquery;
use Atk4\Ui\Js\JsBlock;
use Atk4\Ui\Js\JsExpressionable;
use Atk4\Ui\Js\JsToast;
use Atk4\Ui\JsCallback;
use Atk4\Ui\View;

/**
 * Javascript Action executor.
 *
 * Will execute a model action using a JS Event.
 *
 * Usage:
 * When use with View::on method, then JsCallbackExecutor executor is automatically create.
 *  $button->on('click', $model->getUserAction('delete'), [4, 'confirm' => 'This will delete record with ID 4. Are you sure?']);
 *
 * Manual setup.
 * $action = $model->getUserAction('delete')
 * $ex = JsCallbackExecutor::addTo($app)->setAction($action, [4])
 * $button->on('click', $ex, ['confirm' => 'This will delete record with id 4. Are you sure?']);
 */
class JsCallbackExecutor extends JsCallback implements ExecutorInterface
{
    use HookTrait;

    /** @var Model\UserAction The model user action */
    public $action;

    /** @var JsExpressionable|\Closure<T of Model>($this, T, mixed, mixed): ?JsBlock JS expression to return if action was successful, e.g "new JsToast('Thank you')" */
    public $jsSuccess;

    #[\Override]
    public function getAction(): Model\UserAction
    {
        return $this->action;
    }

    #[\Override]
    public function setAction(Model\UserAction $action)
    {
        $this->action = $action;

        return $this;
    }

    /**
     * @template T
     *
     * @param \Closure(): T         $fx
     * @param array<string, string> $urlArgs
     *
     * @return T
     */
    protected function invokeFxWithUrlArgs(\Closure $fx, array $urlArgs = [])
    {
        $argsOrig = $this->args;
        $this->args = array_merge($this->args, $urlArgs);
        try {
            return $fx();
        } finally {
            $this->args = $argsOrig;
        }
    }

    /**
     * @param array<string, string> $urlArgs
     */
    #[\Override]
    public function jsExecute(array $urlArgs = []): JsBlock
    {
        return $this->invokeFxWithUrlArgs(function () { // backup/restore $this->args and merge them with $urlArgs
            return parent::jsExecute();
        }, $urlArgs);
    }

    #[\Override]
    public function executeModelAction(): void
    {
        $this->invokeFxWithUrlArgs(function () { // backup/restore $this->args mutated in https://github.com/atk4/ui/blob/8926412a31/src/JsCallback.php#L71
            $this->set(function (Jquery $j, ...$values) {
                $id = $this->getApp()->uiPersistence->typecastAttributeLoadField(
                    $this->action->getModel()->getIdField(),
                    $this->getApp()->tryGetRequestPostParam($this->name)
                );
                if ($id && $this->action->appliesTo === Model\UserAction::APPLIES_TO_SINGLE_RECORD) {
                    if ($this->action->isOwnerEntity() && $this->action->getEntity()->getId()) {
                        $this->action->getEntity()->setId($id); // assert ID is the same
                    } else {
                        $this->action = $this->action->getActionForEntity($this->action->getModel()->load($id));
                    }
                } elseif (!$this->action->isOwnerEntity()
                    && in_array($this->action->appliesTo, [Model\UserAction::APPLIES_TO_NO_RECORDS, Model\UserAction::APPLIES_TO_SINGLE_RECORD], true)
                ) {
                    $this->action = $this->action->getActionForEntity($this->action->getModel()->createEntity());
                }

                $return = $this->action->execute(...$values);

                $success = $this->jsSuccess instanceof \Closure
                    ? ($this->jsSuccess)($this, $this->action->getModel(), $id, $return)
                    : $this->jsSuccess;

                $js = JsBlock::fromHookResult($this->hook(BasicExecutor::HOOK_AFTER_EXECUTE, [$return, $id]) // @phpstan-ignore ternary.shortNotAllowed
                    ?: ($success ?? new JsToast('Success' . (is_string($return) ? (': ' . $return) : ''))));

                return $js;
            }, array_map(static fn () => true, $this->action->args)); // @phpstan-ignore argument.type
        });
    }
}