Add the Label attribute

[dood-]

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	❌
Fixed issues	#633

[what-the-diff]

PR Summary

• Introduction of PHP Attribute for Property Labels

  • A new PHP attribute has been introduced to designate custom property labels, which can be used in error messages. This attribute is defined in the new Label class located in the Helper folder.

• Incorporation of Label Handling in Code

  • Label information is now fetched and stored during the parsing of objects with the updated ObjectParser.php file. Moreover, the labels are appropriately incorporated into error messages with the newly introduced setLabel and getAttributeLabel methods in the ValidationContext.php file.

• Implementation of LabelsProviderInterface in ObjectDataSet

  • The ObjectDataSet.php file has been updated to provide label information by implementing LabelsProviderInterface.

• Validator Update for Label Usage

  • The Validator.php file now checks if labels are available by examining if the DataSet implements LabelsProviderInterface. If available, these labels are set in the validation context.

• Testing of New Features

  • New tests have been added in the ObjectParserTest.php and ValidationContextTest.php files to ensure the correct operation of label fetching, storing, and usage.

• Guide Update

  • The configuring-rules-via-php-attributes.md guidance document has been updated with an example showcasing the use of the Label attribute for custom labels.

• Inclusion of New Interfaces and Classes

  • Introduction of the new LabelsProviderInterface, which defines the blueprint for classes that provide attribute labels.

• Label Demonstrations in Test Objects

  • The ObjectForTestingCache1.php and ObjectForTestingDisabledCache.php files now include examples of properties having Label attributes assigned.

All these changes seek to provide greater flexibility and configurability in error messages with the help of custom property labels.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (493a2d1) 94.45% compared to head (428c142) 94.49%.
Report is 3 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #643      +/-   ##
============================================
+ Coverage     94.45%   94.49%   +0.04%     
- Complexity      776      781       +5     
============================================
  Files            91       91              
  Lines          2361     2379      +18     
============================================
+ Hits           2230     2248      +18     
  Misses          131      131              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[vjik]

Need test when validated object implements LabelsProviderInterface with and without Label attributes usage.

[samdark]

👍 overall.

[samdark]

👍