|
| 1 | +.. _php-download-and-install: |
| 2 | + |
| 3 | +==================== |
| 4 | +Download and Install |
| 5 | +==================== |
| 6 | + |
| 7 | +.. facet:: |
| 8 | + :name: genre |
| 9 | + :values: tutorial |
| 10 | + |
| 11 | +.. meta:: |
| 12 | + :keywords: setup, composer, installation, code example |
| 13 | + |
| 14 | +.. procedure:: |
| 15 | + :style: connected |
| 16 | + |
| 17 | + .. step:: Install dependencies |
| 18 | + |
| 19 | + Before you begin developing, ensure that you have the following |
| 20 | + dependencies installed on your local machine: |
| 21 | + |
| 22 | + - `PHP <https://www.php.net/manual/en/install.php>`__ version 7.4 or later |
| 23 | + - `Composer <https://getcomposer.org/download/>`__ version 2.0 or later |
| 24 | + |
| 25 | + .. step:: Install the MongoDB PHP extension |
| 26 | + |
| 27 | + Run the following command to install the ``mongodb`` PHP extension: |
| 28 | + |
| 29 | + .. code-block:: bash |
| 30 | + |
| 31 | + sudo pecl install mongodb |
| 32 | + |
| 33 | + .. step:: Update your PHP configuration file |
| 34 | + |
| 35 | + To enable the ``mongodb`` extension in your PHP configuration file, add the |
| 36 | + following line to the top of your ``php.ini`` file: |
| 37 | + |
| 38 | + .. code-block:: none |
| 39 | + |
| 40 | + extension=mongodb.so |
| 41 | + |
| 42 | + .. tip:: |
| 43 | + |
| 44 | + You can locate your ``php.ini`` file by running the following command |
| 45 | + in your shell: |
| 46 | + |
| 47 | + .. code-block:: bash |
| 48 | + |
| 49 | + php --ini |
| 50 | + |
| 51 | + .. step:: Create a project directory |
| 52 | + |
| 53 | + From your root directory, run the following command in your shell to create |
| 54 | + a directory called ``php-quickstart`` for this project: |
| 55 | + |
| 56 | + .. code-block:: bash |
| 57 | + |
| 58 | + mkdir php-quickstart |
| 59 | + |
| 60 | + Select the tab corresponding to your operating system and run the following commands |
| 61 | + to create a ``quickstart.php`` application file in the ``php-quickstart`` directory: |
| 62 | + |
| 63 | + .. tabs:: |
| 64 | + |
| 65 | + .. tab:: macOS / Linux |
| 66 | + :tabid: create-file-mac-linux |
| 67 | + |
| 68 | + .. code-block:: bash |
| 69 | + |
| 70 | + cd php-quickstart |
| 71 | + touch quickstart.php |
| 72 | + |
| 73 | + .. tab:: Windows |
| 74 | + :tabid: create-file-windows |
| 75 | + |
| 76 | + .. code-block:: bash |
| 77 | + |
| 78 | + cd php-quickstart |
| 79 | + type nul > quickstart.php |
| 80 | + |
| 81 | + .. step:: Install the {+php-library+} |
| 82 | + |
| 83 | + To install the {+php-library+}, run the following command in your ``php-quickstart`` |
| 84 | + directory: |
| 85 | + |
| 86 | + .. code-block:: bash |
| 87 | + |
| 88 | + composer require mongodb/mongodb |
| 89 | + |
| 90 | + After installing the library, include Composer's ``autoload.php`` file by adding the |
| 91 | + following code to the top of your ``quickstart.php`` file: |
| 92 | + |
| 93 | + .. code-block:: php |
| 94 | + |
| 95 | + <?php |
| 96 | + |
| 97 | + require_once __DIR__ . '/vendor/autoload.php'; |
| 98 | + |
| 99 | +After you complete these steps, you have a new project directory, a |
| 100 | +new application file, and the library dependencies installed. |
| 101 | + |
| 102 | +.. include:: /includes/get-started/troubleshoot.rst |
0 commit comments