List a folder’s photos

use Fetchski\AttractCmsLaravel\Facades\Attract;

$listImageFolderPhotos = Attract::imageFolders()->listImageFolderPhotos(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "folder": {
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "title": "Example title",
    "folderPath": "marketing/team"
  },
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "alt": "Example alt",
      "attachment": {
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "name": "Example name",
        "extension": "jpg",
        "width": 1,
        "height": 1,
        "_urls": {
          "key": "https://acme.example/example"
        }
      }
    }
  ]
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$listImageFolderPhotos = Attract::imageFolders()->listImageFolderPhotos(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "folder": {
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "title": "Example title",
    "folderPath": "marketing/team"
  },
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "alt": "Example alt",
      "attachment": {
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "name": "Example name",
        "extension": "jpg",
        "width": 1,
        "height": 1,
        "_urls": {
          "key": "https://acme.example/example"
        }
      }
    }
  ]
}

In your app

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

Add the controller

app/Http/Controllers/ListImageFolderPhotosController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ListImageFolderPhotosController
{
    public function __invoke(string $id): ListImageFolderPhotosResponse
    {
        return Attract::imageFolders()->listImageFolderPhotos(id: $id);
    }
}

Add the route

routes/web.php

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

Route::get('/image-folder/{id}/photos', ListImageFolderPhotosController::class);

Call it

Terminal

curl http://localhost:8000/image-folder/clx8m2k4p0000a1b2c3d4e5f6/photos

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

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

Terminal

php artisan make:attract-action imageFolders.listImageFolderPhotos

Call it from the terminal

Terminal

php artisan attract:call imageFolders.listImageFolderPhotos id=clx8m2k4p0000a1b2c3d4e5f6

It calls listImageFolderPhotos() on your default site and prints its answer as JSON. See Call any method from the terminal for every argument type. A reference folder (one whose images never feed a gallery) answers 404.

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.

Laravel

use Fetchski\AttractCmsLaravel\Facades\Attract;

$row = Attract::imageFolders()->listImageFoldersPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null

Terminal

php artisan attract:call imageFolders.listImageFoldersPick fields=title,slug

Pass $row['id'] as id. See Find an id.

Required parameters

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

string

required

Required. The folder’s document ID.

Optional parameters

?string

Optional. Leave it out and the site uses "1". Send 0 for this folder only; anything else includes its subfolders.

?int

Optional. Leave it out and the site uses 200. At most this many photos. 1 to 200.

Returns

A ListImageFolderPhotosResponse (Fetchski\AttractCmsLaravel\Data\ListImageFolderPhotosResponse). The folder and its photos. Read its properties ($listImageFolderPhotos->folder): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _urls → urls).

ListImageFolderPhotosResponseFolder

Always sent. A ListImageFolderPhotosResponseFolder.

Show ListImageFolderPhotosResponseFolder (Fetchski\AttractCmsLaravel\Data\ListImageFolderPhotosResponseFolder)

Required.

string

Always sent.

string

Always sent.

?string

Sometimes sent: null when the site leaves it out.

Collection<int, GalleryPhoto>

Always sent. A list of GalleryPhoto.

Show GalleryPhoto (Fetchski\AttractCmsLaravel\Data\GalleryPhoto)

string

Always sent. The image’s document ID.

GalleryPhotoFile

Always sent. A GalleryPhotoFile. The image file: its size, and a URL per rendered size.

Show GalleryPhotoFile (Fetchski\AttractCmsLaravel\Data\GalleryPhotoFile)

string

Always sent.

string

Always sent. The file name, without its extension.

string

Always sent.

array<string, string>

Always sent. Size name (max, full, two-thirds, one-half, one-third, one-sixth, original) → URL.

?int

Sometimes sent: null when the site leaves it out.

?int

Sometimes sent: null when the site leaves it out.

array<string, mixed>

Always there: [] when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too. An object in it that a PHP array would read as a list ({}, {"0": …}) is a stdClass, so it is sent back as an object.

?string

Sometimes sent: null when the site leaves it out.

?string

Sometimes sent: null when the site leaves it out. Alt text; empty when none is set.

array<string, mixed>

Errors

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

401

The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.Retried first: No. Read: siteMessage(), errorName(), data().

403

The API key lacks the scope this route needs (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.Retried first: No. Read: siteMessage(), errorName(), data().

404

Nothing matches the identifier, or the caller may not use this route at all (it is not advertised).Retried first: No. Read: siteMessage(), errorName(), data().

429

The key used up its per-minute limit. Still, after the client’s own waits and retries.Retried first: Yes: the client waits Retry-After (1 s when absent; over 60 s it gives up at once) and retries, up to retries times (2 by default). Read: retryAfter() (seconds, or null), siteMessage().

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

Access: an API key with images:read, or media:all, or admin:all, or any signed-in CMS user. The site’s own server may call it too. Other callers get 404.
Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
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/ListImageFolderPhotosTest.php, then run your tests:

tests/Feature/ListImageFolderPhotosTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListImageFolderPhotosTest extends TestCase
{
    public function test_list_image_folder_photos(): void
    {
        Attract::fake();

        $this->getJson('/image-folder/clx8m2k4p0000a1b2c3d4e5f6/photos')->assertOk();

        Attract::assertCalled('imageFolders.listImageFolderPhotos', fn (array $args): bool => $args['id'] === 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}

Terminal

php artisan test

Answer with your own values: fake imageFolders.listImageFolderPhotos with ListImageFolderPhotosResponse::factory()->make([...]), the fields you give over a valid example (nested ones too).

tests/Feature/ListImageFolderPhotosAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class ListImageFolderPhotosAnswerTest extends TestCase
{
    public function test_list_image_folder_photos_answers_your_values(): void
    {
        Attract::fake([
            'imageFolders.listImageFolderPhotos' => ListImageFolderPhotosResponse::factory()->make(['folder' => ['id' => 'Your value']]),
        ]);

        $listImageFolderPhotos = Attract::imageFolders()->listImageFolderPhotos(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $listImageFolderPhotos->folder->id);
    }
}

Get the image folder tree

Attract::imageFolders()->getImageFolderTree()

List image folders

Attract::imageFolders()->listImageFolders()

Create an image folder

Attract::imageFolders()->createImageFolder()

Get an image folder

Attract::imageFolders()->getImageFolder()

Replace an image folder

Attract::imageFolders()->replaceImageFolder()

Delete an image folder

Attract::imageFolders()->deleteImageFolder()

GET /image-folder/{_id}/photos

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$listImageFolderPhotos = Attract::imageFolders()->listImageFolderPhotos(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "folder": {
    "_id": "clx8m2k4p0000a1b2c3d4e5f6",
    "title": "Example title",
    "folderPath": "marketing/team"
  },
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "alt": "Example alt",
      "attachment": {
        "_id": "clx8m2k4p0000a1b2c3d4e5f6",
        "name": "Example name",
        "extension": "jpg",
        "width": 1,
        "height": 1,
        "_urls": {
          "key": "https://acme.example/example"
        }
      }
    }
  ]
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Find the id

Behavior

Test it

Get the image folder tree

List image folders

Create an image folder

Get an image folder

Replace an image folder

Delete an image folder

GET /image-folder/{_id}/photos

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

Get the image folder tree

List image folders

Create an image folder

Get an image folder

Replace an image folder

Delete an image folder

GET /image-folder/{_id}/photos