DOCSP-41952: Download and Install #92

norareidy · 2024-08-06T15:33:47Z

JIRA - https://jira.mongodb.org/browse/DOCSP-41952
This PR also covers https://jira.mongodb.org/browse/DOCSP-41951
Staging - https://preview-mongodbnorareidy.gatsbyjs.io/php-library/DOCSP-41952-download-install/get-started/download-and-install/
https://preview-mongodbnorareidy.gatsbyjs.io/php-library/DOCSP-41952-download-install/get-started/

shuangela

Good start, some questions/things to think about for you!

shuangela · 2024-08-06T17:47:43Z

source/get-started/download-and-install.txt

+      .. tip::
+
+         You can locate your ``php.ini`` file by running the following command
+         from your shell:


Suggested change

from your shell:

the following shell command:

Or to create consistency: "running the following command in your shell"

shuangela · 2024-08-06T17:50:27Z

source/get-started/download-and-install.txt

+      .. code-block:: bash
+
+         cd php-quickstart
+         touch quickstart.php


S: To my knowledge, the touch command only works on linux/mac machines. This thread: https://stackoverflow.com/questions/30011267/create-an-empty-file-on-the-commandline-in-windows-like-the-linux-touch-command provides alternatives that I think work on both Windows and Linux, unless we want to specify that this guide is only valid for mac/linux machines

shuangela · 2024-08-06T17:50:51Z

source/get-started/download-and-install.txt

+         composer require mongodb/mongodb
+
+      After installing the library, include Composer's ``autoload.php`` file by adding the
+      following line to ``quickstart.php``:


Q: Do the users add this line at the end of the file, or at the beginning/does placement of the line matter?

It should go at the top

shuangela · 2024-08-06T17:51:16Z

source/get-started/download-and-install.txt

+
+         require_once __DIR__ . '/vendor/autoload.php';
+
+After you complete these steps, you have a new project directory


Suggested change

After you complete these steps, you have a new project directory

After you complete these steps, you have a new project directory, a new application file,

shuangela · 2024-08-06T17:51:32Z

source/get-started/download-and-install.txt

+      - `PHP <https://www.php.net/manual/en/install.php>`__
+      - `Composer <https://getcomposer.org/download/>`__
+
+   .. step:: Install the MongoDB extension


Suggested change

.. step:: Install the MongoDB extension

.. step:: Install the MongoDB PHP extension

shuangela · 2024-08-06T17:51:58Z

source/get-started/download-and-install.txt

+
+   .. step:: Update your PHP configuration file
+
+      To enable the ``mongodb`` extension, add the following line to the top of


Suggested change

To enable the ``mongodb`` extension, add the following line to the top of

To enable the ``mongodb`` extension in your PHP configuration file, add the following line to the top of

shuangela · 2024-08-06T17:52:29Z

source/get-started/download-and-install.txt

+      Before you begin developing, ensure that you have the following
+      dependencies installed on your local machine:
+
+      - `PHP <https://www.php.net/manual/en/install.php>`__


Q: Which version of PHP/Composer are necessary?

shuangela

one quick question but good work!

source/get-started/download-and-install.txt

shuangela · 2024-08-06T21:14:38Z

source/get-started/download-and-install.txt

+
+   .. step:: Install the {+php-library+}
+
+      To install the {+php-library+}, run the following command from your ``php-quickstart``


Suggested change

To install the {+php-library+}, run the following command from your ``php-quickstart``

To install the {+php-library+}, run the following command in your ``php-quickstart``

shuangela

LGTM!

shuangela · 2024-08-07T15:11:21Z

source/get-started/download-and-install.txt

+
+         mkdir php-quickstart
+
+      Select the tab corresponding to your operating system and run following commands


Sorry, just noticed this! Quick fix:

Suggested change

Select the tab corresponding to your operating system and run following commands

Select the tab corresponding to your operating system and run the following commands

source/get-started/download-and-install.txt

…P-41952-download-install

GromNaN · 2024-08-21T14:59:01Z

source/tutorial/install-php-library.txt

-Manual Installation Without Composer
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-While not recommended, you may also manually install the library using a source
-archive attached to the
-`GitHub releases <https://github.com/mongodb/mongo-php-library/releases>`__.
-When installing the library without Composer, you must ensure that all library
-classes *and* functions are loaded for your application:
-
-#. If you are using a `PSR-4 <https://www.php-fig.org/psr/psr-4/>`_ autoloader,
-   map the top-level ``MongoDB\`` namespace to the ``src/`` directory. If you
-   are not using an autoloader, manually require _all_ class files found
-   recursively within the ``src/`` directory.
-
-#. Regardless of whether you are using an autoloader, manually require the
-   ``src/functions.php`` file. This is necessary because PHP does not support
-   autoloading for functions.


I agree that this process should no longer be documented. Composer is now widely used and not using it is reserved for experienced users who know how.

