fershopls/mongodb-for-laravel

A simple and elegant way to interact with MongoDB within your Laravel applications.

dev-main 2024-05-17 07:46 UTC

Requires

• mongodb/mongodb: ^1.19

Requires (Dev)

• orchestra/testbench: 9.0
• pestphp/pest: ^2.34

MIT

• Fernando

README

<?php

namespace App\Collections;

use Mongo\Database\Collection;

class ClientCollection extends Collection
{
}

Calling Mongo DB Commands from the Collection

use App\Collections\ClientCollection;

// Every call will be forwarded to
// the \MongoDB\Collection instance
// so we can call any method available

ClientCollection::find([]);

ClientCollection::findOne([]);

ClientCollection::aggregate($pipeline);

ClientCollection::insertOne($data);

ClientCollection::insertMany($data);

ClientCollection::updateOne($filter, $data);

ClientCollection::updateMany($filter, $data);

ClientCollection::deleteOne($filter);

ClientCollection::deleteMany($filter);

Find one document

// when calling aggregate or any find command
// on the collection instance, the documents will be
// automatically converted to the collection class

$client = ClientCollection::findOne([
    'title' => 'John Doe',
]);

// we can call collection methods
$client->markAsDisabled();

// read as array
$name = $client['name']; // John Doe

// read as object
$name = $client->name; // John Doe
// [!] only first level keys are accessible
$nested = $client->address->street->line1; // Attempt to read property "street" on array

// safe read
$line1 = $client->get('address.street.line1'); // 123 Main St
$undefined = $client->get('this.key.does.not.exists'); // null

// collect a field
$location = $client
    ->collect('address')
    ->only(['country', 'city'])
    ->join(', '); // USA, New York

Find many documents

$clients = ClientCollection::find([
    'status' => 'active',
]);

// $clients type is \Illuminate\Support\Collection
// so we can use all collection methods

Route Binding

Route::get('/clients/{client}', function (ClientCollection $client) {
    // if not found it will abort with 404
    return $client->collect()->only(['name', 'email']);
});

// by specified field
// example: /clients/[e-mail]
Route::get('/clients/{client:email}', function (ClientCollection $client) {
    // if not found it will abort with 404
    return $client;
});

Custom findById

// Find or fail by id
$client = ClientCollection::findById($id);

// if $id is an instance of ObjectID it will be used as is
// if $id is string it will be automatically converted to ObjectID

Custom findOrFail

// Find or fail by id
// it will abort with 404 if not found
$client = ClientCollection::findOrFail($id);

// Find or fail by a filter
// it will abort with 404 if not found
$client = ClientCollection::findOrFail([
    'email' => '[e-mail]',
]);