[PropertyInfo] Add Component Documentation #5974

zanbaldwin · 2015-12-07T16:57:19Z

Q	A
Doc fix?	no
New docs?	yes (symfony/symfony#15858)
Applies to	`2.8`, `3.0`
Fixed tickets	N/A

This is still a work in progress, but I'd like feedback from anyone regarding structure, grammar and any other improvements while I continue. After speaking with @dunglas, I'm creating a new PR due our branches differing by about 400 commits.

zanbaldwin · 2015-12-07T22:48:08Z

components/property_info.rst

+to/from objects and arrays, the PropertyInfo component works solely with class definitions to provide information
+such as data type and visibility about properties within that class.
+
+Similar to PropertyAccess, the PropertyInfo component blurs the lines between class properties such as ``$property``


As pointed out by a friend in the Philippines, the idiom blurs the lines is not easily understood by non-native English speakers. Need to consider an alternative.

What about "works with both"?

…actor (zanderbaldwin) This PR was squashed before being merged into the 2.8 branch (closes #16911). Discussion ---------- [PropertyInfo] Update List Information from ReflectionExtractor | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #16889 | License | MIT | Doc PR | symfony/symfony-docs#5974 Unless a property with the same casing exists, lowercase the first letter of a property name extracted from a method. From what I understand, we don't actually need to support `snake_case` at all in the PropertyInfo component. I cannot think of any use-case where PropertyAccess would be used to get/set a property value *before* using PropertyInfo to find out information about the property and the values it supports. Since PropertyInfo supports the discovery of property names, which can then be used as identifiers in PropertyAccess, there should be no need to support a naming strategy to map property identifiers from one naming convention to another. --- Running `$reflectionExtractor->getProperties($class)` with the following classes: ```php class X { public $a; public $b; public function getA() {} } // Result: array('a', 'b'); ``` ```php class Y { public $A; public $b; public function setA() {} } // Result: array('A', 'b'); ``` ```php class Y { public $username; protected $emailAddress; public $password; public function getEmailAddress() {} public function isActive() {} } // Result: array('username', 'emailAddress', 'password', 'active'); ``` Commits ------- b2da76c [PropertyInfo] Update List Information from ReflectionExtractor

dunglas · 2015-12-15T07:08:23Z

components/property_info.rst

+such as data type and visibility about properties within that class.
+
+Similar to PropertyAccess, the PropertyInfo component blurs the lines between class properties such as ``$property``
+and properties defined via accessor and mutator methods such as  ``getProperty()``, ``isProperty()``, ``setProperty()``,


It is also able to leverage adders and removers.

This list of example method names is not illustrative. I think some actual examples would be better.

dunglas · 2015-12-15T07:16:34Z

Good job! I left some minor comments but 👍

zanbaldwin · 2015-12-15T10:54:49Z

Considering I failed English at school, the only language I can speak, thanks!
I'll try to finish this along with the edits within the next couple of days.

zanbaldwin · 2016-01-12T10:39:49Z

Back in Europe, finally have internet access, any comments on this so far? /cc @dunglas.

TomasVotruba · 2016-03-06T11:50:43Z

This looks good to me. Anything more that needs to be done?

zanbaldwin · 2016-03-06T12:44:36Z

The Creating Your Own Extractors section could possibly be expanded but I could never figure out how to word it :P

TomasVotruba · 2016-03-06T13:15:29Z

I think that might be next, advanced article.

I'd add just this simple "How to use this" version. It's really missed at the moment.

teohhanhui · 2016-03-22T08:08:33Z

components/property_info.rst

+The PropertyInfo component provides the functionality to get information about class properties using metadata of
+popular sources.
+
+Whilst the :doc:`PropertyAccess component</components/property_access/introduction>` allows you to read and write values


I see multiple occurrences of "whilst".

See http://dictionary.cambridge.org/grammar/british-grammar/while-and-whilst

I'll edit that now.

wouterj · 2016-07-08T17:03:29Z

Hi @zanderbaldwin!

I'm sorry that it took so long before one of us reviewed this PR. I think it's a nice start. Can you please fix the comments I added to this PR and make sure lines are wrapped after the first word that crosses the 72th character (they are a bit too long atm)? Thanks already!

If you don't have time, just comment and we'll continue this PR.

status: needs work

zanbaldwin · 2016-07-20T15:15:57Z

Hi guys, I've made the changes that were suggested. Does anyone have any other input?

dunglas · 2016-07-21T01:59:57Z

Looks good to me. You did a very good job documenting this component, thank you!

dunglas · 2016-08-16T11:24:40Z

@zanderbaldwin can you rebase your PR?

@xabbuh @wouterj @weaverryan can this PR be merged? It would be nice to have the doc for this component online.

zanbaldwin · 2016-08-16T11:35:13Z

Rebased, though you might want to check that I've solved all the conflicts correctly...

dunglas · 2016-08-16T11:40:50Z

components/property_info.rst

+    The PropertyInfo component provides the functionality to get information
+    about class properties using metadata of popular sources.
+
+While the :doc:`PropertyAccess component </components/property_access/introduction>`


The path should be updated to /components/property_info (it's why Travis fails)

* /components/property_access

zanbaldwin · 2016-08-16T12:05:38Z

Got the build working, would you like the 5 commits squashed into 1?

dunglas · 2016-08-16T12:13:36Z

Commits can be squashed by the merger.

Status: reviewed

@dunglas

This PR was merged into the 2.8 branch. Discussion ---------- [PropertyInfo] Add Component Documentation | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes (symfony/symfony#15858) | Applies to | `2.8`, `3.0` | Fixed tickets | N/A This is still a *work in progress*, but I'd like feedback from anyone regarding structure, grammar and any other improvements while I continue. After speaking with @dunglas, I'm creating a new PR due our branches differing by about 400 commits. Commits ------- a0409d7 Update Reference to Service Container Tags 78ea4a5 Update PropertyAccess Component Path 7b786af Fix Incorrect Indent 96b139b Suggested Changes cf7a0ea Add PropertyInfo Component Documentation

weaverryan · 2016-08-20T21:42:27Z

Merged! This is great! I was very much looking forward to the docs for this, but bootstrapping the docs for a new component is a lot of work :). So, thank you!

I opened #6896 with some proofreading tweaks that I'm making. I'll finish it shortly, but I just got interrupted :).

Cheers!

This PR was merged into the 2.8 branch. Discussion ---------- Tweaks to property info component Just proofreading and making some tweaks to #5974 Commits ------- c9ea21f bad link! fcf5e69 fixing indentation bf5188f final tweaks 7e296d8 [WIP] Tweaks to property info

zanbaldwin mentioned this pull request Dec 7, 2015

[DX] [PropertyInfo] Filter PropertyInfo Extractors with Interfaces symfony/symfony#16890

Closed

zanbaldwin reviewed Dec 7, 2015
View reviewed changes

zanbaldwin mentioned this pull request Dec 8, 2015

[PropertyInfo] Update List Information from ReflectionExtractor symfony/symfony#16911

Closed

dunglas reviewed Dec 15, 2015
View reviewed changes

wouterj mentioned this pull request Dec 19, 2015

Added the documentation of the PropertyInfo component #6047

Closed

zanbaldwin changed the title ~~(WIP) [PropertyInfo] Add Component Documentation~~ [PropertyInfo] Add Component Documentation Jan 22, 2016

teohhanhui reviewed Mar 22, 2016
View reviewed changes

carsonbot added the Status: Needs Work label Jul 8, 2016

Zander Baldwin and others added 3 commits August 16, 2016 12:32

Add PropertyInfo Component Documentation

cf7a0ea

Suggested Changes

96b139b

Fix Incorrect Indent

7b786af

dunglas reviewed Aug 16, 2016
View reviewed changes

zanbaldwin added 2 commits August 16, 2016 12:49

Update PropertyAccess Component Path

78ea4a5

Update Reference to Service Container Tags

a0409d7

carsonbot added Status: Reviewed and removed Status: Needs Work labels Aug 16, 2016

weaverryan merged commit a0409d7 into symfony:2.8 Aug 20, 2016

weaverryan mentioned this pull request Aug 20, 2016

Tweaks to property info component #6896

Merged

zanbaldwin deleted the feature/component-property-info branch October 4, 2017 14:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[PropertyInfo] Add Component Documentation #5974

[PropertyInfo] Add Component Documentation #5974

zanbaldwin commented Dec 7, 2015 •

edited

Loading

zanbaldwin Dec 7, 2015

teohhanhui Mar 22, 2016

dunglas Dec 15, 2015

teohhanhui Mar 22, 2016

dunglas commented Dec 15, 2015

zanbaldwin commented Dec 15, 2015

zanbaldwin commented Jan 12, 2016

TomasVotruba commented Mar 6, 2016

zanbaldwin commented Mar 6, 2016

TomasVotruba commented Mar 6, 2016

teohhanhui Mar 22, 2016

zanbaldwin Mar 22, 2016

wouterj commented Jul 8, 2016

zanbaldwin commented Jul 20, 2016

dunglas commented Jul 21, 2016

dunglas commented Aug 16, 2016

zanbaldwin commented Aug 16, 2016

dunglas Aug 16, 2016

teohhanhui Aug 16, 2016 •

edited

Loading

zanbaldwin commented Aug 16, 2016

dunglas commented Aug 16, 2016 •

edited

Loading

weaverryan commented Aug 20, 2016

[PropertyInfo] Add Component Documentation #5974

[PropertyInfo] Add Component Documentation #5974

Conversation

zanbaldwin commented Dec 7, 2015 • edited Loading

zanbaldwin Dec 7, 2015

Choose a reason for hiding this comment

teohhanhui Mar 22, 2016

Choose a reason for hiding this comment

dunglas Dec 15, 2015

Choose a reason for hiding this comment

teohhanhui Mar 22, 2016

Choose a reason for hiding this comment

dunglas commented Dec 15, 2015

zanbaldwin commented Dec 15, 2015

zanbaldwin commented Jan 12, 2016

TomasVotruba commented Mar 6, 2016

zanbaldwin commented Mar 6, 2016

TomasVotruba commented Mar 6, 2016

teohhanhui Mar 22, 2016

Choose a reason for hiding this comment

zanbaldwin Mar 22, 2016

Choose a reason for hiding this comment

wouterj commented Jul 8, 2016

zanbaldwin commented Jul 20, 2016

dunglas commented Jul 21, 2016

dunglas commented Aug 16, 2016

zanbaldwin commented Aug 16, 2016

dunglas Aug 16, 2016

Choose a reason for hiding this comment

teohhanhui Aug 16, 2016 • edited Loading

Choose a reason for hiding this comment

zanbaldwin commented Aug 16, 2016

dunglas commented Aug 16, 2016 • edited Loading

weaverryan commented Aug 20, 2016

zanbaldwin commented Dec 7, 2015 •

edited

Loading

teohhanhui Aug 16, 2016 •

edited

Loading

dunglas commented Aug 16, 2016 •

edited

Loading