README

Минимальный серверный адаптер Inertia.js для PhpSoftBox.

Возможности

JSON‑ответы по X-Inertia.
HTML‑ответы с root‑view для первого захода.
Middleware для проверки версии ассетов и заголовка Vary: X-Inertia.
Partial reload по X-Inertia-Partial-* headers.

Пример

$response = $inertia->render('Home', [
    'title' => 'Inertia App',
]);

Partial reload

Компонент поддерживает partial reload на уровне top-level props. Фильтрация включается только для Inertia request, если X-Inertia-Partial-Component совпадает с компонентом, который рендерится.

Поддерживаемые headers:

X-Inertia-Partial-Data — comma-separated список props, которые нужно вернуть;
X-Inertia-Partial-Except — comma-separated список props, которые нужно исключить.

Если клиент отправил оба headers, X-Inertia-Partial-Except имеет приоритет. Для X-Inertia-Partial-Data page props фильтруются до вычисления closures, поэтому незапрошенные тяжелые props не будут вычисляться.

Метаданные страницы

Можно задавать title, description, keywords через сервис PageMeta. Данные попадут в props.meta и в HTML‑теги на первом рендере.

use PhpSoftBox\Inertia\Page\PageMeta;

$meta->setTitle('Панель управления')
    ->setDescription('Админ‑панель проекта')
    ->setKeywords(['admin', 'dashboard']);

return $inertia->render('Dashboard');

Breadcrumbs

use PhpSoftBox\Inertia\Page\Breadcrumbs;

$breadcrumbs
    ->add('Главная', '/')
    ->add('Пользователи', '/users')
    ->add('Профиль', null, true);

return $inertia->render('Users/Show');

use PhpSoftBox\Inertia\Page\Menu;
use PhpSoftBox\Inertia\Page\MenuItem;
use PhpSoftBox\Inertia\Page\MenuMatchMode;

$menu = new Menu();
$menu->add(
    (new MenuItem('Dashboard', '/', 'dashboard', 'dashboard'))
        ->withMatchMode(MenuMatchMode::EQUALS),
);

$menu->add(
    (new MenuItem('Промо', null, 'promo', 'promo'))
        ->setChildren([
            new MenuItem('Промокоды', '/promo/promocodes', 'promocode', 'promocode'),
        ]),
);

Tabs

use PhpSoftBox\Inertia\Page\Tabs;

$tabs
    ->setActiveKey('profile')
    ->add('Профиль', 'profile', '/profile')
    ->add('Пароль', 'password', '/profile/password');

return $inertia->render('Profile/Show');

SSR

SSR опционален и выключен по умолчанию. Для интеграции можно использовать встроенный HTTP renderer или свой рендерер, реализующий SsrRendererInterface.

use PhpSoftBox\Inertia\Ssr\HttpSsrRenderer;

$renderer = new HttpSsrRenderer(
    url: 'http://node:13714/render',
    timeout: 2.0,
);

HttpSsrRenderer отправляет InertiaPage JSON POST-запросом на SSR endpoint и ожидает ответ формата ['head' => string[], 'body' => string]. По умолчанию renderer работает в fail-open режиме: если SSR endpoint недоступен, он вернёт null, и Inertia отдаст обычный HTML shell.

Для строгого режима передайте failSilently: false.

В конфиге Inertia:

use PhpSoftBox\Inertia\Area\InertiaAreaConfig;

return [
    'ssr' => env('INERTIA_SSR', false),

    'areas' => [
        'default' => 'web',

        'web' => new InertiaAreaConfig(
            pathPrefixes: ['/'],
            ssr: true,
            shared: [
                'app' => [
                    'area' => 'web',
                ],
            ],
        ),

        'admin' => new InertiaAreaConfig(
            pathPrefixes: ['/admin'],
            ssr: false,
            shared: [
                'app' => [
                    'area' => 'admin',
                ],
            ],
        ),
    ],
];

Если SSR включён и доступен, view получает переменную $ssr: ['head' => string[], 'body' => string]. Дефолтный view в AppBackend уже умеет вставлять эти данные.

Areas

Areas позволяют централизованно разделять публичную часть, админку, кабинет или tenant‑области по host/path и задавать для них свои Inertia-настройки.

InertiaAreaConfig поддерживает:

hosts — список host или URL, например admin.example.local;
paths — точные пути;
pathPrefixes — префиксы путей, где более длинный prefix приоритетнее;
ssr — true, false или null, если нужно использовать базовую настройку;
shared — area-specific props.

Area-specific shared-data можно расширять отдельными провайдерами:

use PhpSoftBox\Inertia\Area\AreaSharedDataProviderInterface;

final class AdminSharedDataProvider implements AreaSharedDataProviderInterface
{
    public function area(): string
    {
        return 'admin';
    }

    public function share(ServerRequestInterface $request): array
    {
        return [
            'admin' => [
                'sidebar' => [],
            ],
        ];
    }
}

shared из InertiaAreaConfig и данные из AreaSharedDataProviderInterface объединяются рекурсивно. Provider применяется позже и поэтому может дополнить или переопределить значения из конфига.

'admin' => new InertiaAreaConfig(
    pathPrefixes: ['/admin'],
    ssr: false,
    shared: [
        'app' => [
            'area' => 'admin',
            'name' => 'Admin Panel',
        ],
    ],
),

final class AdminSharedDataProvider implements AreaSharedDataProviderInterface
{
    public function area(): string
    {
        return 'admin';
    }

    public function share(ServerRequestInterface $request): array
    {
        return [
            'app' => [
                'theme' => 'compact',
            ],
            'admin' => [
                'sidebar' => [],
            ],
        ];
    }
}

Итоговые props будут содержать:

[
    'app' => [
        'area' => 'admin',
        'name' => 'Admin Panel',
        'theme' => 'compact',
    ],
    'admin' => [
        'sidebar' => [],
    ],
]

Если provider вернёт уже существующий ключ, он заменит значение из конфига:

return [
    'app' => [
        'name' => 'Runtime Admin',
    ],
];

В этом случае итоговое app.name будет Runtime Admin.

phpsoftbox / inertia

Maintainers

Package info

Statistics

Security