|
1 |
| -MongoDB library for PHP |
2 |
| -======================= |
| 1 | +# MongoDB PHP Library |
3 | 2 |
|
4 |
| -This library provides a high-level abstraction around the lower-level drivers for |
5 |
| -[PHP](https://github.com/mongodb/mongo-php-driver) and |
6 |
| -[HHVM](https://github.com/mongodb/mongo-hhvm-driver) (i.e. the `mongodb` |
7 |
| -extension). |
| 3 | +[](https://travis-ci.org/mongodb/mongo-php-library) |
| 4 | + |
| 5 | +This library provides a high-level abstraction around the lower-level |
| 6 | +[PHP driver](https://github.com/mongodb/mongo-php-driver) (`mongodb` extension). |
8 | 7 |
|
9 | 8 | While the extension provides a limited API for executing commands, queries, and
|
10 | 9 | write operations, this library implements an API similar to that of the
|
11 |
| -[legacy PHP driver](http://php.net/manual/en/book.mongo.php). It contains |
| 10 | +[legacy PHP driver](https://php.net/manual/en/book.mongo.php). It contains |
12 | 11 | abstractions for client, database, and collection objects, and provides methods
|
13 | 12 | for CRUD operations and common commands (e.g. index and collection management).
|
14 | 13 |
|
15 | 14 | If you are developing an application with MongoDB, you should consider using
|
16 | 15 | this library, or another high-level abstraction, instead of the extension alone.
|
17 | 16 |
|
18 |
| -For further information about the architecture of this library and the `mongodb` |
19 |
| -extension, see: |
20 |
| - |
21 |
| - - http://www.mongodb.com/blog/post/call-feedback-new-php-and-hhvm-drivers |
| 17 | +Additional information about the architecture of this library and the `mongodb` |
| 18 | +extension may be found in |
| 19 | +[Architecture Overview](https://php.net/manual/en/mongodb.overview.php). |
22 | 20 |
|
23 | 21 | ## Documentation
|
24 | 22 |
|
25 | 23 | - https://docs.mongodb.com/php-library/
|
| 24 | + - https://docs.mongodb.com/ecosystem/drivers/php/ |
26 | 25 |
|
27 |
| -# Installation |
28 |
| - |
29 |
| -As a high-level abstraction for the driver, this library naturally requires that |
30 |
| -the [`mongodb` extension be installed](http://php.net/manual/en/mongodb.installation.php): |
31 |
| - |
32 |
| - $ pecl install mongodb |
33 |
| - $ echo "extension=mongodb.so" >> `php --ini | grep "Loaded Configuration" | sed -e "s|.*:\s*||"` |
| 26 | +## Installation |
34 | 27 |
|
35 | 28 | The preferred method of installing this library is with
|
36 | 29 | [Composer](https://getcomposer.org/) by running the following from your project
|
37 | 30 | root:
|
38 | 31 |
|
39 | 32 | $ composer require mongodb/mongodb
|
40 | 33 |
|
| 34 | +Additional installation instructions may be found in the |
| 35 | +[library documentation](https://docs.mongodb.com/php-library/current/tutorial/install-php-library/). |
| 36 | + |
| 37 | +Since this library is a high-level abstraction for the driver, it also requires |
| 38 | +that the `mongodb` extension be installed: |
| 39 | + |
| 40 | + $ pecl install mongodb |
| 41 | + $ echo "extension=mongodb.so" >> `php --ini | grep "Loaded Configuration" | sed -e "s|.*:\s*||"` |
| 42 | + |
| 43 | +Additional installation instructions for the extension may be found in its |
| 44 | +[PHP.net documentation](https://php.net/manual/en/mongodb.installation.php). |
| 45 | + |
41 | 46 | ## Reporting Issues
|
42 | 47 |
|
43 |
| -Please use the following form to report any issues: |
| 48 | +Issues pertaining to the library should be reported in the |
| 49 | +[PHPLIB](https://jira.mongodb.org/secure/CreateIssue!default.jspa?project-field=PHPLIB) |
| 50 | +project in MongoDB's JIRA. Extension-related issues should be reported in the |
| 51 | +[PHPC](https://jira.mongodb.org/secure/CreateIssue!default.jspa?project-field=PHPC) |
| 52 | +project. |
| 53 | + |
| 54 | +For general questions and support requests, please use one of MongoDB's |
| 55 | +[Technical Support](https://docs.mongodb.com/manual/support/) channels. |
| 56 | + |
| 57 | +### Security Vulnerabilities |
| 58 | + |
| 59 | +If you've identified a security vulnerability in a driver or any other MongoDB |
| 60 | +project, please report it according to the instructions in |
| 61 | +[Create a Vulnerability Report](https://docs.mongodb.org/manual/tutorial/create-a-vulnerability-report). |
| 62 | + |
| 63 | +## Development |
44 | 64 |
|
45 |
| - - https://jira.mongodb.org/secure/CreateIssue.jspa?pid=12483&issuetype=1 |
| 65 | +Development is tracked in the |
| 66 | +[PHPLIB](https://jira.mongodb.org/projects/PHPLIB/summary) project in MongoDB's |
| 67 | +JIRA. Documentation for contributing to this project may be found in |
| 68 | +[CONTRIBUTING.md](CONTRIBUTING.md). |
0 commit comments