{"action":"created","comment":{"url":"https://api.github.com/repos/symfony/symfony-docs/pulls/comments/41648864","id":41648864,"diff_hunk":"@@ -0,0 +1,295 @@\n+.. index::\n+    single: PropertyInfo\n+    single: Components; PropertInfo\n+\n+The PropertyInfo Component\n+==========================\n+\n+    The PropertyInfo component extracts information about PHP class' properties\n+    using metadata of popular sources.\n+\n+The PropertyInfo component is able to extract the following information:\n+\n+* List of properties exposed by a class\n+* Types of a property\n+* It's short and long DockBlock description\n+* If the property is readable or writable\n+\n+To do so, the component use extractors. It natively support the following\n+metadata sources:\n+\n+* ``ReflectionExtractor``: use the PHP Reflection API (setter type hint,\n+  return and scalar type hint for PHP 7+, accessor methods)\n+* ``PhpDocExtractor``: use the PHPDoc of properties and accessor methods\n+* ``DoctrineExtractor``: use metadata provided by the Doctrine ORM\n+* ``SerializerExtractor``: use groups metadata of the Serializer component\n+\n+Custom extractors can be also be registered.\n+\n+Installation\n+------------\n+\n+You can install the component in 2 different ways:\n+\n+* :doc:`Install it via Composer </components/using_components>` (``symfony/property-info``\n+  on `Packagist`_);\n+* Use the official Git repository (https://github.com/symfony/PropertyInfo).\n+\n+.. include:: /components/require_autoload.rst.inc\n+\n+To use the :class:`Symfony\\\\Component\\\\PropertyInfo\\\\Extractor\\\\PhpDocExtractor`,\n+install `phpDocumentator Reflection`_.\n+To use the :class:`Symfony\\\\Component\\\\PropertyInfo\\\\Extractor\\\\SerializerExtractor`\n+extractor, install the :doc:`Serializer component </components/serializer>`.\n+To use the :class:`Symfony\\\\Bridge\\\\Doctrine\\\\PropertyInfo\\\\DoctrineExtractor`,","path":"components/property_info.rst","position":44,"original_position":44,"commit_id":"dfa5c45f4efd6ee5443742bffe601a98ac9b7af3","original_commit_id":"dfa5c45f4efd6ee5443742bffe601a98ac9b7af3","user":{"login":"WouterJ","id":749025,"avatar_url":"https://avatars.githubusercontent.com/u/749025?v=3","gravatar_id":"","url":"https://api.github.com/users/WouterJ","html_url":"https://github.com/WouterJ","followers_url":"https://api.github.com/users/WouterJ/followers","following_url":"https://api.github.com/users/WouterJ/following{/other_user}","gists_url":"https://api.github.com/users/WouterJ/gists{/gist_id}","starred_url":"https://api.github.com/users/WouterJ/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/WouterJ/subscriptions","organizations_url":"https://api.github.com/users/WouterJ/orgs","repos_url":"https://api.github.com/users/WouterJ/repos","events_url":"https://api.github.com/users/WouterJ/events{/privacy}","received_events_url":"https://api.github.com/users/WouterJ/received_events","type":"User","site_admin":false},"body":"this will be rendered as one paragraph with 3 sentences, all looking like \"To use the ...Extractor extractor, install the ... component\", which I find a not so nice to read paragraph (it breaks to read flow).\r\n\r\nA common practice is to document additional dependencies in the related sections in a note directive. For instance, in the \"DoctrineExtractor\" section, put something like:\r\n```rst\r\n.. note::\r\n\r\n    You must install the Doctrine Bridge and the Doctrine ORM to be able\r\n    to use this extractor. You can install them by running\r\n    ``composer require doctrine/orm symfony/doctrine-bridge``.\r\n```","created_at":"2015-10-09T16:20:01Z","updated_at":"2015-10-09T16:20:01Z","html_url":"https://github.com/symfony/symfony-docs/pull/5717#discussion_r41648864","pull_request_url":"https://api.github.com/repos/symfony/symfony-docs/pulls/5717","_links":{"self":{"href":"https://api.github.com/repos/symfony/symfony-docs/pulls/comments/41648864"},"html":{"href":"https://github.com/symfony/symfony-docs/pull/5717#discussion_r41648864"},"pull_request":{"href":"https://api.github.com/repos/symfony/symfony-docs/pulls/5717"}}},"pull_request":{"url":"https://api.github.com/repos/symfony/symfony-docs/pulls/5717","id":45676672,"html_url":"https://github.com/symfony/symfony-docs/pull/5717","diff_url":"https://github.com/symfony/symfony-docs/pull/5717.diff","patch_url":"https://github.com/symfony/symfony-docs/pull/5717.patch","issue_url":"https://api.github.com/repos/symfony/symfony-docs/issues/5717","number":5717,"state":"open","locked":false,"title":"[PropertyInfo] Add the doc","user":{"login":"dunglas","id":57224,"avatar_url":"https://avatars.githubusercontent.com/u/57224?v=3","gravatar_id":"","url":"https://api.github.com/users/dunglas","html_url":"https://github.com/dunglas","followers_url":"https://api.github.com/users/dunglas/followers","following_url":"https://api.github.com/users/dunglas/following{/other_user}","gists_url":"https://api.github.com/users/dunglas/gists{/gist_id}","starred_url":"https://api.github.com/users/dunglas/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dunglas/subscriptions","organizations_url":"https://api.github.com/users/dunglas/orgs","repos_url":"https://api.github.com/users/dunglas/repos","events_url":"https://api.github.com/users/dunglas/events{/privacy}","received_events_url":"https://api.github.com/users/dunglas/received_events","type":"User","site_admin":false},"body":"| Q             | A\r\n| ------------- | ---\r\n| Doc fix?      | no\r\n| New docs?     | yes (symfony/symfony#15858)\r\n| Applies to    | 2.8, 3.0\r\n| Fixed tickets | n/a","created_at":"2015-09-22T15:18:24Z","updated_at":"2015-10-09T16:20:01Z","closed_at":null,"merged_at":null,"merge_commit_sha":"8d16e2b3be06918ece8b831c51ab7f31b305a5c2","assignee":null,"milestone":{"url":"https://api.github.com/repos/symfony/symfony-docs/milestones/10","html_url":"https://github.com/symfony/symfony-docs/milestones/2.8","labels_url":"https://api.github.com/repos/symfony/symfony-docs/milestones/10/labels","id":1105130,"number":10,"title":"2.8","description":"","creator":{"login":"WouterJ","id":749025,"avatar_url":"https://avatars.githubusercontent.com/u/749025?v=3","gravatar_id":"","url":"https://api.github.com/users/WouterJ","html_url":"https://github.com/WouterJ","followers_url":"https://api.github.com/users/WouterJ/followers","following_url":"https://api.github.com/users/WouterJ/following{/other_user}","gists_url":"https://api.github.com/users/WouterJ/gists{/gist_id}","starred_url":"https://api.github.com/users/WouterJ/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/WouterJ/subscriptions","organizations_url":"https://api.github.com/users/WouterJ/orgs","repos_url":"https://api.github.com/users/WouterJ/repos","events_url":"https://api.github.com/users/WouterJ/events{/privacy}","received_events_url":"https://api.github.com/users/WouterJ/received_events","type":"User","site_admin":false},"open_issues":17,"closed_issues":4,"state":"open","created_at":"2015-05-11T15:57:59Z","updated_at":"2015-10-08T13:10:26Z","due_on":null,"closed_at":null},"commits_url":"https://api.github.com/repos/symfony/symfony-docs/pulls/5717/commits","review_comments_url":"https://api.github.com/repos/symfony/symfony-docs/pulls/5717/comments","review_comment_url":"https://api.github.com/repos/symfony/symfony-docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/symfony/symfony-docs/issues/5717/comments","statuses_url":"https://api.github.com/repos/symfony/symfony-docs/statuses/dfa5c45f4efd6ee5443742bffe601a98ac9b7af3","head":{"label":"dunglas:propertyinfo","ref":"propertyinfo","sha":"dfa5c45f4efd6ee5443742bffe601a98ac9b7af3","user":{"login":"dunglas","id":57224,"avatar_url":"https://avatars.githubusercontent.com/u/57224?v=3","gravatar_id":"","url":"https://api.github.com/users/dunglas","html_url":"https://github.com/dunglas","followers_url":"https://api.github.com/users/dunglas/followers","following_url":"https://api.github.com/users/dunglas/following{/other_user}","gists_url":"https://api.github.com/users/dunglas/gists{/gist_id}","starred_url":"https://api.github.com/users/dunglas/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dunglas/subscriptions","organizations_url":"https://api.github.com/users/dunglas/orgs","repos_url":"https://api.github.com/users/dunglas/repos","events_url":"https://api.github.com/users/dunglas/events{/privacy}","received_events_url":"https://api.github.com/users/dunglas/received_events","type":"User","site_admin":false},"repo":{"id":12387477,"name":"symfony-docs","full_name":"dunglas/symfony-docs","owner":{"login":"dunglas","id":57224,"avatar_url":"https://avatars.githubusercontent.com/u/57224?v=3","gravatar_id":"","url":"https://api.github.com/users/dunglas","html_url":"https://github.com/dunglas","followers_url":"https://api.github.com/users/dunglas/followers","following_url":"https://api.github.com/users/dunglas/following{/other_user}","gists_url":"https://api.github.com/users/dunglas/gists{/gist_id}","starred_url":"https://api.github.com/users/dunglas/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dunglas/subscriptions","organizations_url":"https://api.github.com/users/dunglas/orgs","repos_url":"https://api.github.com/users/dunglas/repos","events_url":"https://api.github.com/users/dunglas/events{/privacy}","received_events_url":"https://api.github.com/users/dunglas/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/dunglas/symfony-docs","description":"The Symfony2 documentation","fork":true,"url":"https://api.github.com/repos/dunglas/symfony-docs","forks_url":"https://api.github.com/repos/dunglas/symfony-docs/forks","keys_url":"https://api.github.com/repos/dunglas/symfony-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dunglas/symfony-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dunglas/symfony-docs/teams","hooks_url":"https://api.github.com/repos/dunglas/symfony-docs/hooks","issue_events_url":"https://api.github.com/repos/dunglas/symfony-docs/issues/events{/number}","events_url":"https://api.github.com/repos/dunglas/symfony-docs/events","assignees_url":"https://api.github.com/repos/dunglas/symfony-docs/assignees{/user}","branches_url":"https://api.github.com/repos/dunglas/symfony-docs/branches{/branch}","tags_url":"https://api.github.com/repos/dunglas/symfony-docs/tags","blobs_url":"https://api.github.com/repos/dunglas/symfony-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dunglas/symfony-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dunglas/symfony-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/dunglas/symfony-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dunglas/symfony-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/dunglas/symfony-docs/languages","stargazers_url":"https://api.github.com/repos/dunglas/symfony-docs/stargazers","contributors_url":"https://api.github.com/repos/dunglas/symfony-docs/contributors","subscribers_url":"https://api.github.com/repos/dunglas/symfony-docs/subscribers","subscription_url":"https://api.github.com/repos/dunglas/symfony-docs/subscription","commits_url":"https://api.github.com/repos/dunglas/symfony-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/dunglas/symfony-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/dunglas/symfony-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/dunglas/symfony-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/dunglas/symfony-docs/contents/{+path}","compare_url":"https://api.github.com/repos/dunglas/symfony-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dunglas/symfony-docs/merges","archive_url":"https://api.github.com/repos/dunglas/symfony-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dunglas/symfony-docs/downloads","issues_url":"https://api.github.com/repos/dunglas/symfony-docs/issues{/number}","pulls_url":"https://api.github.com/repos/dunglas/symfony-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/dunglas/symfony-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/dunglas/symfony-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dunglas/symfony-docs/labels{/name}","releases_url":"https://api.github.com/repos/dunglas/symfony-docs/releases{/id}","created_at":"2013-08-26T19:13:29Z","updated_at":"2014-03-24T18:55:29Z","pushed_at":"2015-10-06T20:18:33Z","git_url":"git://github.com/dunglas/symfony-docs.git","ssh_url":"git@github.com:dunglas/symfony-docs.git","clone_url":"https://github.com/dunglas/symfony-docs.git","svn_url":"https://github.com/dunglas/symfony-docs","homepage":"http://symfony.com/doc/current/","size":31502,"stargazers_count":0,"watchers_count":0,"language":"Lasso","has_issues":false,"has_downloads":false,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"symfony:2.8","ref":"2.8","sha":"de141d51968f51e703cb1574d13628d80fb0cded","user":{"login":"symfony","id":143937,"avatar_url":"https://avatars.githubusercontent.com/u/143937?v=3","gravatar_id":"","url":"https://api.github.com/users/symfony","html_url":"https://github.com/symfony","followers_url":"https://api.github.com/users/symfony/followers","following_url":"https://api.github.com/users/symfony/following{/other_user}","gists_url":"https://api.github.com/users/symfony/gists{/gist_id}","starred_url":"https://api.github.com/users/symfony/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/symfony/subscriptions","organizations_url":"https://api.github.com/users/symfony/orgs","repos_url":"https://api.github.com/users/symfony/repos","events_url":"https://api.github.com/users/symfony/events{/privacy}","received_events_url":"https://api.github.com/users/symfony/received_events","type":"Organization","site_admin":false},"repo":{"id":521583,"name":"symfony-docs","full_name":"symfony/symfony-docs","owner":{"login":"symfony","id":143937,"avatar_url":"https://avatars.githubusercontent.com/u/143937?v=3","gravatar_id":"","url":"https://api.github.com/users/symfony","html_url":"https://github.com/symfony","followers_url":"https://api.github.com/users/symfony/followers","following_url":"https://api.github.com/users/symfony/following{/other_user}","gists_url":"https://api.github.com/users/symfony/gists{/gist_id}","starred_url":"https://api.github.com/users/symfony/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/symfony/subscriptions","organizations_url":"https://api.github.com/users/symfony/orgs","repos_url":"https://api.github.com/users/symfony/repos","events_url":"https://api.github.com/users/symfony/events{/privacy}","received_events_url":"https://api.github.com/users/symfony/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/symfony/symfony-docs","description":"The Symfony documentation","fork":false,"url":"https://api.github.com/repos/symfony/symfony-docs","forks_url":"https://api.github.com/repos/symfony/symfony-docs/forks","keys_url":"https://api.github.com/repos/symfony/symfony-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/symfony/symfony-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/symfony/symfony-docs/teams","hooks_url":"https://api.github.com/repos/symfony/symfony-docs/hooks","issue_events_url":"https://api.github.com/repos/symfony/symfony-docs/issues/events{/number}","events_url":"https://api.github.com/repos/symfony/symfony-docs/events","assignees_url":"https://api.github.com/repos/symfony/symfony-docs/assignees{/user}","branches_url":"https://api.github.com/repos/symfony/symfony-docs/branches{/branch}","tags_url":"https://api.github.com/repos/symfony/symfony-docs/tags","blobs_url":"https://api.github.com/repos/symfony/symfony-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/symfony/symfony-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/symfony/symfony-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/symfony/symfony-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/symfony/symfony-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/symfony/symfony-docs/languages","stargazers_url":"https://api.github.com/repos/symfony/symfony-docs/stargazers","contributors_url":"https://api.github.com/repos/symfony/symfony-docs/contributors","subscribers_url":"https://api.github.com/repos/symfony/symfony-docs/subscribers","subscription_url":"https://api.github.com/repos/symfony/symfony-docs/subscription","commits_url":"https://api.github.com/repos/symfony/symfony-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/symfony/symfony-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/symfony/symfony-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/symfony/symfony-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/symfony/symfony-docs/contents/{+path}","compare_url":"https://api.github.com/repos/symfony/symfony-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/symfony/symfony-docs/merges","archive_url":"https://api.github.com/repos/symfony/symfony-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/symfony/symfony-docs/downloads","issues_url":"https://api.github.com/repos/symfony/symfony-docs/issues{/number}","pulls_url":"https://api.github.com/repos/symfony/symfony-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/symfony/symfony-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/symfony/symfony-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/symfony/symfony-docs/labels{/name}","releases_url":"https://api.github.com/repos/symfony/symfony-docs/releases{/id}","created_at":"2010-02-17T08:43:51Z","updated_at":"2015-10-08T12:01:30Z","pushed_at":"2015-10-09T08:17:43Z","git_url":"git://github.com/symfony/symfony-docs.git","ssh_url":"git@github.com:symfony/symfony-docs.git","clone_url":"https://github.com/symfony/symfony-docs.git","svn_url":"https://github.com/symfony/symfony-docs","homepage":"http://symfony.com/doc","size":63670,"stargazers_count":1035,"watchers_count":1035,"language":"C++","has_issues":true,"has_downloads":false,"has_wiki":false,"has_pages":false,"forks_count":2035,"mirror_url":null,"open_issues_count":288,"forks":2035,"open_issues":288,"watchers":1035,"default_branch":"2.8"}},"_links":{"self":{"href":"https://api.github.com/repos/symfony/symfony-docs/pulls/5717"},"html":{"href":"https://github.com/symfony/symfony-docs/pull/5717"},"issue":{"href":"https://api.github.com/repos/symfony/symfony-docs/issues/5717"},"comments":{"href":"https://api.github.com/repos/symfony/symfony-docs/issues/5717/comments"},"review_comments":{"href":"https://api.github.com/repos/symfony/symfony-docs/pulls/5717/comments"},"review_comment":{"href":"https://api.github.com/repos/symfony/symfony-docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/symfony/symfony-docs/pulls/5717/commits"},"statuses":{"href":"https://api.github.com/repos/symfony/symfony-docs/statuses/dfa5c45f4efd6ee5443742bffe601a98ac9b7af3"}}}}