StorageInterface resolveStream nullable $fieldName #1373
Conversation
|
Other 2 functions (resolvePath and resolveUri) accept fieldName as nullable string. Why resolveStream function makes different? I think it like a mistake or misstype. If you have one "uploadable" field per entity - you have to pass field name every time only on this function. |
| * @param string|null $className The object's class. Mandatory if $obj can't be used to determine it | ||
| * | ||
| * @return resource|null The resolved resource or null if file not stored | ||
| */ | ||
| public function resolveStream(object|array $obj, string $fieldName, ?string $className = null); | ||
| public function resolveStream(object|array $obj, ?string $fieldName = null, ?string $className = null); |
There was a problem hiding this comment.
This is a BC break, as any changes in an interface.
But I understand that it's currently inconsistent, and it's not a big change.
Anyway, we need to annotate this change in the UPGRADE file
UPGRADE.md
Outdated
| @@ -1,3 +1,7 @@ | |||
| # Upgrading from v2.1.1 to v2.2.0 | |||
There was a problem hiding this comment.
This doesn't seem right. I understand that you were misled by the other entry (which is also wrong), but specifying the patch version here doesn't make sense.
Please change it to "from 2.1 to 2.2". Please change the other one accordingly ("from 2.0 to 2.1").
UPGRADE.md
Outdated
| # Upgrading from v2.0.1 to v2.1.0 | ||
| # Upgrading from v2.1 to v2.2 | ||
|
|
||
| * The signature of `StorageInterface::resolveStream` method was changed. Nullable value of parameters `$fieldName`. |
There was a problem hiding this comment.
$fieldName is a single parameter, right?
Anyway, this sentence is not clear, please reword it as follows: "The $fieldName parameter is now nullable."
There was a problem hiding this comment.
Fixed. Sorry for my en.
No description provided.