Get the image folder tree

use Fetchski\AttractCmsLaravel\Facades\Attract;

$folderTree = Attract::imageFolders()->getImageFolderTree();

{
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "folderPath": "Example folder path",
      "level": 1,
      "parentId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
      "referenceOnly": true,
      "reference": true,
      "count": 1,
      "children": []
    }
  ]
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$folderTree = Attract::imageFolders()->getImageFolderTree();

{
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "folderPath": "Example folder path",
      "level": 1,
      "parentId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
      "referenceOnly": true,
      "reference": true,
      "count": 1,
      "children": []
    }
  ]
}

In your app

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

Add the controller

app/Http/Controllers/GetImageFolderTreeController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class GetImageFolderTreeController
{
    public function __invoke(): FolderTree
    {
        return Attract::imageFolders()->getImageFolderTree();
    }
}

Add the route

routes/web.php

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

Route::get('/image-folder/tree', GetImageFolderTreeController::class);

Register it before Route::get('/image-folder/{id}', …): Laravel takes the first route that matches, and that one matches this URL too.

Call it

Terminal

curl http://localhost:8000/image-folder/tree

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

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

Terminal

php artisan make:attract-action imageFolders.getImageFolderTree

Call it from the terminal

Terminal

php artisan attract:call imageFolders.getImageFolderTree

It calls getImageFolderTree() on your default site and prints its answer as JSON. See Call any method from the terminal for every argument type. For someone who may edit the image library (and the management key); everyone else gets 404.

Parameters

None: call it with no arguments.

Returns

A FolderTree (Fetchski\AttractCmsLaravel\Data\FolderTree). The folder tree: the root folders by title, each with its subfolders. Read its properties ($folderTree->results): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (_id → id).

Collection<int, FolderTreeNode>

Always sent. A list of FolderTreeNode.

Show FolderTreeNode (Fetchski\AttractCmsLaravel\Data\FolderTreeNode)

A folder, with its subfolders. Every field is always sent.

string

Always sent. The folder’s aposDocId.

string

Always sent.

string

Always sent. Its path, e.g. events/summer.

int

Always sent. Its depth: 0 at the root.

?string

Always sent, can be null. Its parent folder’s _id; null at the root.

?string

Always sent, can be null. The photo album it belongs to, if it is an album’s folder.

?string

Always sent, can be null. The photo feed it belongs to, if it is a feed’s folder.

bool

Always sent. Flagged as a reference folder itself (its files are never offered for use).

bool

Always sent. Inside a reference tree (itself included).

int

Always sent. Files directly in it (not in its subfolders).

Collection<int, FolderTreeNode>

Always sent. A list of FolderTreeNode. Its fields are listed under the first FolderTreeNode above.

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 (only a 502, 503 or 504 is retried). 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 content:images:write (or a master above it: content:images:all, content:all, admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 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/GetImageFolderTreeTest.php, then run your tests:

tests/Feature/GetImageFolderTreeTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetImageFolderTreeTest extends TestCase
{
    public function test_get_image_folder_tree(): void
    {
        Attract::fake();

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

        Attract::assertCalled('imageFolders.getImageFolderTree');
    }
}

Terminal

php artisan test

List a folder’s photos

Attract::imageFolders()->listImageFolderPhotos()

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/tree

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$folderTree = Attract::imageFolders()->getImageFolderTree();

{
  "results": [
    {
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "title": "Example title",
      "folderPath": "Example folder path",
      "level": 1,
      "parentId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedAlbumId": "clx8m2k4p0000a1b2c3d4e5f6",
      "linkedFeedId": "clx8m2k4p0000a1b2c3d4e5f6",
      "referenceOnly": true,
      "reference": true,
      "count": 1,
      "children": []
    }
  ]
}

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 folder’s photos

List image folders

Create an image folder

Get an image folder

Replace an image folder

Delete an image folder

GET /image-folder/tree

In your app

Call it from the terminal

Behavior

Test it

Related

List a folder’s photos

List image folders

Create an image folder

Get an image folder

Replace an image folder

Delete an image folder

GET /image-folder/tree