Copy testimonials to another locale

use Fetchski\AttractCmsLaravel\Facades\Attract;

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

{
  "jobId": "clx8m2k4p0000a1b2c3d4e5f6"
}

In your app

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

Add the controller

app/Http/Controllers/LocalizeTestimonialsController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class LocalizeTestimonialsController
{
    public function __invoke(): JsonResponse
    {
        $job = Attract::testimonials()->localizeTestimonials(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.

Add the route

routes/web.php

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

Route::post('/testimonial/localize', LocalizeTestimonialsController::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 /testimonial/localize (a form adds @csrf, as every web route checks it), and gets back the job it started (jobId). Test it, below, calls it.

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

Terminal

php artisan make:attract-action testimonials.localizeTestimonials

Call it from the terminal

Terminal

php artisan attract:call testimonials.localizeTestimonials \
  'ids=["clx8m2k4p0000a1b2c3d4e5f6"]' \
  'toLocales=["en"]'

It calls localizeTestimonials() 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 for every argument type. Answers at once with the job’s id.

Required parameters

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

array<int, string>|Collection<int, string>

required

Required. The documents’ _ids: 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).

array<int, string>|Collection<int, string>

required

Required. The locales to copy them into (unknown locale names are skipped).

Optional parameters

?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).

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).

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).

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.

Show BatchRequestMessages (Fetchski\AttractCmsLaravel\Data\BatchRequestMessages)

?string

Shown while the job runs, e.g. Archiving {{ count }} {{ type }}….

?string

Shown when it ends, e.g. Archived {{ count }} {{ type }}.

?string

An admin-UI event to emit with the job’s results when it ends (for a custom screen); leave it out otherwise.

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.

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().

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage(), errorName(), data().

500

The site failed. 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

Access: an API key with content:testimonials:write (or a master above it: content:testimonials: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/LocalizeTestimonialsTest.php, then run your tests:

tests/Feature/LocalizeTestimonialsTest.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 LocalizeTestimonialsTest extends TestCase
{
    use RefreshDatabase;

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

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

        Attract::assertCalled('testimonials.localizeTestimonials');
    }
}

Terminal

php artisan test

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

tests/Feature/LocalizeTestimonialsAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class LocalizeTestimonialsAnswerTest extends TestCase
{
    public function test_localize_testimonials_answers_your_values(): void
    {
        Attract::fake([
            'testimonials.localizeTestimonials' => JobStarted::factory()->make(['jobId' => 'Your value']),
        ]);

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

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

List a testimonial’s locales

Attract::testimonials()->getTestimonialLocales()

List testimonials

Attract::testimonials()->listTestimonials()

Create a testimonial

Attract::testimonials()->createTestimonial()

Get a testimonial

Attract::testimonials()->getTestimonial()

Replace a testimonial

Attract::testimonials()->replaceTestimonial()

Delete a testimonial

Attract::testimonials()->deleteTestimonial()

POST /testimonial/localize

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

List a testimonial’s locales

List testimonials

Create a testimonial

Get a testimonial

Replace a testimonial

Delete a testimonial

POST /testimonial/localize