alxarafe/resource-eloquent

alxarafe/resource-eloquent

Eloquent ORM adapter for alxarafe/resource-controller.

Implements RepositoryContract, QueryContract, and TransactionContract using Illuminate Database.

Ecosystem

Installation

composer require alxarafe/resource-eloquent

This will automatically install alxarafe/resource-controller and illuminate/database.

Usage

use Alxarafe\ResourceController\AbstractResourceController;
use Alxarafe\ResourceController\Contracts\RepositoryContract;
use Alxarafe\ResourceController\Contracts\TransactionContract;
use Alxarafe\ResourceEloquent\EloquentRepository;
use Alxarafe\ResourceEloquent\EloquentTransaction;
use App\Models\Product; // Your Eloquent model

class ProductController extends AbstractResourceController
{
    // ... basic controller configuration ...

    protected function getRepository(string $tabId = 'default'): RepositoryContract
    {
        return new EloquentRepository(Product::class);
    }

    protected function getTransaction(): TransactionContract
    {
        // Get the DB connection from Laravel or Capsule
        return new EloquentTransaction(\Illuminate\Support\Facades\DB::connection());
    }
}

Features

• Translates declarative field filtering and querying to Eloquent queries.
• Manages pagination automatically.
• Handles simple and compound database transactions seamlessly.
• Converts Eloquent metadata directly into Resource Controller configurations.

Development

Docker

docker compose up -d
docker exec alxarafe-resources composer install

Running the CI pipeline locally

bash bin/ci_local.sh

Running tests only

bash bin/run_tests.sh

License

GPL-3.0-or-later