[Suggestion] Use Backpack operation instead of telling users to create a controller

I think we can make the package easier to use by taking advantage of custom Backpack Operations.

Basically, instead of having them create a new controller and 4 routes for each entity they want to have media, we could create an operation, say InteractWithMediaOperation, which they use on their ProductCrudController, just like they do for the ListOperation, CreateOperation, ReorderOperation, etc.

That operation could host both the routes and actions for the field. So something like this:

<?php

namespace EduardoArandaH\MediaLibraryDropzone;

use Illuminate\Support\Facades\Route;

trait InteractWithMediaOperation
{
    /**
     * Define which routes are needed for this operation.
     *
     * @param string $segment    Name of the current entity (singular). Used as first URL segment.
     * @param string $routeName  Prefix of the route name.
     * @param string $controller Name of the current CrudController.
     */
    protected function setupInteractWithMediaRoutes($segment, $routeName, $controller)
    {
        Route::get($segment.'/{id}/media', [
            'as'        => $routeName.'.listMedia',
            'uses'      => $controller.'@listMedia',
            'operation' => 'interactWithMedia',
        ]);
        Route::post($segment.'/{id}/media', [
            'as'        => $routeName.'.storeMedia',
            'uses'      => $controller.'@storeMedia',
            'operation' => 'interactWithMedia',
        ]);
        Route::delete($segment.'/{id}/media', [
            'as'        => $routeName.'.destroyMedia',
            'uses'      => $controller.'@destroyMedia',
            'operation' => 'interactWithMedia',
        ]);
        Route::post($segment.'/{id}/media/sort', [
            'as'        => $routeName.'.sortMedia',
            'uses'      => $controller.'@sortMedia',
            'operation' => 'interactWithMedia',
        ]);
    }

  public function listMedia(Product $model)
  {
    $media = $model->getMedia();
    $pictures = [];
    foreach ($media as $item) {
      $pictures[] = [
        'id' => $item->id,
        'url' => $item->getUrl(),
        'order' => $item->order_column ?? 0,
      ];
    }

    return $pictures;
  }

  public function storeMedia(Request $request, Product $model)
  {
    $media = $model->addMedia($request->file('file'))->toMediaCollection();
    return $media->getUrl();
  }

  public function destroyMedia(Product $model, Media $picture)
  {
    $picture->delete();
  }

  public function sortMedia(Request $request)
  {
    $pictures = $request->input('pictures');
    foreach ($pictures as $picture) {
      $media = Media::findOrFail($picture['id']);
      $media->order_column = $picture['order'] ?? 0;
      $media->save();
    }
  }
}

Todo:

The code inside the methods will need to be refactored a little bit, because we can't use route-model-binding (the routes are general, and the parameter is {id} no matter what name the attribute has);
We should find a way to allow developers to add MULTIPLE media types on one entity, for example "pictures", "attachments", etc. Which should be possible but I don't see how right now before I get it 100% working;

But:

I think it'd be a HUGE improvement in usability;
It should avoid setup problems like I'm having in #6 , if that code is not in the developer's control, but inside the package itself;

Let me know what you think @eduardoarandah . Happy to help out with this after I figure out what happens in #6 that stops the package from working for me... I'd of course be happier if you make this conversion to Operations because it'd also mean you take a look at the docs on them and can tell me what you think - I feel that's one bit of the docs that I've had zero feedback on, so I'm not sure how clear I've made it. And it's a pity, because Operations are one thing in Backpack 4.0 that I consider groundbreaking, but not many developers use them to their full potential.

Cheers!

eduardoarandah / medialibrary-dropzone-for-laravel-backpack

[Suggestion] Use Backpack operation instead of telling users to create a controller #7