tatarko/mongoar

Work with your MongoDB in the active record way

dev-master 2015-02-07 12:13 UTC

This package is not auto-updated.

Last update: 2024-05-11 14:00:27 UTC


README

MongoAR is simple library that allows you to use active record pattern on the MongoDB databases and their tables. It also provides simple yet powerful query builder for simple building of search criteria for MongoCollection::find() and MongoCollection::findOne() methods.

Requirements

MongoAR requires to run correctly:

  • PHP, version 5.4 or above
  • mongo pecl library, version 0.9 or above

Instalation

Composer

Simply add a dependency on tatarko/mongoar to your project's composer.json file if you use Composer to manage the dependencies of your project. Here is a minimal example of a composer.json file that just defines a dependency on MongoAR:

{
	"require": {
		"tatarko/mongoar": "0.*"
	}
}

Straight implementation

In case you don't use Composer as your dependency manager you are still able to use MongoAR. There are only two easy steps to get MongoAR work.

  1. Download MongoAR.zip and put extracted archive into your project's folder.
  2. Add following code to your project's root php file (e.g. index.php) and remember to change path/to/ according to relative location of downloaded MongoAR folder:
require_once 'path/to/source/__autoloader.php';

Documentation

Please, see Wiki for online documentation.