* Add PR template * Scaffolding * DOCSP-41953: Create a deployment (#93) * DOCSP-41953: Create a deployment * toc * add troubleshoot file * DOCSP-41954: Create a connection string (#99) * DOCSP-41954: Create a connection string * edits * spacing * DOCSP-42388: Next steps (#101) * DOCSP-41975: Retrieve data (#102) * DOCSP-41975: Retrieve data * fixes * quotes * code fix * JS feedback * JT feedback * code format * fix * JT feedback 2 * edit * DOCSP-41952: Download and Install (#92) * DOCSP-41952: Download and Install * edits * toc, fixes * AS feedback * AS feedback 2 * typo * JT feedback * DOCSP-41976: Projection guide (#104) * DOCSP-41976: Projection guide * edits * fixes * code edits, output * JS feedback * JT feedback * DOCSP-41955: Connect to MongoDB (#100) * DOCSP-41955: Connect to MongoDB * edits * edit * RR feedback * typo * code edit * DOCSP-41974: Specify a query (#103) * DOCSP-41974: Specify a query * edits * output * fix * snooty.toml * RR feedback * code edits * DOCSP-41977: Specify documents to return (#105) * DOCSP-41977: Specify documents to return * edits * code output * toc * MM feedback, code edits * edit * JT feedback * edit * test * MM feedback 2 * DOCSP-41957 - Mongo Client (#106) Co-authored-by: Rea Rustagi <85902999+rustagir@users.noreply.github.com> * DOCSP-41960 - TLS (#114) * DOCSP-41978: Count documents (#108) * DOCSP-41978: Count documents * edits * code ex format * link * RR feedback * DOCSP-41979: Distinct values (#109) Adds a Distinct Values guide. * DOCSP-41981: Change streams (#113) Adds a Change Streams guide. * DOCSP-41993 Compatibility Table * test webhook * toc and sharedincludes * lang table * edits * headings * retry on shared include * shared includes * callout * help links * DOCSP-41958 - Connection Targets (#107) Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Andreas Braun <git@alcaeus.org> * tech review * DOCSP-41968: Update documents (#118) * DOCSP-41968: Update documents * snooty fix * edits * DOCSP-41967: Insert documents (#116) * DOCSP-41967: Insert documents * build * snooty * edit * JS feedback * JT feedback * JT feedback 2 * DOCSP-41980: Cursor guide (#110) * DOCSP-41980: Cursor guide * edits * code edits * output * vale fix * MM feedback * edit * fix code ex * edit * JT feedback * DOCSP-41988: Aggregation (#115) * DOCSP-41988: Aggregation * toc * edits * code edit * JS feedback * dev center * JM feedback * explain api link * JM feedback 2 * DOCSP-41983: indexes landing pg * wip * wip * MM PR fixes 1 * JM tech review 1 * JM tech review 1 * wip * wip * DOCSP-41969: Replace documents (#125) * DOCSP-41969: Replace documents * edits * wording * SA * JT feedback * JM tech review 2 * Add files via upload * DOCSP-41970: Delete documents (#128) Adds a guide that shows how to delete documents. * DOCSP-41984: single field index * wip * JS PR fixes 1 * wip * DOCSP-41986: multikey indexes * links * bullet pts * JS suggestion * fix whitespace per JM comment * uncomment * DOCSP-41985: compound idx * small fix * DOCSP-41966: Write operations landing (#135) * DOCSP-41966: Write operations landing * edits * RR feedback * JT feedback * JT feedback 2 * gridfs examples * DOCSP-42026: In use encryption (#142) * DOCSP-42026: In use encryption * edit * DOCSP-41972: GridFS guide (#133) * DOCSP-41972: GridFS guide * fixes * code edits * fix * RR feedback * phpmethod * fix * JM most feedback * alternate upload/download methods * file revisions * code fix * tojson * edits * JM feedback 2 * edits * JM last feedback * DOCSP-41971: Bulk write (#130) * DOCSP-41971: Bulk write * edits * JS feedback * api links * DOCSP-41987: atlas search idx * resolve todos * toc * DOCSP-41963: Databases and collections (#136) * DOCSP-41963: Databases and collections * edits * phpmethod * code fix * MW feedback * fix * MW feedback 2 * JM feedback * JM feedback 2 * JS fix * internal review * DOCSP-41982: cluster monitoring * small fixes * MW PR fixes 1 * test netlify * spacing * try using out of repo ref and add back legend * ou of repo ref * legend glitch * JM tech review 1 * single quotes * links * vale * remove older driver version past 1.15 * DOCSP-41991 What's New * add rest of versions * fix links * fix links * JM tech review 2 * DOCSP-41964: Time series collections (#138) * DOCSP-41964: Time series collections * toc * edits * keywords * SA feedback * JT feedback * JM final fixes * review comments * typo * DOCSP-41973 Read Landing Page * review comments * vale errors * small thing * full page with ex * add page * meta * DOCSP-41965: Read and write settings (#146) * DOCSP-41965: Read and write settings * more info * edits * edits * headers * fix link * fix * RR feedback * api docs * fix * fix * DOCSP-41950: Landing page (#150) * DOCSP-41950: Landing page * fix build errors * fixes, data formats * toc * fix * data formats folder * RR feedback * fix * remove file * edit sample app intro * change links in count sections * update sample app intro * DOCSP-41990: Authentication mechanisms (#139) * DOCSP-41990: Authentication mechanisms * client tabs * edits * edits * add info * reduce repetition * add section * fix link * MW feedback * fix * JM most feedback * move to code file * more JM edits * JM feedback 2 * DOCSP-41989: Security landing page (#149) * DOCSP-41989: Security landing page * more info * edits * snooty.toml * edits * RR feedback * JM feedback * DOCSP-41962 - Stable API (#117) Co-authored-by: Jeremy Mikola <jmikola@gmail.com> * DOCSP-41992 Upgrade versions * toc * edits * how to upgrade sections * style * edit * edit * review comments * ref * Revise descriptions for server opening/closed events * DOCSP-43204: Connection landing page (#147) * DOCSP-43204: Connection landing page * toc edit * edits * remove compression * fix * sample app * snooty * JM feedback * replica set * JM feedback 2 * JM last feedback * DOCSP-43819: php 1.20 release * fix * DOCSP-41956: run a command * wip * formatting fix * JS PR fixes 1 * link fix * style fixes * JT tech review 1 * wip * JM tech review * tree * api links * links * JM tech review 2 * small fixes * add ext upgrade command * DOCSP-41995: transaction * wip * update code * NR PR fixes 1 * wip * add emphasis * add with_txn() method to api links * cxn string env * edit * JM tech review 1 * remove dupe sc * tech review * wrap fix * edit copy * DOCSP-41959 - Connection Options (#112) Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Jeremy Mikola <jmikola@gmail.com> * DOCSP-43396: Cleanup (#151) * DOCSP-43396: Cleanup * quickstart fix * code fixes * edit * snooty * edit * code output * build log errors * another build fix * add info * upgrade guide to landing * fix * driver mentions * RR feedback * build fix * build fix * php directives --------- Co-authored-by: Mike Woofter <108414937+mongoKart@users.noreply.github.com> Co-authored-by: Rea Rustagi <85902999+rustagir@users.noreply.github.com> Co-authored-by: Lindsey Moore <lindsey.moore@mongodb.com> Co-authored-by: Andreas Braun <git@alcaeus.org> Co-authored-by: rustagir <rea.rustagi@mongodb.com> Co-authored-by: Brandon Ly <brandonly@lostcoding.com> Co-authored-by: lindseymoore <71525840+lindseymoore@users.noreply.github.com> Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

norareidy added 3 commits August 6, 2024 11:32

DOCSP-41952: Download and Install

6418d93

edits

5ef0ac6

toc, fixes

005d830

norareidy changed the base branch from master to php-standardization August 6, 2024 17:02

shuangela requested changes Aug 6, 2024

View reviewed changes

AS feedback

cc32aa5

norareidy requested a review from shuangela August 6, 2024 19:14

shuangela requested changes Aug 6, 2024

View reviewed changes

AS feedback 2

186f149

norareidy requested a review from shuangela August 7, 2024 14:18

shuangela approved these changes Aug 7, 2024

View reviewed changes

typo

48abf5f

norareidy requested review from a team and GromNaN and removed request for a team August 12, 2024 18:14

GromNaN reviewed Aug 16, 2024

View reviewed changes

source/get-started/download-and-install.txt Show resolved Hide resolved

JT feedback

0582736

norareidy requested a review from GromNaN August 16, 2024 15:51

Merge remote-tracking branch 'upstream/php-standardization' into DOCS…

4d951ea

…P-41952-download-install

GromNaN approved these changes Aug 21, 2024

View reviewed changes

norareidy merged commit 1104051 into mongodb:php-standardization Aug 21, 2024
2 checks passed

norareidy deleted the DOCSP-41952-download-install branch August 21, 2024 17:24


		require_once __DIR__ . '/vendor/autoload.php';

		After you complete these steps, you have a new project directory

	.. step:: Install the MongoDB extension
	.. step:: Install the MongoDB PHP extension


		.. step:: Update your PHP configuration file

		To enable the ``mongodb`` extension, add the following line to the top of

	To enable the ``mongodb`` extension, add the following line to the top of
	To enable the ``mongodb`` extension in your PHP configuration file, add the following line to the top of


		.. step:: Install the {+php-library+}

		To install the {+php-library+}, run the following command from your ``php-quickstart``


		mkdir php-quickstart

		Select the tab corresponding to your operating system and run following commands

DOCSP-41952: Download and Install #92

DOCSP-41952: Download and Install #92

Uh oh!

Conversation

norareidy commented Aug 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shuangela left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shuangela left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shuangela left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

norareidy commented Aug 6, 2024 •

edited

Loading