Adding PHP attributes #9555

ThomasLandauer · 2022-03-02T12:43:59Z

@greg0ire This is the first (small) step towards documenting enums - see #9304 (comment)
I started reading the page from the top, and did some minor changes.
Biggest change: If you agree, I'd continue adding php attributes to all code blocks, and always mention it as first choice.

docs/en/reference/basic-mapping.rst

derrabus · 2022-03-02T12:53:50Z

Biggest change: If you agree, I'd continue adding php attributes to all code blocks, and always mention it as first choice.

I agree. We should be consistent about the order of the code examples and attributes should be the preferred choice nowadays.

Looking at the code example you've updated, I also noticed that the annotation example (and consequently your new attribute example) don't import the Entity annotation via a use statement. Since the examples start with an opening <?php tag, the reader might get the impression that the use statement is not necessary. I think we should add the necessary imports.

ThomasLandauer · 2022-03-02T13:08:41Z

@SenseException In Symfony docs there is a shorcut versionadded (or similar) for a uniform info box "XY was added in version x.y". There's nothing similar here in Doctrine, is it?

ThomasLandauer · 2022-03-02T14:28:25Z

@derrabus: OK, done :-)

Question about https://github.com/doctrine/orm/pull/9555/files#diff-239d9a128ce24a76e204d8b9821ce009ef5c7b16298d549165da9bc05d5d8f97R246
Can I link to a separate page this way, or do I have to create an anchor there and then use this syntax?:

:doc:`Docblock Annotations <annotations-reference>`

ThomasLandauer · 2022-03-02T14:56:25Z

I'm done for the moment; please merge this, so I can see how it comes out. Then I'll continue.

docs/en/reference/basic-mapping.rst

greg0ire · 2022-03-02T18:19:46Z

Please refrain from mentioning people in commit, it results in them receiving a notification every time that commit is cherry-picked here or there 🙏

greg0ire · 2022-03-02T18:20:34Z

docs/en/reference/basic-mapping.rst

    stored in the metadata cache.  If you're not using a metadata cache (not
    recommended!) then the XML driver is the fastest.

 Marking our ``Message`` class as an entity for Doctrine is straightforward:

 .. configuration-block::

-    .. code-block:: php
+    .. code-block:: attribute


As I commented on your commit where you mentioned me, isn't this going to break syntactic coloration?

No, it's the same as I was using at https://www.doctrine-project.org/projects/doctrine-orm/en/2.11/reference/events.html#lifecycle-callbacks

Sorry about the mentioning! Somebody already told me that before - I hope I'll remember next time...

No worries, please reword that commit to make it go away.

How to do that?

git rebase -i origin/2.11.x, assuming origin is a git remote that points to this repository, and not your fork. If you're not sure what your remotes are, run git remote -vvv, there should be your fork and the holy/reference/base/origin/whatever-you-call-it repository.

A window will show up with many lines, replace pick with reword on the line corresponding to your commit

Close your editor, git should do its magic, and let you amend the commit message

Use git push --force to overwrite what you already push. Don't forget the --force option otherwise git will try to merge both things together.

Thanks, my "Git instructor"! :-) It looks like I succeeded.

Indeed, great job! My inbox thanks you!

So this is resolved? Could you please merge it then?

This is the first (small) step towards documenting enums - see doctrine#9304 (comment) I started reading the page from the top, and did some minor changes. Biggest change: If you agree, I'd continue adding php attributes to all code blocks.

Co-authored-by: Alexander M. Turek <me@derrabus.de>

