DOCSP-39180: Symfony Quick Start #971

rustagir · 2024-05-24T19:50:43Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-39180
Staging - https://preview-mongodbrustagir.gatsbyjs.io/drivers/DOCS-39180-symfony-qs/php-frameworks/symfony/

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

bisht2050 · 2024-05-27T11:48:02Z

High level, we want to have a page for Symfony where quick start is one of the sections. I envision the page structure to look something like:

Overview
Intro to Symfony, how Symfony works well with MongoDB using Doctrine ODM etc.
Why use MongoDB and Symfony
Quick Start
Resources (You already have these as Next Steps)

We should also rename the page title (Symfony MongoDB Integration ?) since Quick start is just meant to be a section in it.

source/motor.txt

bisht2050 · 2024-05-27T11:49:56Z

source/php-frameworks/symfony.txt

+MongoDB deployments. You can create your own free (no credit card
+required) MongoDB Atlas deployment by following the steps in this guide.
+
+This guide uses **MongoDB Doctrine ODM**, which is an Object-Document


MongoDB Doctrine ODM should hyperlink to https://github.com/doctrine/mongodb-odm

source/php-frameworks/symfony.txt

bisht2050 · 2024-05-27T12:00:29Z

source/php-frameworks/symfony.txt

+  <https://mongodb-developer.github.io/symfony-mongodb-rental-workshop/>`__
+- `Symfony Documentation <https://symfony.com/doc/current/index.html>`__
+- `Doctrine ODM Documentation
+  <https://www.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/index.html>`__


Suggest to add https://github.com/doctrine/mongodb-odm as well

One more which I missed earlier - https://github.com/doctrine/DoctrineMongoDBBundle

I would suggest reducing the ODM links to the following:

https://www.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/index.html

https://www.doctrine-project.org/projects/doctrine-mongodb-bundle/en/latest/index.html

