webcodr/mango

A MongoDB object document mapper for PHP

Mango

, _(*1)

, _(*2)

A MongoDB object document mapper for PHP

Inspired by Mongoid for Ruby

Requirements

• PHP 5.4
• MongoDB driver for PHP (min. 1.2.0)
• Composer

Setup

Add Mango to your project

~~~ bash $ php composer.phar require webcodr/mango:*, _(*3)

#### Create a document class

~~~ php
<?php

namespace Mango\Tests\Document;

use Mango\Document;
use Mango\DocumentInterface;

class User implements DocumentInterface
{
    use Document;

    private function addFields()
    {
        $this->addField('name', ['type' => 'String']);
        $this->addField('email', ['type' => 'String']);

        $this->addField(
            'created_at',
            [
                'type' => 'DateTime',
                'index' => true,
                'default' => 'now'
            ]
        );

        $this->addField(
            'updated_at',
            [
                'type' => 'DateTime',
                'index' => true,
                'default' => 'now'
            ]
        );
    }
}

You don't have to set a collection name. Mango uses the class name in lower case as collection name., _(*4)

If you want to set a custom collection name, just override the method getCollectionName() in your own document classes., _(*5)

There's no need to provide an id. Mango's document base class adds automatically the property '_id' with a fresh MongoId object., _(*6)

Save a document

~~~ php <?php, _(*7)

use Mango\Mango; use Mango\DocumentManager;, _(*8)

use Document\User;, _(*9)

$mango = new Mango('mongodb://devserver:27017/galactica-actual'); $dm = new DocumentManager($mango); $user = new User(); $user->name = 'William Adama'; $user->email 'william.adama@galactica.colonial-forces.gov'; $user->store();, _(*10)

#### Remove a document

~~~ php
$user->remove();

Querying

The methods find and where return a \Mango\Persistence\Cursor object or an object of the class \Collection\MutableMap. It depends on which method is called., _(*11)

MutableMap is part of another WebCodr project called Collection. It provides several classes to replace PHP arrays and is much more fun to use. Check it out here., _(*12)

Mango uses object hydration to automatically provide a result with document objects., _(*13)

Find documents by id

One id

~~~ php $user = User::find('abc')->first();, _(*14)

###### Multiple ids

~~~ php
$user = User::find('abc', 'def', 'ghi')->first();

Find all documents in collection

~~~ php User::where()->each(function($user) { echo $user->name; });, _(*15)

##### Find a document with certain field value

~~~ php
$user = User::where(['name' => 'William Adama']);
echo $user->count(); // result = 1
echo $user->first()->email; // result = william.adama@galactica.colonial-forces.gov