…RM\Mapping\Column;`

SenseException · 2022-03-03T19:40:48Z

@ThomasLandauer There's a versionadded in rst-parser and it doesn't seem to be much in use.

Website:
https://www.doctrine-project.org/projects/doctrine-orm/en/2.11/tutorials/extra-lazy-associations.html
rst:
https://github.com/doctrine/orm/blob/2.11.x/docs/en/tutorials/extra-lazy-associations.rst

ThomasLandauer · 2022-03-03T20:17:32Z

@SenseException Thanks, I now used it here too :-)

docs/en/reference/basic-mapping.rst

Co-authored-by: Claudio Zizza <859964+SenseException@users.noreply.github.com>

* 2.11.x: Make sure MemcachedAdapter is supported before tring to use it (#9574) Fixing `:doc:` link (#9569) Adding PHP attributes (#9555) Remove reference to removed class

* 2.11.x: Baseline Psalm errors caused by DBAL 3.3.3 (#9577) Make sure MemcachedAdapter is supported before tring to use it (#9574) Fixing `:doc:` link (#9569) Adding PHP attributes (#9555) Remove reference to removed class

* 2.12.x: Leverage MemcachedAdapter::isSupported() (doctrine#9578) Baseline Psalm errors caused by DBAL 3.3.3 (doctrine#9577) Make sure MemcachedAdapter is supported before tring to use it (doctrine#9574) Fixing `:doc:` link (doctrine#9569) Adding PHP attributes (doctrine#9555) Remove reference to removed class

derrabus added the Documentation label Mar 2, 2022

derrabus reviewed Mar 2, 2022

View reviewed changes

docs/en/reference/basic-mapping.rst Outdated Show resolved Hide resolved

derrabus reviewed Mar 2, 2022

View reviewed changes

docs/en/reference/basic-mapping.rst Outdated Show resolved Hide resolved

derrabus reviewed Mar 2, 2022

View reviewed changes

docs/en/reference/basic-mapping.rst Outdated Show resolved Hide resolved

derrabus reviewed Mar 2, 2022

View reviewed changes

docs/en/reference/basic-mapping.rst Outdated Show resolved Hide resolved

greg0ire reviewed Mar 2, 2022

View reviewed changes

ThomasLandauer and others added 11 commits March 3, 2022 12:58

Adding PHP attributes

2f7c73a

This is the first (small) step towards documenting enums - see doctrine#9304 (comment) I started reading the page from the top, and did some minor changes. Biggest change: If you agree, I'd continue adding php attributes to all code blocks.

Update docs/en/reference/basic-mapping.rst

9a0f32a

Co-authored-by: Alexander M. Turek <me@derrabus.de>

Update basic-mapping.rst

77ee291

Update basic-mapping.rst

ede5055

Update basic-mapping.rst

0e4b577

Update basic-mapping.rst

a303cc8

Update docs/en/reference/basic-mapping.rst

208e284

Co-authored-by: Alexander M. Turek <me@derrabus.de>

Update docs/en/reference/basic-mapping.rst

2dfffd0

Co-authored-by: Alexander M. Turek <me@derrabus.de>

Update docs/en/reference/basic-mapping.rst

4ef8d07

Co-authored-by: Alexander M. Turek <me@derrabus.de>

Adding missing use Doctrine\ORM\Mapping\Table; and ` use Doctrine\O…

d116f60

…RM\Mapping\Column;`

Adding another use

9e986bb

ThomasLandauer force-pushed the patch-5 branch from 07c073d to 9e986bb Compare March 3, 2022 11:59

Adding versionadded

c1af52a

SenseException requested changes Mar 4, 2022

View reviewed changes

docs/en/reference/basic-mapping.rst Show resolved Hide resolved

docs/en/reference/basic-mapping.rst Outdated Show resolved Hide resolved

ThomasLandauer and others added 2 commits March 6, 2022 21:35

Update docs/en/reference/basic-mapping.rst

01deae2

Co-authored-by: Claudio Zizza <859964+SenseException@users.noreply.github.com>

Update docs/en/reference/basic-mapping.rst

ba73be1

Co-authored-by: Claudio Zizza <859964+SenseException@users.noreply.github.com>

SenseException approved these changes Mar 7, 2022

View reviewed changes

derrabus approved these changes Mar 8, 2022

View reviewed changes

derrabus added this to the 2.11.2 milestone Mar 8, 2022

derrabus merged commit eb1d548 into doctrine:2.11.x Mar 8, 2022

ThomasLandauer deleted the patch-5 branch March 8, 2022 10:23

github-actions bot mentioned this pull request Mar 9, 2022

Merge release 2.11.2 into 2.12.x #9576

Merged

derrabus added a commit that referenced this pull request Mar 9, 2022

Merge branch '2.11.x' into 2.12.x

56e88ed

* 2.11.x: Make sure MemcachedAdapter is supported before tring to use it (#9574) Fixing `:doc:` link (#9569) Adding PHP attributes (#9555) Remove reference to removed class

ThomasLandauer mentioned this pull request Jan 3, 2023

Docs: Moving *attributes* mapping to first position #10364

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding PHP attributes #9555

Adding PHP attributes #9555

ThomasLandauer commented Mar 2, 2022

derrabus commented Mar 2, 2022 •

edited

ThomasLandauer commented Mar 2, 2022

ThomasLandauer commented Mar 2, 2022

ThomasLandauer commented Mar 2, 2022

greg0ire commented Mar 2, 2022

greg0ire Mar 2, 2022

ThomasLandauer Mar 2, 2022

greg0ire Mar 2, 2022

ThomasLandauer Mar 3, 2022

greg0ire Mar 3, 2022

ThomasLandauer Mar 3, 2022

SenseException commented Mar 3, 2022

ThomasLandauer commented Mar 3, 2022

Adding PHP attributes #9555

Adding PHP attributes #9555

Conversation

ThomasLandauer commented Mar 2, 2022

derrabus commented Mar 2, 2022 • edited

ThomasLandauer commented Mar 2, 2022

ThomasLandauer commented Mar 2, 2022

ThomasLandauer commented Mar 2, 2022

greg0ire commented Mar 2, 2022

greg0ire Mar 2, 2022

Choose a reason for hiding this comment

ThomasLandauer Mar 2, 2022

Choose a reason for hiding this comment

greg0ire Mar 2, 2022

Choose a reason for hiding this comment

ThomasLandauer Mar 3, 2022

Choose a reason for hiding this comment

greg0ire Mar 3, 2022

Choose a reason for hiding this comment

ThomasLandauer Mar 3, 2022

Choose a reason for hiding this comment

SenseException commented Mar 3, 2022

ThomasLandauer commented Mar 3, 2022

derrabus commented Mar 2, 2022 •

edited