[PropertyAccess] Document usage of createPropertyAccessor args #6640
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Not sure that the failed test on travis is related. |
| .. caution:: | ||
|
|
||
| As you can see, the method will return ``null`` if the index does not exists. | ||
| To make it throws an exception in case of invalid index, set the first argument |
There was a problem hiding this comment.
-To make it throws
+ To make it throw(present infinitive)
eae275c to
5dfc8b2
Compare
| As you can see, the method will return ``null`` if the index does not exists. | ||
| To make it throw an exception in case of invalid index, set the first argument | ||
| :method:`PropertyAccess::createPropertyAccessor<Symfony\\Component\\PropertyAccess\\PropertyAccess::createPropertyAccessor()>` | ||
| to true, e.g. ``PropertyAccess::createPropertyAccessor(true)``. |
There was a problem hiding this comment.
Do you mean that I should wrap it in ```` chars? It's a mistake that I'll correct, thank's for catch it.
There was a problem hiding this comment.
thats what i meant, thank you!
a64bbc2 to
f65ad3a
Compare
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Jun 9, 2016
…ss::createPropertyAccessor() (chalasr) This PR was squashed before being merged into the 3.2-dev branch (closes #18977). Discussion ---------- [PropertyAccess] Add missing arguments to PropertyAccess::createPropertyAccessor() | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | symfony/symfony-docs#6640 Actually, the recommended way to use the PropertyAccessor is to use `PropertyAccess::createPropertyAccessor`. The problem is that using this way, we can't specify that invalid indexes should throw an exception, and so when calling `PropertyAccessor::isReadable([], '[foo]')` it returns always true. It should be possible to make the exception thrown, plus the `PropertyAccessor::$throwExceptionOnInvalidIndex` already exists but is not used in `PropertyAccess::createPropertyAccessor`. Commits ------- 5ded804 [PropertyAccess] Add missing arguments to PropertyAccess::createPropertyAccessor()
symfony-splitter
pushed a commit
to symfony/property-access
that referenced
this pull request
Jun 9, 2016
…ss::createPropertyAccessor() (chalasr) This PR was squashed before being merged into the 3.2-dev branch (closes #18977). Discussion ---------- [PropertyAccess] Add missing arguments to PropertyAccess::createPropertyAccessor() | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | symfony/symfony-docs#6640 Actually, the recommended way to use the PropertyAccessor is to use `PropertyAccess::createPropertyAccessor`. The problem is that using this way, we can't specify that invalid indexes should throw an exception, and so when calling `PropertyAccessor::isReadable([], '[foo]')` it returns always true. It should be possible to make the exception thrown, plus the `PropertyAccessor::$throwExceptionOnInvalidIndex` already exists but is not used in `PropertyAccess::createPropertyAccessor`. Commits ------- 5ded804 [PropertyAccess] Add missing arguments to PropertyAccess::createPropertyAccessor()
|
The related PR has been merged (symfony/symfony#18977). |
33357dd to
16738a5
Compare
|
Updated according to symfony/symfony#19040. |
Fix spelling typos Formatting/Spelling fixes Document features enabling from createPropertyAccessor() wording
16738a5 to
34bc5a6
Compare
|
Closing as symfony/symfony#18977 has been reverted. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This documents symfony/symfony#18977 (on hold).
Suggestions to make it better would be really appreciated.