I don't think it's worth linking the individual GitHub repositories (note you aren't doing so for Symfony), as that just distracts from the documentation.

norareidy

Nice work - I left some comments based on my experience following along with the quick start!

source/php-frameworks/symfony.txt

bisht2050 · 2024-05-29T08:13:49Z

source/php-frameworks/symfony.txt

+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Run the following commands to install the MongoDB PHP driver and the
+MongoDB Doctrine ODM:


Suggest to add a line that talks about the mongodb-odm-bundle and why we are installing it instead of directly installing mongodb-odm

Quoting the reason from github: "This bundle integrates the Doctrine MongoDB Object Document Mapper (ODM) library into Symfony so that you can persist and retrieve objects to and from MongoDB."

Also add a hyperlink to it - https://github.com/doctrine/DoctrineMongoDBBundle

bisht2050 · 2024-05-29T08:14:24Z

source/php-frameworks/symfony.txt

+  <https://mongodb-developer.github.io/symfony-mongodb-rental-workshop/>`__
+- `Symfony Documentation <https://symfony.com/doc/current/index.html>`__
+- `Doctrine ODM Documentation
+  <https://www.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/index.html>`__


One more which I missed earlier - https://github.com/doctrine/DoctrineMongoDBBundle

source/php-frameworks/symfony.txt

norareidy

LGTM with some minor suggestions!

source/php-frameworks/symfony.txt

rustagir · 2024-05-30T18:37:36Z

@bisht2050 This PR is ready for a technical review by the PHP team.

source/includes/php-frameworks/Restaurant.php

jmikola · 2024-05-31T13:28:45Z

source/includes/php-frameworks/Restaurant.php

+class Restaurant
+{
+    #[ODM\Id]
+    public  $id;


@alcaeus: Should an ObjectId type hint be used here? That would warrant importing MongoDB\BSON\ObjectId.

Even if no typing change is made, there's an extra space on this line.

It should be a string, as ODM's Id type converts ObjectIds to strings for better handling in web requests. Off the top of my head I don't know how well Doctrine handles uninitialised properties, so if we want to be cautious it should be a nullable string with default value:

Suggested change

public $id;

public ?string $id = null;

ODM's Id type converts ObjectIds to strings for better handling in web requests

Yes, of course. I want to come out on record here and say that it's been that long since I worked on an app with ODM that I legitimately forgot about that for a hot minute.

Changing the field definition was fine, but changing the annotation to #[ODM\Field] for the id field resulted in this error:
No identifier/primary key specified for Entity...
Is this expected? Fixed by changing the annotation back to #[ODM\Id]

#[ODM\Id] is correct. Even though ODM converts ObjectIds to string in the model class, it should be tracked as an identifier.

source/includes/php-frameworks/RestaurantController.php

source/includes/php-frameworks/Restaurant.php

source/php-frameworks/symfony.txt

jmikola · 2024-05-31T14:27:33Z

source/php-frameworks/symfony.txt

+  <https://mongodb-developer.github.io/symfony-mongodb-rental-workshop/>`__
+- `Symfony Documentation <https://symfony.com/doc/current/index.html>`__
+- `Doctrine ODM Documentation
+  <https://www.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/index.html>`__


I would suggest reducing the ODM links to the following:

https://www.doctrine-project.org/projects/doctrine-mongodb-odm/en/latest/index.html

https://www.doctrine-project.org/projects/doctrine-mongodb-bundle/en/latest/index.html

I don't think it's worth linking the individual GitHub repositories (note you aren't doing so for Symfony), as that just distracts from the documentation.

source/php-libraries.txt

source/includes/php-frameworks/symfony/Restaurant.php

source/includes/php-frameworks/symfony/RestaurantController.php

source/php-frameworks/symfony.txt

jmikola · 2024-06-04T18:13:05Z

source/php-frameworks/symfony.txt

+Specify Routes
+``````````````
+
+In the ``config/routes.yaml`` file, add the following routes:


Assuming this was also copied from the dev rel tutorial, I expect there's some redundancy there as well. See: https://symfony.com/doc/current/routing.html

@alcaeus: Should this section be removed entirely? Perhaps "This file sets the following routes in the application" should be relocated to the previous section where the controller class is created, since that ends up defining routes via method attributes.

source/php-frameworks/symfony.txt

jmikola

LGTM with suggestions and YAML routing configuration removed.

jmikola · 2024-06-07T13:23:43Z

source/includes/php-frameworks/symfony/Restaurant.php

+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+use Doctrine\ODM\MongoDB\Types\Type;


This class alias is no longer used.

Suggested change

use Doctrine\ODM\MongoDB\Types\Type;

jmikola · 2024-06-07T13:25:24Z

source/includes/php-frameworks/symfony/index.html.twig

+
+{% block body %}
+    <h1>Welcome to the Symfony MongoDB Quickstart!</h1>
+{% endblock %}


Suggested change

{% endblock %}

{% endblock %}

jmikola · 2024-06-07T15:11:40Z

source/php-frameworks/symfony.txt

+Specify Routes
+``````````````
+
+In the ``config/routes.yaml`` file, add the following routes:


@rustagir: This entire section can be removed.

rustagir added 11 commits May 24, 2024 15:50

DOCSP-39180: symfony qs

c327520

wip

82ea9e8

wip

157f580

wip

ac04d15

wip

bddcbaa

wip

5465f48

wip

8a5a5be

wip

24ef1ba

wip

3d91667

fix error

02e77e6

vale

a490e74

bisht2050 reviewed May 27, 2024

View reviewed changes

norareidy requested changes May 28, 2024

View reviewed changes

rustagir added 6 commits May 28, 2024 16:20

reorg

a05e2b7

add image

1cc4dcd

captions and NR edits1

0178ab7

NR edits 1 final

65f7e10

edits

4ce9441

wip

29e3019

rustagir requested a review from norareidy May 28, 2024 20:58

small fix to note

b30e78f

bisht2050 reviewed May 29, 2024

View reviewed changes

norareidy approved these changes May 29, 2024

View reviewed changes

source/php-frameworks/symfony.txt Outdated Show resolved Hide resolved

source/php-frameworks/symfony.txt Outdated Show resolved Hide resolved

source/php-frameworks/symfony.txt Outdated Show resolved Hide resolved

source/php-frameworks/symfony.txt Outdated Show resolved Hide resolved

rustagir added 2 commits May 30, 2024 14:33

NR and RB comments

1144580

add list item

7edd4ee

mongodb deleted a comment from rishitb-mongodb May 30, 2024

bisht2050 requested review from a team and removed request for a team May 31, 2024 10:32

bisht2050 requested a review from jmikola May 31, 2024 10:32

jmikola reviewed May 31, 2024

View reviewed changes

GromNaN changed the title ~~DOCSP-39180: symfony qs~~ DOCSP-39180: Symfony Quick Start Jun 3, 2024

JM tech review php

f55ff27

jmikola reviewed Jun 4, 2024

View reviewed changes

rustagir added 2 commits June 6, 2024 13:47

JM tech review 2

6756e75

small fixes

1f5d6fd

jmikola approved these changes Jun 7, 2024

View reviewed changes

rustagir added 4 commits June 7, 2024 11:20

JM tech review 3

c052d89

change color

24a00a9

small fixes

b536c70

small fix

56122ae

rustagir merged commit 6d114a0 into mongodb:master Jun 11, 2024
1 check failed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-39180: Symfony Quick Start #971

DOCSP-39180: Symfony Quick Start #971

rustagir commented May 24, 2024 •

edited

Loading

bisht2050 commented May 27, 2024 •

edited

Loading

bisht2050 May 27, 2024

bisht2050 May 27, 2024

bisht2050 May 29, 2024

jmikola May 31, 2024

norareidy left a comment

bisht2050 May 29, 2024

bisht2050 May 29, 2024

norareidy left a comment

rustagir commented May 30, 2024 •

edited

Loading

jmikola May 31, 2024

alcaeus Jun 3, 2024

jmikola Jun 3, 2024

rustagir Jun 6, 2024 •

edited

Loading

jmikola Jun 7, 2024

jmikola May 31, 2024

jmikola Jun 4, 2024

jmikola left a comment •

edited

Loading

jmikola Jun 7, 2024

jmikola Jun 7, 2024

jmikola Jun 7, 2024

DOCSP-39180: Symfony Quick Start #971

DOCSP-39180: Symfony Quick Start #971

Conversation

rustagir commented May 24, 2024 • edited Loading

Pull Request Info

Self-Review Checklist

bisht2050 commented May 27, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

norareidy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

norareidy left a comment

Choose a reason for hiding this comment

rustagir commented May 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustagir Jun 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jmikola left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustagir commented May 24, 2024 •

edited

Loading

bisht2050 commented May 27, 2024 •

edited

Loading

rustagir commented May 30, 2024 •

edited

Loading

rustagir Jun 6, 2024 •

edited

Loading

jmikola left a comment •

edited

Loading