List the site’s languages

use Fetchski\AttractCmsLaravel\Facades\Attract;

$result = Attract::internationalization()->getLocales();

{
  "en": {
    "label": "English",
    "direction": "ltr"
  },
  "fr": {
    "label": "Français",
    "prefix": "/fr",
    "direction": "ltr"
  },
  "de": {
    "label": "Deutsch",
    "prefix": "/de",
    "private": true,
    "direction": "ltr"
  }
}

In your app

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

Add the controller

app/Http/Controllers/GetLocalesController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\LocalesResponseValue;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class GetLocalesController
{
    /** @return array<string, LocalesResponseValue> */
    public function __invoke(): array
    {
        return Attract::internationalization()->getLocales();
    }
}

Add the route

routes/web.php

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

Route::get('/i18n/locales', GetLocalesController::class);

Call it

Terminal

curl http://localhost:8000/i18n/locales

With php artisan serve running, it prints its answer as JSON.

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

Terminal

php artisan make:attract-action internationalization.getLocales

Call it from the terminal

Terminal

php artisan attract:call internationalization.getLocales

It calls getLocales() on your default site and prints its answer as JSON. See Call any method from the terminal for every argument type. A visitor gets the public ones; a signed-in person, or an API key with languages:read, also gets the ones not yet public (private: true), so their pages can be translated before they go live. Translate a document into one with its type’s localize route.

Parameters

None: call it with no arguments.

Returns

array<string, LocalesResponseValue>. The languages, keyed by code.

Show LocalesResponseValue (Fetchski\AttractCmsLaravel\Data\LocalesResponseValue)

?string

Sometimes sent: null when the site leaves it out. The language’s name, as its speakers write it.

?string

Sometimes sent: null when the site leaves it out. The start of every URL in this language (/fr, so /fr/about); absent for the main language, whose URLs have none.

?bool

Sometimes sent: null when the site leaves it out. True for a language not yet public: visitors don’t see it; only signed-in people and API keys with languages:read get it. Absent once it is public.

Enums\Direction|string|null

Sometimes sent: null when the site leaves it out. The text direction. One of ltr, rtl; a newer site may send others, so keep a fallback.

Errors

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

5xx

The site failed (or something in front of it did). Its logs say why.Retried first: A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. Read: siteMessage(), errorName(), data().

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. 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 read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
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/GetLocalesTest.php, then run your tests:

tests/Feature/GetLocalesTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class GetLocalesTest extends TestCase
{
    public function test_get_locales(): void
    {
        Attract::fake();

        $this->getJson('/i18n/locales')->assertOk();

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

Terminal

php artisan test

Get locale path and manage clipboard

Attract::internationalization()->switchLocale()

Check document existence in locale

Attract::internationalization()->existInLocale()

GET /@apostrophecms/i18n/locales

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

In your app

Call it from the terminal

Behavior

Test it

Get locale path and manage clipboard

Check document existence in locale

GET /@apostrophecms/i18n/locales

In your app

Call it from the terminal

Behavior

Test it

Related

Get locale path and manage clipboard

Check document existence in locale

GET /@apostrophecms/i18n/locales