Bootstrap request

Explanation

This GET request is used to obtain all backend data, metadata, and all shared informations from backend.

Shared PHP implementation

In PHP helpers 2.0, AdminHelpers\Utilities\BootstrapRequest extends Admin\Core\Utilities\BootstrapRequest from crudadmin/framework 6. The framework owns section composition (get, guest, authenticated, all, only) and caching. Helpers adds the project client, token, auth() response and onClient() hook. Existing AppRequest subclasses keep their imports. The administration uses its own Admin\Bootstrap\AdminBootstrapRequest, built on the same framework base with admin session and verification rules. Its endpoint is /admin/api/bootstrap; it does not reuse your application’s /api/bootstrap. Override canLoadSection($method) to restrict selectable methods when exposing only to HTTP input. Authentication checks must cover explicitly selected sections as well as the default response. Configure section caches with ['minutage' => 5] or a number of minutes. Array entries default to 60 minutes when minutage is omitted; duration is not supported. Cache keys contain the bootstrap class basename, locale and section name, plus an optional key callback result. User-dependent sections need an appropriate key or must remain uncached.

Configuration

routes/api.php

Route::any('bootstrap', [BootstrapController::class, 'index']);

app/Http/Controllers/BootstrapController.php

<?php

namespace App\Http\Controllers;

use AppRequest;

class BootstrapController extends Controller
{
    public function index()
    {
        $only = array_filter(explode(',', request('only')));

        return autoAjax()->store(
            AppRequest::only($only)
        );
    }
}

AppRequest class

This class is used to render all data returned from bootstrap request during GET response. You can add as many methods as you need, and split them between guests and authorized users.

app/Utilities/Bootstrap/AppRequest.php

<?php

namespace App\Utilities\Bootstrap;

use Localization;
use AdminHelpers\Utilities\BootstrapRequest;

class AppRequest extends BootstrapRequest
{
    public function get()
    {
        return $this->only([ 'locale', 'app', 'auth', 'setting' ]);
    }

    public function authenticated()
    {
        return $this->only([ 'auth' ]);
    }

    public function auth()
    {
        $data = $this->isAuthorized() ? parent::auth() : [];

        return $data + [
            //...
        ];
    }

    public function app()
    {
        return [
            'booted' => true,
            'backendEnv' => [
                //...
            ],
        ];
    }

    public function locale()
    {
        return [
            'locale' => $locale = app()->getLocale(),
            'translations' => Localization::getJson($locale),
        ];
    }

    public function setting()
    {
        return [
            //..
        ];
    }
}

We are using singular forms of method naming. Same in Pinia stores.

Facade

You can create shortcut to you AppRequest accordingly to your needs. Helpful if you have multiple bootstrap classes in your project.

config/app.php

'aliases' => Facade::defaultAliases()->merge([
    'AppRequest' => Facades\App\Utilities\Bootstrap\AppRequest::class,
    // 'Example' => App\Facades\Example::class,
])->toArray(),

Response and structure

According your method naming, data will be automatically binded into Vuex/Pinia stores.

{
    "error": false,
    "store": {
        "locale": {
            "locale": "sk",
            "translations": "[]"
        },
        "app": {
            "booted": true,
            "backendEnv": []
        },
        "auth": {
            "driver": "users",
            "user": {
                "id": 15,
                "number": "2002025000015",
                "username": "Marek Gogol",
                "email": "info2@marekgogol.sk",
                "verified": [
                    "email"
                ],
                "points": 0,
                "earnings": 0,
                "created_at": "2025-08-28T07:44:24.000000Z",
                "updated_at": "2025-08-28T08:23:18.000000Z",
                "deleted_at": null
            }
        },
        "setting": []
    }
}

For wrapping data in store object, you need to set store parameter to true in autoajax config.

config/autoajax.php

return [
    'store' => true,
];

Getting started

Requests

Explanation

Shared PHP implementation

Configuration

AppRequest class

Facade

Response and structure

​Explanation

​Shared PHP implementation

​Configuration

​AppRequest class

​Facade

​Response and structure

Explanation

Shared PHP implementation

Configuration

AppRequest class

Facade

Response and structure