> ## 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 image attachment

> Create a cropped version of an existing image attachment.

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

$result = Attract::attachments()->cropAttachment(id: 'ckj0akbxa003vp39kfbxgb8zg', crop: ['top' => 10, 'left' => 15, 'width' => 300, 'height' => 200]);
```

```json 200 wrap theme={"dark"}
true
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class CropAttachmentController
{
    public function __invoke(): JsonResponse
    {
        return response()->json(Attract::attachments()->cropAttachment(id: 'ckj0akbxa003vp39kfbxgb8zg', crop: ['top' => 10, 'left' => 15, 'width' => 300, 'height' => 200]));
    }
}
```

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

Route::post('/attachment/crop', CropAttachmentController::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 /attachment/crop` (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/CropAttachment.php` (an invokable Action that calls `cropAttachment()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action attachments.cropAttachment
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call attachments.cropAttachment \
  id=ckj0akbxa003vp39kfbxgb8zg \
  'crop={"top":10,"left":15,"width":300,"height":200}'
```

It calls `cropAttachment()` 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.

The crop object
is appended to the crops array property of the attachment document.
The newly uploaded image file will be stored with a filename using the
crop properties: \{\_id}-\{name}.\{top}.\{left}.\{width}.\{height}.\{extension}

> [accordion] Required parameters
>
> Named arguments, e.g. `cropAttachment(id: …)`; leave out the optional ones.
>
> **id** `string` *required*
>
> **Required.** The \_id property of an existing image attachment document.
>
> **crop** `CropAttachmentRequestCrop|array\<string, mixed\>` *required*
>
> **Required.** Crop coordinates and dimensions.
>
> **CropAttachmentRequestCrop (Fetchski\AttractCmsLaravel\Data\CropAttachmentRequestCrop)**
>
> **top** `int` *required*
>
> **Required.** Top coordinate of the crop area (pixels) At least 0.
>
> **left** `int` *required*
>
> **Required.** Left coordinate of the crop area (pixels) At least 0.
>
> **width** `int` *required*
>
> **Required.** Width of the crop area (pixels) At least 1.
>
> **height** `int` *required*
>
> **Required.** Height of the crop area (pixels) At least 1.

> [accordion] Optional parameters
>
> **aposMode** `Enums\\AposMode|string|null`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).

> [accordion] Returns
>
> A `bool`. Image cropped successfully.

> [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()`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **ValidationFailed** `422`
>
> Unprocessable entity - crop coordinates exceed image bounds.
>
> **Retried first:** No. **Read:** `errors()` (field → messages), `siteMessage()`.
>
> **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 any one of `content:images:write`, `content:files:write` or `content:videos:write` (or a master above one). 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/CropAttachmentTest.php`, then run your tests:

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

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

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

        Attract::assertCalled('attachments.cropAttachment');
    }
}
```

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

## Related

> [card] [Upload media file](https://docs.fetchski-attract.com/laravel/reference/attachments/upload-attachment.md)
>
> `Attract::attachments()->uploadAttachment()`

> [card] [POST /@apostrophecms/attachment/crop](https://docs.fetchski-attract.com/api-reference/attachments/crop-image-attachment.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.