atk4/ui

<?php

declare(strict_types=1);

namespace Atk4\Ui\Js;

use Atk4\Core\WarnDynamicPropertyTrait;
use Atk4\Ui\View;

/**
 * Generates action, that will be able to loop-back to the callback method.
 */
class JsReload implements JsExpressionable
{
    use WarnDynamicPropertyTrait;

    /** Specifies which view to reload. Use constructor to set. */
    public View $view;

    /** @var JsExpressionable|null A JS function to execute after reload is complete and onSuccess is execute. */
    public $afterSuccess;

    /** @var array<string, string|int|JsExpressionable> Added at the end of your URL. */
    public array $args = [];

    /**
     * Fomantic-UI api settings.
     * ex: ['loadingDuration' => 1000].
     *
     * @var array<string, mixed>
     */
    public array $apiConfig = [];

    /** @var bool */
    public $includeStorage = false;

    /**
     * @param array<string, string|int|JsExpressionable> $args
     * @param array<string, mixed>                       $apiConfig
     */
    public function __construct(View $view, array $args = [], ?JsExpressionable $afterSuccess = null, array $apiConfig = [], bool $includeStorage = false)
    {
        $this->view = $view;
        $this->args = $args;
        $this->afterSuccess = $afterSuccess;
        $this->apiConfig = $apiConfig;
        $this->includeStorage = $includeStorage;
    }

    #[\Override]
    public function jsRender(): string
    {
        $final = (new Jquery($this->view))
            ->atkReloadView(
                [
                    'url' => $this->view->jsUrl(['__atk_reload' => $this->view->name]),
                    'urlOptions' => $this->args !== [] ? $this->args : null,
                    'afterSuccess' => $this->afterSuccess ? $this->afterSuccess->jsRender() : null,
                    'apiConfig' => $this->apiConfig !== [] ? $this->apiConfig : null,
                    'storeName' => $this->includeStorage ? $this->view->name : null,
                ]
            );

        return $final->jsRender();
    }
}