Deprecate PhpStorage ::writeable() methods for removal in Drupal 11 with no replacement

This issue is being reviewed by the kind folks in Slack, #needs-review-queue-initiative. We are working to keep the size of Needs Review queue [2700+ issues] to around 400 (1 month or less), following Review a patch or merge request → as a guide.

@expectedDeprecation appears to no longer be used in Drupal core so tags for test to replace though.
Change record would have to be updated for deprecated in 10.1 and removed in 11

Thanks

Updated references to deprecation version and updated the change record.

@expectedDeprecation appears to no longer be used in Drupal core so tags for test to replace though.

Does this need to be removed or replaced with something else?

Probably their own tests

Use the expectDeprecation() method instead. See https://www.drupal.org/node/3176667 →

Updated the @expectedDeprecation with expectDeprecation().
And also updated deprecated in 10.1 and removed in 11 which was not addressed in #58.

Verified the patch #60 on Drupal version 10.1.x. The patch applied cleanly and I have added the after patch screenshots of both files for reference.

That wasn't the correct fix. See change record

Thanks @jungle!

+++ b/core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php
@@ -69,6 +69,7 @@ public function getFullPath($name) {
+    @trigger_error('writeable() is deprecated in drupal:10.1.0 and will be removed from drupal:11.0.0. No replacement. See https://www.drupal.org/node/3155413', E_USER_DEPRECATED);

+++ b/core/lib/Drupal/Component/PhpStorage/FileStorage.php
@@ -148,6 +148,7 @@ public function getFullPath($name) {
+    @trigger_error('writeable() is deprecated in drupal:10.1.0 and will be removed from drupal:11.0.0. No replacement. See https://www.drupal.org/node/3155413', E_USER_DEPRECATED);

These deprecation messages would appear to refer to a global procedural writeable() function. However, they are actually about Drupal\Component\PhpStorage\PhpStorageInterface::writeable().

The change record also doesn't explain what the code should do instead if for some reason some code happens to use this method.

Plus, the current scope (of entirely deprecating the method) seems much broader than just changing the spelling to not have the silent "e", so we should update it with how we came to this solution of just entirely removing the whole interface method.

Addressing @xjm's review. Added the new method ::writable() as the replacement of ::writeable().

Both IS and CR were updated.

IS and CR look better now.

Thanks, @smustgrave

Note,

+++ b/core/lib/Drupal/Component/PhpStorage/PhpStorageInterface.php
@@ -55,6 +55,20 @@ public function save($name, $code);
+  public function writable();

Note: writable() added to the interface is a BC break. Not sure if it's allowed.

The extra method is OK under the 1-1 exception for interface changes https://www.drupal.org/about/core/policies/core-change-policies/bc-policy →

Committed 09a5ff9 and pushed to 10.1.x. Thanks!

#74 thanks!

BTW, just published the CR.

I think there was a misunderstanding here. In #68 and #69 I wasn't saying that the new approach (of deprecating the methods with no replacement) was wrong; I was just indicating that the IS and CR needed to be updated accordingly.

#40 and #42 make a case for deprecating the method with no replacement because as of those comments it was not used in core or contrib. That's fine, so long as we update the issue title, issue summary, and change record to justify this and to explain to someone who might have for whatever reason used this in custom code whatever it is they should do instead.

Discussed with @catch and we agreed on a revert. Thanks!

Just doing the title for now.

Sorry for the misunderstanding.

Corrected the title, it's ::writeable(), not ::isWriteable

IS updated, CR updated.

I missed that too. Think it should be good now though.

Committed to 10.1.x, thanks!

Automatically closed - issue fixed for 2 weeks with no activity.