julien-c/mongovel

A Laravel-ish wrapper to the PHP Mongo driver

Mongovel

A Laravel-ish wrapper to the PHP Mongo driver

Most MongoDB packages for Laravel insist on abstracting away the PHP driver and implementing a SQL-like, full-fledged query builder. We think the PHP driver for Mongo is great by itself and Mongo's expressiveness out-of-the-box is actually what makes it awesome., _(*1)

In that spirit, Mongovel is a thin wrapper over the PHP driver that makes it more Eloquent-like: * you'll be able to access models like objects, not arrays * you'll get query results as Laravel Collections * and some more syntactic sugar, like Facade-inspired static shortcuts to make the whole experience more elegant. And remember, you always keep the full power of Mongo methods, as Mongovel always proxies calls to the underlying MongoCollections and MongoCursors. We're sure you'll love it!, _(*2)

Usage overview

Enough talking, here's how to use Mongovel:, _(*3)

class Book extends MongovelModel
{
}

GET books/512ce86b98dee4a87a000000:, _(*4)

public function show($id)
{
    $book = Book::findOne(new MongoId($id));

    // Here, you can access the book's attributes like in Eloquent:
    // $book->title, $book->reviews, etc.
    // $book->id is a string representation of the object's MongoId.

    // Let's say we're an API, so let's just send the object as JSON:

    return $book;
}

Mongovel detects that $id is a MongoId, and returns an object that will be automatically serialized and sent as JSON by Laravel., _(*5)

POST books:, _(*6)

public function store()
{
    $book = Input::only('title', 'content');

    Book::insert($book);
}

What if we want to update some field on our book? Let's say we're posting a review:, _(*7)

POST books/512ce86b98dee4a87a000000/reviews:, _(*8)

public function reviewStore($id)
{
    $review = Input::all();

    // You can leverage the full power of Mongo query operators:
    Book::update(new MongoId($id),
        array('$push' => array('reviews' => $reviews))
    );

    return Response::json(array('status' => 201), 201);
}

Deleting a book is as simple as:, _(*9)

public function destroy($id)
{
    Book::remove(new MongoId($id));
}

Finally, Mongovel wraps MongoCursor results into Laravel Collections, so you can just do: GET books:, _(*10)

public function index()
{
    $books = Book::find();

    $books->each(function($book) {
        // Do anything you would do on a Laravel Collection
    });

    return $books;
}

Bulk operations

In order to make bulk operations less painful, Mongovel implements the standard bulk interface:, _(*11)

$bulk = Book::initializeOrderedBulk();

$bulk->insert(array('author' => 'Me', 'title' => 'My life'));

$bulk->find(array('author' => 'Me'))
     ->update(array('$push' => array('reviews' => "Awesome!")));

$bulk->find(array('title' => 'My life'))
     ->updateOne(array('$push' => array('reviews' => "Incredible!")));

$bulk->find(array('title' => 'My life, II'))
     ->upsert()
     ->update(array('$push' => array('reviews' => "Can't wait!")));

$bulk->find(array('author' => 'Not me'))
     ->remove();

$bulk->find(array('title' => 'My life, II'))
     ->removeOne();

$bulk->execute();

How to install

Add julien-c/mongovel as a requirement to composer.json, then run composer update., _(*12)

Add Mongovel's service provider to your Laravel application in app/config/app.php. In the providers array add :, _(*13)

'Mongovel\MongovelServiceProvider'

Add then alias Mongovel's model class by adding its facade to the aliases array in the same file :, _(*14)

'MongovelModel' => 'Mongovel\Model'

Finally, add a MongoDB hash at the end of your app/config/database.php (so, outside of connections):, _(*15)

'mongodb' => array(
    'default' => array(
        'host'     => 'localhost',
        'port'     => 27017,
        'database' => 'laravel',
    )
)

If needed (for MongoHq and the likes), you can specify a username and password in this array as well., _(*16)

Any other options will be added as GET parameters to the DSN., _(*17)

Authentification

To use Mongovel as your Auth provided, you'll simply need to go in the app/config/auth.php file and set mongo as your driver., _(*18)

License

Licensed under the MIT License., _(*19)

Other MongoDB wrappers in PHP

Before writing our own, here are the wrappers we've checked out (and sometimes contributed to): * hpaul/mongor * thephpleague/monga * flatline/mongol * navruzm/lmongo, _(*20)