Publish pages

use Fetchski\AttractCmsLaravel\Facades\Attract;

$job = Attract::pages()->publishPages(ids: ['clx8m2k4p0000a1b2c3d4e5f6']);

{
  "jobId": "clx8m2k4p0000a1b2c3d4e5f6"
}

In your app

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

Add the controller

app/Http/Controllers/PublishPagesController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class PublishPagesController
{
    public function __invoke(): JsonResponse
    {
        $job = Attract::pages()->publishPages(ids: ['clx8m2k4p0000a1b2c3d4e5f6']);

        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\PublishPagesController;
use Illuminate\Support\Facades\Route;

Route::post('/page/publish', PublishPagesController::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 /page/publish (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/PublishPages.php (an invokable Action that calls publishPages()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action pages.publishPages

Call it from the terminal

Terminal

php artisan attract:call pages.publishPages 'ids=["clx8m2k4p0000a1b2c3d4e5f6"]'

It calls publishPages() 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. Every id must name a document the caller may edit, or no job starts: 404 names the ids that matched nothing.

Required parameters

Named arguments, e.g. publishPages(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).

Optional parameters

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:pages:publish (or a master above it: content:pages: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/PublishPagesTest.php, then run your tests:

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

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

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

        Attract::assertCalled('pages.publishPages');
    }
}

Terminal

php artisan test

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

tests/Feature/PublishPagesAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class PublishPagesAnswerTest extends TestCase
{
    public function test_publish_pages_answers_your_values(): void
    {
        Attract::fake([
            'pages.publishPages' => JobStarted::factory()->make(['jobId' => 'Your value']),
        ]);

        $job = Attract::pages()->publishPages(ids: ['clx8m2k4p0000a1b2c3d4e5f6']);

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

List pages

Attract::pages()->listPages()

Create a page

Attract::pages()->createPage()

Archive pages

Attract::pages()->archivePages()

Copy pages to another locale

Attract::pages()->localizePages()

Restore pages

Attract::pages()->restorePages()

Get a page

Attract::pages()->getPage()

POST /@apostrophecms/page/publish

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 pages

Create a page

Archive pages

Copy pages to another locale

Restore pages

Get a page

POST /@apostrophecms/page/publish

In your app

Call it from the terminal

Behavior

Test it

Related

List pages

Create a page

Archive pages

Copy pages to another locale

Restore pages

Get a page

POST /@apostrophecms/page/publish