Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.3k
updated PropertyAccess docs for PR 30536#11156
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
24 changes: 24 additions & 0 deletionscomponents/property_access.rst
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -168,6 +168,30 @@ getters, this means that you can do something like this:: | ||
| This will produce: ``He is an author`` | ||
| Accessing a non existing property path | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
wuestkamp marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| By default a :class:`Symfony\\Component\\PropertyAccess\\Exception\\NoSuchPropertyException` is thrown if the property path passed to :method:`PropertyAccessor::getValue<Symfony\\Component\\PropertyAccess\\PropertyAccessor::getValue>` | ||
| does not exist. | ||
| You can change this behaviour using the :method:`Symfony\\Component\\PropertyAccess\\PropertyAccessorBuilder::disableExceptionOnInvalidPropertyPath` | ||
| method:: | ||
| // ... | ||
| $propertyAccessor = PropertyAccess::createPropertyAccessorBuilder() | ||
| ->disableExceptionOnInvalidPropertyPath() | ||
| ->getPropertyAccessor(); | ||
| class Person | ||
| { | ||
| public $name; | ||
| } | ||
| $person = new Person(); | ||
| // instead of throwing an exception the following code returns null | ||
| $value = $propertyAccessor->getValue($person, 'birthday'); | ||
| Magic ``__get()`` Method | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
13 changes: 13 additions & 0 deletionsreference/configuration/framework.rst
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -107,6 +107,7 @@ Configuration | ||
| * `magic_call`_ | ||
| * `throw_exception_on_invalid_index`_ | ||
| * `throw_exception_on_invalid_property_path`_ | ||
| * `property_info`_ | ||
| @@ -1726,6 +1727,18 @@ throw_exception_on_invalid_index | ||
| When enabled, the ``property_accessor`` service throws an exception when you | ||
| try to access an invalid index of an array. | ||
| throw_exception_on_invalid_property_path | ||
| ........................................ | ||
| **type**: ``boolean`` **default**: ``true`` | ||
wuestkamp marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| .. versionadded:: 4.3 | ||
| The ``throw_exception_on_invalid_property_path`` option was introduced in Symfony 4.3. | ||
| When enabled, the ``property_accessor`` service throws an exception when you | ||
| try to access an invalid property path of an object. | ||
| property_info | ||
| ~~~~~~~~~~~~~ | ||
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.