API Add new deprecation notices. #10691
Merged
Conversation
This file contains 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
GuySartorelli
commented
Feb 14, 2023
Comment on lines
-118
to
+119
| Deprecation::notice('5.0', __CLASS__ . ' is deprecated, use ' . Reader::class . ' instead'); | ||
| Deprecation::notice('4.13.0', 'Use ' . Reader::class . ' instead', Deprecation::SCOPE_CLASS); |
There was a problem hiding this comment.
I'm explicitly not wrapping this one in Deprecation::withNoReplacement() because there are only a few instances of it in use in our code, and we can wrap those instead. This seems likely to be used pretty frequently in projects so it's good for their uses to pop up in the main deprecation notices.
GuySartorelli
commented
Feb 14, 2023
Comment on lines
-257
to
+261
| $csv = new CSVParser( | ||
| $filepath, | ||
| $this->delimiter, | ||
| $this->enclosure | ||
| ); | ||
| $delimiter = $this->delimiter; | ||
| $enclosure = $this->enclosure; | ||
| $csv = Deprecation::withNoReplacement(function () use ($filepath, $delimiter, $enclosure) { | ||
| return new CSVParser($filepath, $delimiter, $enclosure); | ||
| }); |
There was a problem hiding this comment.
This is the only usage of this class in our code that I could find.
Since this whole method is deprecated, it's easier to just wrap this instantiation than to replace it with the Reader class. It's gone in CMS 5 anyway.
emteknetnz
requested changes
Feb 14, 2023
tests/php/Dev/CSVParserTest.php
Outdated
| @@ -24,7 +25,10 @@ protected function setUp(): void | |||
| public function testParsingWithHeaders() | |||
| { | |||
| /* By default, a CSV file will be interpreted as having headers */ | |||
| $csv = new CSVParser($this->csvPath . 'PlayersWithHeader.csv'); | |||
| $filepath = $this->csvPath; | |||
There was a problem hiding this comment.
Instead of wrapping calls here, instead change setUp() to the following:
protected function setUp(): void
{
parent::setUp();
$this->csvPath = __DIR__ . '/CsvBulkLoaderTest/csv/';
if (Deprecation::isEnabled()) {
$this->markTestSkipped('Test calls deprecated code');
}
}
These are removed in CMS 5.
GuySartorelli
force-pushed
the
pulls/4/deprecations
branch
from
cca6c76 to
3b3f965
Compare
emteknetnz
approved these changes
Feb 15, 2023
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.
These are removed in CMS 5.
Note there have been so many new deprecations which we already haven't added to the CMS 4.13 changelog so there's no point manually adding this there, we're going to have to do some batch card to add all the ones we've missed anyway and we'll likely just automate that.
Parent issue