Skip to content

[PropertyInfo] Introduce PropertyDocBlockExtractorInterface #19214

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
Dec 7, 2023
Merged

[PropertyInfo] Introduce PropertyDocBlockExtractorInterface #19214

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
26 changes: 26 additions & 0 deletions components/property_info.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,26 @@ for a property::

See :ref:`components-property-info-type` for info about the ``Type`` class.

Documentation Block
~~~~~~~~~~~~~~~~~~~

Extractors that implement :class:`Symfony\\Component\\PropertyInfo\\PropertyDocBlockExtractorInterface`
can provide the full documentation block for a property as a string::

$docBlock = $propertyInfo->getDocBlock($class, $property);
/*
Example Result
--------------
string(79):
This is the subsequent paragraph in the DocComment.
It can span multiple lines.
*/

.. versionadded:: 7.1

The :class:`Symfony\\Component\\PropertyInfo\\PropertyDocBlockExtractorInterface``
interface was introduced in Symfony 7.1.

.. _property-info-description:

Description Information
Expand Down Expand Up @@ -413,6 +433,12 @@ library is present::
// Description information.
$phpDocExtractor->getShortDescription($class, $property);
$phpDocExtractor->getLongDescription($class, $property);
$phpDocExtractor->getDocBlock($class, $property);

.. versionadded:: 7.1

The :method:`Symfony\\Component\\PropertyInfo\\Extractor\\PhpDocExtractor::getDocBlock``
method was introduced in Symfony 7.1.

PhpStanExtractor
~~~~~~~~~~~~~~~~
Expand Down