> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Copy forms to another locale

> Copies each listed document into other locales, as a background job.

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$job = Attract::forms()->localizeForms(ids: ['clx8m2k4p0000a1b2c3d4e5f6'], toLocales: ['en']);
```

```json 200 wrap theme={"dark"}
{
  "jobId": "clx8m2k4p0000a1b2c3d4e5f6"
}
```

## In your app

A controller answers a route on your app: it calls `localizeForms()` and returns the job’s id.

**1. Add the controller**

```php app/Http/Controllers/LocalizeFormsController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Http\JsonResponse;

final class LocalizeFormsController
{
    public function __invoke(): JsonResponse
    {
        $job = Attract::forms()->localizeForms(ids: ['clx8m2k4p0000a1b2c3d4e5f6'], toLocales: ['en']);

        return response()->json(['jobId' => $job->jobId]);
    }
}
```

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

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\LocalizeFormsController;
use Illuminate\Support\Facades\Route;

Route::post('/form/localize', LocalizeFormsController::class)->middleware('auth');
```

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

**3. Call it**

Your own page’s form or script sends `POST /form/localize` (a form adds `@csrf`, as every web route checks it), and gets back the job it started (`jobId`). Test it, below, calls it.

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/LocalizeForms.php` (an invokable Action that calls `localizeForms()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action forms.localizeForms
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call forms.localizeForms 'ids=["clx8m2k4p0000a1b2c3d4e5f6"]' 'toLocales=["en"]'
```

It calls `localizeForms()` on your default site and prints the job it started (`jobId`). It writes, so it asks first: add `--force` to skip the question in a script. See [Call any method from the terminal](https://docs.fetchski-attract.com/call-command.md) for every argument type.

Answers at once with the job’s id.

> [accordion] Required parameters
>
> Named arguments, e.g. `localizeForms(ids: …)`; leave out the optional ones.
>
> **ids** `array\<int, string\>|Collection\<int, string\>` *required*
>
> **Required.** The documents’ `_id`s: a full id names its own locale and mode (a draft’s `…:en:draft`, a published `…:en:published`; no `aposMode` needed), a bare `aposDocId` takes the request’s (`aposLocale`, `aposMode`).
>
> **toLocales** `array\<int, string\>|Collection\<int, string\>` *required*
>
> **Required.** The locales to copy them into (unknown locale names are skipped).

> [accordion] Optional parameters
>
> **update** `?bool`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Overwrite a copy that already exists in a target locale (default false: an existing copy is left as it is).
>
> **relatedTypes** `array\<int, string\>|Collection\<int, string\>|null`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Related document types to copy along (default none).
>
> **relatedOnly** `?bool`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Copy only the related documents, not the listed ones (default false).
>
> **messages** `BatchRequestMessages|array\<string, mixed\>|null`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The notification texts the CMS shows signed-in users while the job runs (`{{ type }}` and `{{ count }}` are filled in). Optional.
>
> **BatchRequestMessages (Fetchski\AttractCmsLaravel\Data\BatchRequestMessages)**
>
> **progress** `?string`
>
> Shown while the job runs, e.g. `Archiving {{ count }} {{ type }}…`.
>
> **completed** `?string`
>
> Shown when it ends, e.g. `Archived {{ count }} {{ type }}.`
>
> **resultsEventName** `?string`
>
> An admin-UI event to emit with the job’s results when it ends (for a custom screen); leave it out otherwise.

> [accordion] Returns
>
> `PendingJob` (`Fetchski\AttractCmsLaravel\Support\PendingJob`): the job runs on the site, `jobId` names it. `wait()` needs the management client (the job route is management only): on this client it throws `SiteConfigurationError`. The job started.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/errors.md)).
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors()` lists each field’s problem, `siteMessage()` the first.
>
> **Retried first:** No. **Read:** `errors()` (field → messages), `siteMessage()`.
>
> **AuthenticationFailed** `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()`.
>
> **Forbidden** `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()`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No: a write may have landed. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteUnreachable** `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()`.
>
> **RequestNotSent** `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).
>
> **SiteRequestFailed** `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()`.
>
> **UnknownSite** `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`.
>
> **SiteConfigurationError** `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

* **Access:** an API key with `content:forms:write` (or a master above it: `content:forms:all`, `content:all`, `admin:all`). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
* **Rate limit:** the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **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/LocalizeFormsTest.php`, then run your tests:

```php tests/Feature/LocalizeFormsTest.php theme={"dark"}
<?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 LocalizeFormsTest extends TestCase
{
    use RefreshDatabase;

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

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

        Attract::assertCalled('forms.localizeForms');
    }
}
```

```bash Terminal theme={"dark"}
php artisan test
```

**Answer with your own values:** fake `forms.localizeForms` with `JobStarted::factory()->make([...])`, the fields you give over a valid example.

```php tests/Feature/LocalizeFormsAnswerTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class LocalizeFormsAnswerTest extends TestCase
{
    public function test_localize_forms_answers_your_values(): void
    {
        Attract::fake([
            'forms.localizeForms' => JobStarted::factory()->make(['jobId' => 'Your value']),
        ]);

        $job = Attract::forms()->localizeForms(ids: ['clx8m2k4p0000a1b2c3d4e5f6'], toLocales: ['en']);

        $this->assertSame('Your value', $job->jobId);
    }
}
```

## Related

> [card] [List a form’s locales](https://docs.fetchski-attract.com/laravel/reference/forms/get-form-locales.md)
>
> `Attract::forms()->getFormLocales()`

> [card] [List forms](https://docs.fetchski-attract.com/laravel/reference/forms/list-forms.md)
>
> `Attract::forms()->listForms()`

> [card] [Create a form](https://docs.fetchski-attract.com/laravel/reference/forms/create-form.md)
>
> `Attract::forms()->createForm()`

> [card] [Get a form](https://docs.fetchski-attract.com/laravel/reference/forms/get-form.md)
>
> `Attract::forms()->getForm()`

> [card] [Replace a form](https://docs.fetchski-attract.com/laravel/reference/forms/replace-form.md)
>
> `Attract::forms()->replaceForm()`

> [card] [Delete a form](https://docs.fetchski-attract.com/laravel/reference/forms/delete-form.md)
>
> `Attract::forms()->deleteForm()`

> [card] [POST /@apostrophecms/form/localize](https://docs.fetchski-attract.com/api-reference/forms/copy-forms-to-another-locale.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.