atk4/ui

<?php

declare(strict_types=1);

namespace Atk4\Ui;

use Atk4\Core\Factory;
use Atk4\Ui\Js\JsExpression;
use Atk4\Ui\Js\JsExpressionable;

class Wizard extends View
{
    public $defaultTemplate = 'wizard.html';
    public $ui = 'steps top attached';

    /** @var string Get argument for this wizard. */
    public $urlTrigger;

    /** @var array<int, WizardStep> List of steps. */
    public array $steps = [];

    /** @var int Current step. */
    public $currentStep;

    /** @var Button Button for going to previous step. */
    public $buttonPrevious;
    /** @var Button Button for going to next step. */
    public $buttonNext;
    /** @var Button */
    public $buttonFinish;

    /** @var HtmlTemplate */
    private $stepTemplate;

    /**
     * Icon that will be used on all steps by default.
     *  - 'empty', since no such icon exists, no visible icon will be used unless step is completed
     *  - 'square outline', use this (or any other) Fomantic-UI icon by default
     *  - false, disables icons altogether (or using checkboxes for completed steps).
     *
     * @var string|false
     */
    public $defaultIcon = 'empty'; // 'square outline'

    #[\Override]
    protected function init(): void
    {
        parent::init();

        if (!$this->urlTrigger) {
            $this->urlTrigger = $this->name;
        }

        $this->currentStep = (int) ($this->stickyGet($this->urlTrigger) ?? 0);

        $this->stepTemplate = $this->template->cloneRegion('Step');
        $this->template->del('Step');

        // add buttons
        if ($this->currentStep) {
            $this->buttonPrevious = Button::addTo($this, ['Back', 'class.basic' => true], ['Left']);
            $this->buttonPrevious->link($this->getUrl($this->currentStep - 1));
        }

        $this->buttonNext = Button::addTo($this, ['Next', 'class.primary' => true], ['Right']);
        $this->buttonFinish = Button::addTo($this, ['Finish', 'class.primary' => true], ['Right']);

        $this->buttonNext->link($this->getUrl($this->currentStep + 1));
    }

    protected function getUrl(int $step): string
    {
        return $this->url([$this->urlTrigger => $step]);
    }

    /**
     * Adds step to the wizard.
     *
     * @param string|array|WizardStep $name
     * @param \Closure($this): void   $fx
     *
     * @return WizardStep
     */
    public function addStep($name, \Closure $fx)
    {
        $step = Factory::factory([
            WizardStep::class,
            'wizard' => $this,
            'template' => clone $this->stepTemplate,
            'sequence' => count($this->steps),
        ], is_string($name) ? [$name] : $name);

        // add tabs menu item
        $this->steps[] = $this->add($step, 'Step');

        if ($step->sequence === $this->currentStep) {
            $step->addClass('active');
            $fx($this);
        } elseif ($step->sequence < $this->currentStep) {
            $step->addClass('completed');
        }

        if ($step->icon === null) {
            $step->icon = $this->defaultIcon;
        }

        return $step;
    }

    /**
     * Adds an extra screen to show user when he goes beyond last step.
     * There won't be "back" button on this step anymore.
     *
     * @param \Closure($this): void $fx
     */
    public function addFinish(\Closure $fx): void
    {
        if (count($this->steps) === $this->currentStep + 1) {
            $this->buttonFinish->link($this->getUrl(count($this->steps)));
        } elseif ($this->currentStep === count($this->steps)) {
            $this->buttonPrevious->destroy();
            $this->buttonNext->addClass('disabled')->set('Completed');
            $this->buttonFinish->destroy();

            $fx($this);
        } else {
            $this->buttonFinish->destroy();
        }
    }

    #[\Override]
    public function add($seed, $region = null): AbstractView
    {
        $result = parent::add($seed, $region);

        if ($result instanceof Form) {
            // mingle with the button icon
            if ($result->buttonSave !== null) {
                $result->buttonSave->destroy();
                $result->buttonSave = null;
            }

            $this->buttonNext->on('click', $result->js()->submit());
            $this->buttonFinish->on('click', $result->js()->submit());
        }

        return $result;
    }

    /**
     * Get URL to next step. Will respect stickyGet.
     */
    public function urlNext(): string
    {
        return $this->getUrl($this->currentStep + 1);
    }

    /**
     * Generate JS that will navigate to next step URL.
     */
    public function jsNext(): JsExpressionable
    {
        return new JsExpression('window.location = []', [$this->urlNext()]);
    }

    #[\Override]
    protected function recursiveRender(): void
    {
        if ($this->steps === []) {
            $this->addStep(['No Steps Defined', 'icon' => 'configure', 'description' => 'use $wizard->addStep() now'], static function (self $p) {
                Message::addTo($p, ['Step content will appear here', 'type' => 'error', 'text' => 'Specify callback to addStep() which would populate this area.']);
            });
        }

        if (count($this->steps) === $this->currentStep + 1) {
            $this->buttonNext->destroy();
        }

        parent::recursiveRender();
    }

    #[\Override]
    protected function renderView(): void
    {
        // set proper width to the wizard
        $c = count($this->steps);
        $enumeration = ['one', 'one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten'];
        $this->ui = $enumeration[$c] . ' ' . $this->ui;

        if ($c > 6) {
            $this->addClass('mini');
        } elseif ($c > 5) {
            $this->addClass('tiny');
        } elseif ($c > 4) {
            $this->addClass('small');
        }

        parent::renderView();
    }
}