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

# Crop images to a widget’s aspect ratio

> An editor helper: crops each image of an image relationship to widgetOptions.aspectRatio (unless it is already close), and answers the relationship with each image’s crop in its _fields.

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

$autocropImages = Attract::media()->autocropImages(relationship: [[]]);
```

```json 200 wrap theme={"dark"}
{
  "relationship": [
    {}
  ]
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class AutocropImagesController
{
    public function __invoke(): AutocropImagesResponse
    {
        return Attract::media()->autocropImages(relationship: [[]]);
    }
}
```

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

Route::post('/image/autocrop', AutocropImagesController::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 /image/autocrop` (a form adds `@csrf`, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.

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

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call media.autocropImages 'relationship=[{}]'
```

It calls `autocropImages()` on your default site and prints its answer as JSON. 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.

Without an aspect ratio it answers the relationship as sent.

> [accordion] Required parameters
>
> Named arguments, e.g. `autocropImages(relationship: …)`; leave out the optional ones.
>
> **relationship** `array\<int, array\<string, mixed\>\>|Collection\<int, array\<string, mixed\>\>` *required*
>
> **Required.** Image documents as an image relationship holds them, each with its crop and focal point in `_fields`.

> [accordion] Optional parameters
>
> **widgetOptions** `AutocropImagesRequestWidgetOptions|array\<string, mixed\>|null`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The image widget’s options.
>
> **AutocropImagesRequestWidgetOptions (Fetchski\AttractCmsLaravel\Data\AutocropImagesRequestWidgetOptions)**
>
> **aspectRatio** `Collection\<int, float\>|null`
>
> Width and height, e.g. `[16, 9]`. 2 to 2 items.
>
> **minSize** `Collection\<int, float\>|null`
>
> The smallest width and height a crop may have, in pixels. 2 to 2 items.

> [accordion] Returns
>
> An `AutocropImagesResponse` (`Fetchski\AttractCmsLaravel\Data\AutocropImagesResponse`). The relationship, cropped. Read its properties (`$autocropImages->relationship`): each says whether the site always sends it.
>
> **relationship** `Collection\<int, array\<string, mixed\>\>`
>
> **Always sent.** Image documents as an image relationship holds them, each with its crop and focal point in `_fields`.

> [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()`.
>
> **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: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 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/AutocropImagesTest.php`, then run your tests:

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

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

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

        Attract::assertCalled('media.autocropImages');
    }
}
```

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

## Related

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

> [card] [Create an image](https://docs.fetchski-attract.com/laravel/reference/media/create-image.md)
>
> `Attract::media()->createImage()`

> [card] [Archive images](https://docs.fetchski-attract.com/laravel/reference/media/archive-images.md)
>
> `Attract::media()->archiveImages()`

> [card] [Copy images to another locale](https://docs.fetchski-attract.com/laravel/reference/media/localize-images.md)
>
> `Attract::media()->localizeImages()`

> [card] [Publish images](https://docs.fetchski-attract.com/laravel/reference/media/publish-images.md)
>
> `Attract::media()->publishImages()`

> [card] [Restore images](https://docs.fetchski-attract.com/laravel/reference/media/restore-images.md)
>
> `Attract::media()->restoreImages()`

> [card] [POST /@apostrophecms/image/autocrop](https://docs.fetchski-attract.com/api-reference/media/crop-images-to-a-widget’s-aspect-ratio.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.