99designs / moa
The rightweight data mapper for mongoDB and PHP 5.3+
1.0.5
2013-11-21 01:20 UTC
Requires
- php: >=5.3.2
Requires (Dev)
- mockery/mockery: >=0.7.2
- phpunit/phpunit: 3.7.*
This package is not auto-updated.
Last update: 2024-10-26 12:14:06 UTC
README
Moa is an Object - Document Mapper, built to persist business domain objects in mongoDB.
Why?
- Does the bare minimum to be useful
- Mongo query methods are already pretty good, all that's missing is some validation and typed de/serialisation
- Built to integrate easily into existing applications
- Zero dependencies
- Well tested
- Easy to create custom types with de/serialisation behaviours and validation rules
Installation
- Install via composer:
composer require 99designs/moa
- via github https://github.com/99designs/moa
Getting Started
In your app start up code, add something that looks like the following:
<?php $connection = new Mongo(); // or whatever Moa::setup($connection->mydatabase);
Optionally, a callback can be provided to lazily connect on demand:
<?php Moa::setup(function() { $connection = new Mongo(); return $connection->someDb; });
Also, extra databases can be configured:
<?php $connection = new Mongo(); // or whatever Moa::setup($connection->mydatabase); Moa::instance()->addDatabase('anotherDb', $connection->differentDb); // also takes a callback
Defining Models
Model classes can be defined like so:
<?php class TestDocument extends Moa\DomainObject { public function properties() { return array( 'myInt' => new Moa\Types\IntegerField(array('required' => true)), 'myString' => new Moa\Types\StringField(), 'myArray' => new Moa\Types\ArrayField(), 'myOwnSelf' => new Moa\Types\EmbeddedDocumentField(array('type'=>'TestDocument')), ); } }
- For a full list of field types and their behaviours, see the Moa\Types namespace
- Indexes may also be defined (override
DomainObject::indexes()
) - Domain objects can also specify the database they want to persist to (override
DomainObject::getDatabaseName()
)
Querying
The query syntax is the same as the default PHP mongo driver, but accessed statically from the domain object you hope to query, eg
<?php $docs = TestDocument::find(array('myString'=>'value')); // it is also possible to use cursor methods $docs = TestDocument::find(array('myString'=>'value'))->skip(20)->limit(10); // findOne also works $doc = TestDocument::findOne(array('myString'=>'value')); // this could except // Documents may be saved via a call to save() $doc->myInt = 123; $doc->save(); // Documents can be deleted TestDocument::remove(array('myString' => 'value')); // Deletes all documents with a field 'myString' with value of 'value'