Skip to content

Commit

Permalink
minor #2102 [TwigComponent] Add notice about needing `phpdocumentor/r…
Browse files Browse the repository at this point in the history
…eflection-docblock` (dejagersh)

This PR was squashed before being merged into the 2.x branch.

Discussion
----------

[TwigComponent] Add notice about needing `phpdocumentor/reflection-docblock`

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| Issues        | NA
| License       | MIT

This notice is present in this in section [Using DTO's on a LiveProp](https://symfony.com/bundles/ux-live-component/current/index.html#using-dto-s-on-a-liveprop) but not here: [LiveProp for Entities & More Complex Data](https://symfony.com/bundles/ux-live-component/current/index.html#liveprop-for-entities-more-complex-data)

<img width="485" alt="image" src="https://github.com/user-attachments/assets/e6eb388a-d740-42fc-9d15-d2d2f8ac005e">

This is where I personally ran into trouble. https://symfony-devs.slack.com/archives/C01FN4EQNLX/p1724839078396519

Commits
-------

746025a [TwigComponent] Add notice about needing `phpdocumentor/reflection-docblock`
  • Loading branch information
smnandre committed Sep 3, 2024
2 parents 5a0241f + 746025a commit 79b584f
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/LiveComponent/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -474,6 +474,13 @@ can read::
/** @var Product[] */
public $products = [];

Collection type extraction from the docblock requires the ``phpdocumentor/reflection-docblock``
library. Make sure it is installed in you application:

.. code-block:: terminal
$ composer require phpdocumentor/reflection-docblock
Writable Object Properties or Array Keys
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 79b584f

Please # to comment.