Skip to content

[PropertyInfo] Added documentation about camelCase assumption for getter/setter methods #18942

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 4, 2023
Merged

[PropertyInfo] Added documentation about camelCase assumption for getter/setter methods #18942

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion components/property_info.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,14 @@ provide whether properties are readable or writable as booleans::
The :class:`Symfony\\Component\\PropertyInfo\\Extractor\\ReflectionExtractor` looks
for getter/isser/setter/hasser method in addition to whether or not a property is public
to determine if it's accessible. This based on how the :doc:`PropertyAccess </components/property_access>`
works.
works. It assumes camel case style method names following `PSR-1`_. Therefore, a property like ``myProperty`` or ``my_property`` is
readable if it has a ``getMyProperty()`` and writable if it has a ``setMyProperty()`` method.

.. versionadded:: 6.4

Camel case style setter methods for properties in snake case (like ``my_property``) are accepted since Symfony 6.4. Before, the
setter name had to contain the underscores (e.g. `setMy_property()`) to make the property assumed writable.


.. _property-info-initializable:

Expand Down Expand Up @@ -552,6 +559,7 @@ service by defining it as a service with one or more of the following
* ``property_info.initializable_extractor`` if it provides initializable information
(it checks if a property can be initialized through the constructor).

.. _`PSR-1`: https://www.php-fig.org/psr/psr-1/
.. _`phpDocumentor Reflection`: https://github.com/phpDocumentor/ReflectionDocBlock
.. _`phpdocumentor/reflection-docblock`: https://packagist.org/packages/phpdocumentor/reflection-docblock
.. _`phpstan/phpdoc-parser`: https://packagist.org/packages/phpstan/phpdoc-parser
Expand Down