PHP code example of maarsson / laravel-repository

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

maarsson / laravel-repository example snippets

        'models' => [
            'YourModel',
        ],
    

    use App\Interfaces\YourModelRepositoryInterface;

    class TestController extends Controller
    {
        private $repository;

        public function __construct(YourModelRepositoryInterface $repository)
        {
            $this->repository = $repository;
        }
    }
    

        class YourModelRepository extends AbstractEloquentRepository implements YourModelRepositoryInterface
        {
            public function doSomeConverting()
            {
                // your code here
            }
        }
    

        interface YourModelRepositoryInterface
        {
            public function doSomeConverting();
        }
    

$collection = $this->repository->all();

$entity = $this->repository->find(3);

$collection = $this->repository->findBy('title', 'Music');

$entity = $this->repository->first();
$entity = $this->repository->last();

$collection = $this->repository->all('id', 'title');
$collection = $this->repository->find(3, 'id', 'title');
$entity = $this->repository->first('id', 'title');
$entity = $this->repository->last('id', 'title');

$count = $this->repository->count();

$entity = $this->repository->create([
    'title' => 'Music',
    'price' => 12.9,
]);

$entity = $this->repository->update(
    3, // the id of the entity to be updated
    [
        'title' => 'Music',
        'price' => 12.9,
    ]
);

$this->repository->delete(3);

$this->repository->deleteWhere('value', '<', 100);

// simple pagination
$this->repository
    ->paginate($per_page = 15);
// pagination on ordered result
$this->repository
    ->orderBy('name')
    ->paginate($per_page = 15);

    namespace App\Repositories;

    use Maarsson\Repository\Traits\GetterableTrait;

    class YourModelRepository extends AbstractEloquentRepository implements CustomerRepositoryInterface
    {
        use GetterableTrait;
    }
    

    protected function nameFilter(string|null $searchString): \Illuminate\Database\Eloquent\Builder
    {
        return $this->builder->where('name', 'LIKE', '%' . $searchString . '%');
    }
    

    // HTTP GET //localhost/yourmodel?filter[name]=foo
    public function index(\App\Filters\YourModelGetter $getter)
    {
        return $this->repository
            ->filter($getter)
            ->get();
    }
    

    protected function relatedModelDateSorter(): \Illuminate\Database\Eloquent\Builder
    {
        return RelatedModel::select('date')
            ->whereColumn('this_model_column', 'related_table.column');
    }
    

    // HTTP GET //localhost/yourmodel?sort_by=related_model_date
    public function index(\App\Filters\YourModelGetter $getter)
    {
        return $this->repository
            ->order($getter)
            ->get();
    }
    

// HTTP GET //localhost/yourmodel?filter[name]=foo&page=5&per_page=20&sort_by=related_model_date&sort_order=desc
public function index(\App\Filters\YourModelGetter $getter)
{
    return $this->repository
        ->filter($getter)
        ->order()
        ->paginate();
}

    namespace App\Models;

    use Maarsson\Repository\Traits\EloquentAttributeFilterTrait;

    class YourModel extends Model
    {
        use EloquentAttributeFilterTrait;
    }
    

    // HTTP GET //localhost/yourmodel?filter[name]=foo&page=5&per_page=20&sort_by=related_model_date&sort_order=desc
    public function index(\App\Filters\YourModelGetter $getter)
    {
        return $this->repository
            ->filter($getter)
            ->order()
            ->paginate();
            ->through(
                fn ($item) => $item->withAttributes([
                    'id',
                    'name', // a model property
                    'finalPrice', // even a model accessor
                    'users' // a relation (with all of its attributes)
                    'users.posts:id,title', // a relations relation (with limited attributes)
                ])
            );
    }
    

$this->repository
    ->where('value', '<', 100)
    ->get();
$this->repository
    ->where('value', '>', 50)
    ->orWhere('value', '<', 100)
    ->get();

$this->repository->orderBy('title', 'desc')->get();

$this->repository->withTrashed()->get();
$this->repository->onlyTrashed()->get();

$this->repository->with('authors')->get();

$this->repository->builder()
    ->whereIn('id', [1,2,3]);
    ->limit(5);
    ->offset(10);
    ->toSql();