Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs for getErrorMessagesIndexedByAttribute - array keys must be strings #676

Merged
merged 1 commit into from
Mar 26, 2024

Conversation

arogachev
Copy link
Contributor

#669 was merged incorrectly.

Copy link

what-the-diff bot commented Mar 26, 2024

PR Summary

  • Updated Error Documentation
    The section in the guide referencing error handling was improved to help developers understand and manage errors more effectively. The following changes were made:
    • Clarified the necessity of using string attribute names with Each.
    • Supplied an example of the InvalidArgumentException that occurs when non-string keys are used for top-level attributes.
    • Illustrated a valid use-case of an array with string keys in conjunction with the Each rule.
    • Enhanced explanation on indexed error messages by path and offered an alternative method for custom separators.
    • Included a guide on how to access the original, unaltered list of error objects.
    • Defined the data content in each error object.
    • Highlighted the omission of a built-in feature to generate a nested tree of error messages.
    • Refreshed the reference link to tips about using keys with separators or shortcuts. This enhances the overall understanding of error handling in different scenarios.

@arogachev arogachev merged commit d9a7bf7 into 1.x Mar 26, 2024
2 checks passed
@arogachev arogachev deleted the update-result-docs-2 branch March 26, 2024 13:01
arogachev added a commit that referenced this pull request May 23, 2024
* update irc link (#663)

* update docs folder link (#666)

* Add methods `addErrorWithFormatOnly()` and `addErrorWithoutPostProcessing()` to `Result` object (#665)

* Clarify psalm types in `Result` (#668)

* Update result docs (#676)

* Add `Image` validation rule (#670)

Co-authored-by: Alexey Rogachev <arogachev90@gmail.com>
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>

* Add missed params to `Image` rule options (#680)

* Add date rules (#678)

Co-authored-by: Alexander Makarov <sam@rmcreative.ru>

* Add aspect ratio support to `Image` rule (#681)

* Add aspect ratio support to `Image` rule

* Apply fixes from StyleCI

* Code coverage, mutants

* Add detailed test cases' descriptions in data providers

* Change placeholders

* Work with options

* Work with options 2

* More configuration checks

* Fix logic, add PHPDoc

* Use value object for aspect ratio

* Actualize fix for mutant for absolute margin

* Fix error messages

* Fix new mutants

* Update src/Rule/Image/ImageAspectRatio.php

Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>

* Do not use dedicated container in tests, fix last mutant

---------

Co-authored-by: StyleCI Bot <bot@styleci.io>
Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>

* Release version 1.3.0

* Prepare for next release

* Update guides in english and Translate guides into Brazilian Portuguese  (#691)

* Add `Result::add()` method for merging other results to the base one (#686)

* Add `Result::add()` method for merging other results to the base one

* Apply fixes from StyleCI

* Update PR template [skip ci]

* Update src/Result.php

Co-authored-by: Alexander Makarov <sam@rmcreative.ru>

---------

Co-authored-by: StyleCI Bot <bot@styleci.io>
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>

* Add type rules and `Any` rule (#692)

* Add type rules and handlers

* Apply fixes from StyleCI

* Mention in the docs + basic tests

* Apply fixes from StyleCI

* Fix copy paste [skip ci]

* Test error message

* Update changelog [skip ci]

* Update PHPDoc [skip ci]

* More tests and descriptions

* Apply fixes from StyleCI

* Include type in error message

* Add Any rule

* Apply fixes from StyleCI

* Update changelog [skip ci]

* Note [skip ci]

* Add translations [skip ci]

* Fix tests

* Test attributes

* Extract PHP >= 8.1 specific tests

* Apply fixes from StyleCI

* Extract PHP >= 8.1 specific tests 2

* Fix mutant

* Update CHANGELOG.md

Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>

* Rename Any to AnyRule (review)

---------

Co-authored-by: StyleCI Bot <bot@styleci.io>
Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>

* Rename `Any` rule in docs (#699)

* Rename AnyHandler (remaining occurence) (#701)

* Add methods for getting first error messages to `Result` (#697)

* Add methods for getting first error messages to `Result`

* Bump coverage

* Update src/Result.php

Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>

* Update src/Result.php

Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>

* Apply fixes from StyleCI

* Remove newline [skip ci]

* Add changelog entry [skip ci]

---------

Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>
Co-authored-by: StyleCI Bot <bot@styleci.io>

* Translate Each rule docs into Russian (#688)

* Add `Unique` rule (#695)

* Add Unique rule

* Apply fixes from StyleCI

* More tests, messages [WIP]

* Apply fixes from StyleCI

* Test traslated attributes

* Test using as attribute

* Ready for review

* Apply fixes from StyleCI

* Update src/Rule/UniqueHandler.php

Co-authored-by: Dmitriy Derepko <xepozz@list.ru>

* Apply fixes from StyleCI

* Slightly different approach

* Apply fixes from StyleCI

* New test case to check strict equality

* Different approach

* Minor adjustments

* Remove comma, rename

* Update changelog [skip ci]

---------

Co-authored-by: StyleCI Bot <bot@styleci.io>
Co-authored-by: Dmitriy Derepko <xepozz@list.ru>
Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>

* Fix typo in array shape (#705)

* Fix docs, translate brazilian portuguese (#708)

Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>

* Release version 1.4.0

* Prepare for next release

* Merge fixes

---------

Co-authored-by: Ihor Sychevskyi <arhell333@gmail.com>
Co-authored-by: Alexey Rogachev <arogachev90@gmail.com>
Co-authored-by: Alexander Makarov <sam@rmcreative.ru>
Co-authored-by: StyleCI Bot <bot@styleci.io>
Co-authored-by: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Co-authored-by: Danil Arduanov <rylezz@gmail.com>
Co-authored-by: Dmitriy Derepko <xepozz@list.ru>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant