introduction.txt 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. Title: Introduction
  2. Author: Dariusz Górecki <darek.krk@gmail.com>
  3. ---
  4. This extension is an almost complete, ActiveRecord like support for MongoDB in Yii
  5. It originally started as a fork of [MongoRecord](http://www.yiiframework.com/extension/mongorecord "MongoRecord")
  6. extension written by [tyohan](http://www.yiiframework.com/user/31/ "tyohan"),
  7. to fix some major bugs, and add full featured suite for [MongoDB](http://www.mongodb.org "MongoDB") developers.
  8. ## Limitations:
  9. - The main limitations are only those present in MongoDB itself, like the 4MB single document data limit. But That's not a big deal either.
  10. - In it's current incarnation, This extension does NOT work with the OR operator. When we get it working we will remove this line and add an example.
  11. ## Requirements:
  12. - Yii 1.1.5 is required
  13. - MongoDB latest stable is recommended. Untested with older versions.
  14. ## Known bugs
  15. - Remember, this is not complete yet. So at this stage, it can have some ;]
  16. - If you find any please let me know
  17. - As said before, it does not work with the OR operators
  18. ## Resources
  19. * [Project page on GitHub](https://github.com/canni/YiiMongoDbSuite)
  20. * [MongoDB documentation](http://www.mongodb.org/display/DOCS/Home)
  21. * [On-Line version of this documentation](http://canni.github.com/YiiMongoDbSuite)
  22. * [PHP MongoDB Driver docs](http://www.php.net/manual/en/book.mongo.php)
  23. * [Standard Yii ActiveRecord Documentation](http://www.yiiframework.com/doc/guide/1.1/en/database.ar)
  24. ## Contribution needed!
  25. - I'm not English native speaker, need someone who can correct/rewrite/write my documentation and/or PHPDoc's in code
  26. - Any help would be great :)
  27. - Contact me: darek.krk on a gmail dot com or via GitHub PM
  28. ## Big thanks goes to:
  29. - tyohan: for first inspirations and idea of extension
  30. - luckysmack: for big help with testing and documentation
  31. - Jose Martinez and Philippe Gaultier, for implementing and sharing GridFS support
  32. - Nagy Attila Gábor, for big help with new functionality and testing