Get locale path and manage clipboard

use Fetchski\AttractCmsLaravel\Facades\Attract;

$switchLocale = Attract::internationalization()->switchLocale(locale: 'fr');

{
  "redirectTo": "/fr/page-slug"
}

{
  "redirectTo": "https://fr.example.com/french-example-page?aposCrossDomainSessionToken=generated_token"
}

In your app

A controller answers a route on your app: it calls switchLocale() and returns the answer.

Add the controller

app/Http/Controllers/SwitchLocaleController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\DifferentHostnameResponse;
use Fetchski\AttractCmsLaravel\Data\SameHostnameResponse;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class SwitchLocaleController
{
    public function __invoke(): SameHostnameResponse|DifferentHostnameResponse
    {
        return Attract::internationalization()->switchLocale(locale: 'fr');
    }
}

The other values are the example’s: take yours from the request, a form or your database.

Add the route

routes/web.php

use App\Http\Controllers\SwitchLocaleController;
use Illuminate\Support\Facades\Route;

Route::post('/i18n/locale', SwitchLocaleController::class)->middleware('auth');

It acts with your key’s access, so auth lets only your signed-in users reach it.

Call it

Your own page’s form or script sends POST /i18n/locale (a form adds @csrf, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.

To keep the call in an Action instead, this writes app/Actions/Attract/SwitchLocale.php (an invokable Action that calls switchLocale()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action internationalization.switchLocale

Call it from the terminal

Terminal

php artisan attract:call internationalization.switchLocale locale=fr

It calls switchLocale() on your default site and prints its answer as JSON. It writes, so it asks first: add --force to skip the question in a script. See Call any method from the terminal for every argument type. Used for cross-locale navigation.

Required parameters

Named arguments, e.g. switchLocale(locale: …); leave out the optional ones.

string

required

Required. Target locale code.

Optional parameters

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional document ID for the path.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional clipboard content for cross-domain situations.

Returns

A SameHostnameResponse|DifferentHostnameResponse (Fetchski\AttractCmsLaravel\Data\SwitchLocaleResponse). Locale path retrieved successfully. One of these: tell them apart by their fields.

Show SameHostnameResponse (Fetchski\AttractCmsLaravel\Data\SameHostnameResponse)

string

Always sent. Path to redirect to within same hostname. Matches ^/(?!/).*.

Show DifferentHostnameResponse (Fetchski\AttractCmsLaravel\Data\DifferentHostnameResponse)

string

Always sent. Full URL to redirect to with cross-domain session token. Format: an absolute URL. Matches ^[A-Za-z][A-Za-z0-9+.-]*://.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).

400

The site refused what was sent: errors() lists each field’s problem, siteMessage() the first.Retried first: No. Read: errors() (field → messages), siteMessage().

401

The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage(), errorName(), data().

403

The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage() names it.Retried first: No. Read: siteMessage(), errorName(), data().

5xx

The site failed (or something in front of it did). Its logs say why.Retried first: No: a write may have landed. Read: siteMessage(), errorName(), data().

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (neverConnected()); never after a timeout, when it may have landed. Read: reason(), neverConnected().

not sent

The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason() (what to change).

any other

Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason(), status().

setup

Attract::site('acme') named a slug that isn’t under sites in config/fetchski-attract.php.Retried first: No: nothing was sent. Read: getMessage(), $e->slug.

setup

The site’s config entry is wrong: no url, a malformed api_key, a key filed under another slug, or no default site.Retried first: No: nothing was sent. Read: getMessage() (what to fix).

Behavior

Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
Timeout: 15 s per attempt by default; raise timeout in config/fetchski-attract.php for longer.

Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as tests/Feature/SwitchLocaleTest.php, then run your tests:

tests/Feature/SwitchLocaleTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use App\Models\User;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

final class SwitchLocaleTest extends TestCase
{
    use RefreshDatabase;

    public function test_switch_locale(): void
    {
        Attract::fake();

        $this->actingAs(User::factory()->create())
            ->postJson('/i18n/locale')
            ->assertOk();

        Attract::assertCalled('internationalization.switchLocale');
    }
}

Terminal

php artisan test

List the site’s languages

Attract::internationalization()->getLocales()

Check document existence in locale

Attract::internationalization()->existInLocale()

POST /@apostrophecms/i18n/locale

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

Get locale path and manage clipboard

In your app

Call it from the terminal

Behavior

Test it

List the site’s languages

Check document existence in locale

POST /@apostrophecms/i18n/locale

In your app

Call it from the terminal

Behavior

Test it

Related

List the site’s languages

Check document existence in locale

POST /@apostrophecms/i18n/locale