Override the createFromPath static method for a simple open mode on Reader #266
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
nyamsprod
reviewed
Oct 12, 2017
| @@ -62,6 +62,14 @@ class Reader extends AbstractCsv implements Countable, IteratorAggregate, JsonSe | |||
| protected $stream_filter_mode = STREAM_FILTER_READ; | |||
|
|
|||
| /** | |||
| * @inheritdoc | |||
| */ | |||
| public static function createFromPath(string $path, string $open_mode = 'r', $context = null): AbstractCsv | |||
There was a problem hiding this comment.
This introduces a tiny BC break you can't just correct it like
There was a problem hiding this comment.
Since you'd mentioned this would potentially go in a 10.0 release (which is likely to be atleast a year away), I approached it with that in mind. Is there another way I should approach this PR?
There was a problem hiding this comment.
The return type-hint here is wrong. You're returning new static so the return type should be Reader. While upgrading from 9.0.1 to 9.1.2 I started getting errors like these from Phan:
app/Legacy/Console/Commands/AbstractCsvImportCommand.php:77 PhanUndeclaredMethod Call to undeclared method \League\Csv\AbstractCsv::setHeaderOffset
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.
Introduction
I actually got bit by the readonly issue that is described in #258 And figured I'd give a shot at how to fix the issue.
Proposal
I introduce a new static method in reader where the default open mode is 'r'. I also added a test to ensure this works by adding a readonly csv file.
Describe the new/upated/fixed feature
I override the static function
createFromPathprovided by AbstractCsv to set the default open mode.Backward Incompatible Changes
There shouldn't be a BC issue.
Targeted release version
Could be 9.0, 10.0, up to you. This is my first time writing a PR for a PHP library like this so its very much a learning experience for me 😄
PR Impact
I don't think there should be a PR impact.
Open issues
#258