MenuItem.php

<?php

declare(strict_types=1);

/*
 * This file is part of the Alight package.
 *
 * (c) June So <june@alight.cc>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Alight\Admin;

use Alight\Admin;

class MenuItem
{
    /**
     * Define the configuration index
     *
     */
    public function __construct(private readonly int $index, private readonly int $subIndex, string $title)
    {
        if ($this->subIndex) {
            Menu::$config[$this->index]['sub'][$this->subIndex] = [
                'title' => $title,
                'locale' => str_starts_with($title, ':'),
            ];
        } else {
            Menu::$config[$this->index] = [
                'title' => $title,
            ];
        }

    }

    /**
     * Common setting config values
     */
    private function config(string $key, mixed $value): void
    {
        if ($this->subIndex) {
            Menu::$config[$this->index]['sub'][$this->subIndex][$key] = $value;
        } else {
            Menu::$config[$this->index][$key] = $value;
        }
    }

    /**
     * Set click action
     *
     * @param string $value Menu::ACTION_*
     */
    public function action(string $value): static
    {
        $this->config(__FUNCTION__, $value);
        return $this;
    }

    /**
     * Set icon
     *
     * @deprecated Only used by the built-in menu because additional icons must be imported by the React application.
     * @see https://ant.design/components/icon/
     */
    public function icon(string $value): static
    {
        $this->config(__FUNCTION__, $value);
        return $this;
    }

    /**
     * Custom unique key, default is url
     *
     *
     */
    public function key(string $value): static
    {
        $this->config(__FUNCTION__, $value);
        return $this;
    }

    /**
     * Which role has permission to view
     *
     * @param list<int> $roleValues
     */
    public function role(array $roleValues): static
    {
        $this->config(__FUNCTION__, $roleValues);
        return $this;
    }

    /**
     * Set url
     *
     */
    public function url(string $value): static
    {
        $this->config(__FUNCTION__, Admin::url($value));
        return $this;
    }
}