Automated Drupal 10 compatibility fixes [#3298180]

Problem/Motivation

Hello project maintainers,

This is an automated issue to help make this module compatible with Drupal 10.

To read more about this effort by the Drupal Association, please read: The project update bot is being refreshed to support Drupal 10 readiness of contributed projects

Patches will periodically be added to this issue that remove Drupal 10 deprecated API uses. To stop further patches from being posted, change the status to anything other than Active, Needs review, Needs work or Reviewed and tested by the community. Alternatively, you can remove the "ProjectUpdateBotD10" tag from the issue to stop the bot from posting updates.

The patches will be posted by the Project Update Bot official user account. This account will not receive any issue credit contributions for itself or any company.

Proposed resolution

You have a few options for how to use this issue:

Accept automated patches until this issue is closed
If this issue is left open (status of Active, Needs review, Needs work or Reviewed and tested by the community) and the "ProjectUpdateBotD10" tag is left on this issue, new patches will be posted periodically if new deprecation fixes are needed.

As the Drupal Rector project improves and is able to fix more deprecated API uses, the patches posted here will cover more of the deprecated API uses in the module.

Patches and/or merge requests posted by others are ignored by the bot, and general human interactions in the issue do not stop the bot from posting updates, so feel free to use this issue to refine bot patches. The bot will still post new patches then if there is a change in the new generated patch compared to the patch that the bot posted last. Those changes are then up to humans to integrate.
Leave open but stop new automated patches.
If you want to use this issue as a starting point to remove deprecated API uses but then don't want new automated patches, remove the "ProjectUpdateBotD10" tag from the issue and use it like any other issue (the status does not matter then). If you want to receive automated patches again, add back the "ProjectUpdateBotD10" tag.
Close it and don't use it
If the maintainers of this project don't find this issue useful, they can close this issue (any status besides Active, Needs review, Needs work and Reviewed and tested by the community) and no more automated patches will be posted here.

If the issue is reopened, then new automated patches will be posted.

If you are using another issue(s) to work on Drupal 10 compatibility it would be very useful to other contributors to add those issues as "Related issues" when closing this issue.

Remaining tasks

Using the patches

Apply the latest patch in the comments by Project Update Bot or human contributors that made it better.
Thoroughly test the patch. These patches are automatically generated so they haven't been tested manually or automatically.
Provide feedback about how the testing went. If you can improve the patch, post an updated patch here.

Providing feedback

If there are problems with one of the patches posted by the Project Update Bot, such as it does not correctly replace a deprecation, you can file an issue in the Drupal Rector issue queue. For other issues with the bot, for instance if the issue summary created by the bot is unclear, use the Project analysis issue queue.

Comment	File	Size	Author
#11	Drupal-10-upgrade-status-95 (23).png	27.17 KB	yashingole
#11	Add-Paragraphs-type-10.png	12.38 KB	yashingole
#9	style_options-3298180-9.patch	1.54 KB	sharique
#6	style_options-3298180-6.patch	1.03 KB	reenaraghavan
#2	style_options.1.0.x-dev.rector.patch	677 bytes	project update bot

Issue fork style_options-3298180

Show commands

Start within a Git clone of the project using the version control instructions.

Add & fetch this issue fork’s repository

Or, if you do not have SSH keys set up on git.drupalcode.org:

Add & fetch this issue fork’s repository

3298180-automated-drupal-10 changes, plain diff MR !7
Check out this branch for the first time

Check out existing branch, if you already have it locally

About issue forks

Comments

Comment #1

18 July 2022 at 18:46

Project Update Bot created an issue. See original summary.

Comment #2

project update bot commented 18 July 2022 at 18:47

Status:

Active

» Needs review

Status	File	Size
new	style_options.1.0.x-dev.rector.patch	677 bytes

This is an automated patch generated by Drupal Rector. Please see the issue summary for more details.

It is important that any automated tests available are run with this patch and that you manually test this patch.

Drupal 10 Compatibility

According to the Upgrade Status module, even with this patch, this module is not yet compatible with Drupal 10.

Currently Drupal Rector, version 0.13.0, cannot fix all Drupal 10 compatibility problems.

This patch does not update the info.yml file for Drupal 10 compatibility.

Leaving this issue open, even after committing the current patch, will allow the Project Update Bot to post additional Drupal 10 compatibility fixes as they become available in Drupal Rector.

Debug info

Bot run #139

This patch was created using these packages:

mglaman/phpstan-drupal: 1.1.24
palantirnet/drupal-rector: 0.13.0

Comment #3

dharti patel commented 9 September 2022 at 06:05

Assigned:	Unassigned	» dharti patel
Issue summary:	View changes

Hello,
Thanks for the auto-bot patch,
I will review the patch.

Comment #4

dharti patel commented 9 September 2022 at 10:16

Assigned:	dharti patel	» Unassigned
Status:	Needs review	» Needs work

Hello,

Testing Steps:
1. Install the Style Options module on drupal 9
2. Applied patch #2 and checked the upgrade status on drupal 9 (Note: 4 issues)

Provide a screenshot for reference.
The module is not compatible with Drupal 10, it can now be moved to need to work.

Facing errors while running the drupal checker.

 ------ -------------------------------------------------------- 
  Line   src/Plugin/StyleOption/BackgroundImage.php              
 ------ -------------------------------------------------------- 
  40     Call to deprecated method toInt() of class              
         Drupal\Component\Utility\Bytes:                         
         in drupal:9.1.0 and is removed from drupal:10.0.0. Use  
         \Drupal\Component\Utility\Bytes::toNumber() instead     
 ------ -------------------------------------------------------- 

 ------ ----------------------------------------------------------------------- 
  Line   src/Plugin/paragraphs/Behavior/StyleOptionBehavior.php                 
 ------ ----------------------------------------------------------------------- 
  22     Class                                                                  
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior    
         extends unknown class Drupal\paragraphs\ParagraphsBehaviorBase.        
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  30     Parameter $paragraph of method                                         
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior::  
         buildBehaviorForm() has invalid type                                   
         Drupal\paragraphs\ParagraphInterface.                                  
  35     Call to method getContextOptions() on an unknown class                 
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  37     Call to method bundle() on an unknown class                            
         Drupal\paragraphs\ParagraphInterface.                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  40     Access to an undefined property                                        
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior::  
         $pluginId.                                                             
  40     Call to method getBehaviorSetting() on an unknown class                
         Drupal\paragraphs\ParagraphInterface.                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  49     Parameter $paragraph of method                                         
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior::  
         view() has invalid type Drupal\paragraphs\Entity\Paragraph.            
  51     Call to method getContextOptions() on an unknown class                 
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  53     Call to method bundle() on an unknown class                            
         Drupal\paragraphs\Entity\Paragraph.                                    
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  56     Access to an undefined property                                        
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior::  
         $pluginId.                                                             
  56     Call to method getBehaviorSetting() on an unknown class                
         Drupal\paragraphs\Entity\Paragraph.                                    
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
 ------ ----------------------------------------------------------------------- 

 ------ ----------------------------------------------------------------------- 
  Line   src/StyleOptionConfigurationDiscovery.php                              
 ------ ----------------------------------------------------------------------- 
  61     Method                                                                 
         Drupal\style_options\StyleOptionConfigurationDiscovery::getInstances(  
         ) has invalid return type                                              
         Drupal\style_options\OptionPluginConfiguration.                        
 ------ ----------------------------------------------------------------------- 

 ------ ----------------------------------------------------------------------- 
  Line   src/StyleOptionContextTrait.php (in context of class                   
         Drupal\style_options\Plugin\Layout\StyleOptionLayoutPlugin)            
 ------ ----------------------------------------------------------------------- 
  20     Call to method getProcessedStyleOptionContextDefinition() on an        
         unknown class                                                          
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  30     Call to method getContextOptions() on an unknown class                 
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  49     Call to method getOptionDefinition() on an unknown class               
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  49     Method                                                                 
         Drupal\style_options\Plugin\Layout\StyleOptionLayoutPlugin::getStyleO  
         ptionPluginForm() should return array but return statement is          
         missing.                                                               
  53     Call to method createInstance() on an unknown class                    
         Drupal\style_options\Contracts\OptionPluginManagerInterface.           
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  81     Call to method setValues() on an unknown class                         
         Drupal\style_options\Contracts\OptionPluginInterface.                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  82     Call to method build() on an unknown class                             
         Drupal\style_options\Contracts\OptionPluginInterface.                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  102    Call to method submitConfigurationForm() on an unknown class           
         Drupal\style_options\Contracts\OptionPluginInterface.                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  103    Call to method getValues() on an unknown class                         
         Drupal\style_options\Contracts\OptionPluginInterface.                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  115    Method                                                                 
         Drupal\style_options\Plugin\Layout\StyleOptionLayoutPlugin::getStyleO  
         ptionPlugin() has invalid return type                                  
         Drupal\style_options\Contracts\OptionPluginInterface.                  
  116    Call to method getOptionDefinition() on an unknown class               
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  119    Call to method createInstance() on an unknown class                    
         Drupal\style_options\Contracts\OptionPluginManagerInterface.           
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  132    Method                                                                 
         Drupal\style_options\Plugin\Layout\StyleOptionLayoutPlugin::styleOpti  
         onPluginConfigurationDiscovery() has invalid return type               
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
  142    Method                                                                 
         Drupal\style_options\Plugin\Layout\StyleOptionLayoutPlugin::styleOpti  
         onPluginManager() has invalid return type                              
         Drupal\style_options\Contracts\OptionPluginManagerInterface.           
 ------ ----------------------------------------------------------------------- 

 ------ ----------------------------------------------------------------------- 
  Line   src/StyleOptionContextTrait.php (in context of class                   
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior)   
 ------ ----------------------------------------------------------------------- 
  20     Call to an undefined method                                            
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior::  
         getPluginId().                                                         
  20     Call to method getProcessedStyleOptionContextDefinition() on an        
         unknown class                                                          
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  30     Call to an undefined method                                            
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior::  
         getPluginId().                                                         
  30     Call to method getContextOptions() on an unknown class                 
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  49     Call to method getOptionDefinition() on an unknown class               
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  49     Method                                                                 
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior::  
         getStyleOptionPluginForm() should return array but return statement    
         is missing.                                                            
  53     Call to method createInstance() on an unknown class                    
         Drupal\style_options\Contracts\OptionPluginManagerInterface.           
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  81     Call to method setValues() on an unknown class                         
         Drupal\style_options\Contracts\OptionPluginInterface.                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  82     Call to method build() on an unknown class                             
         Drupal\style_options\Contracts\OptionPluginInterface.                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  102    Call to method submitConfigurationForm() on an unknown class           
         Drupal\style_options\Contracts\OptionPluginInterface.                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  103    Call to method getValues() on an unknown class                         
         Drupal\style_options\Contracts\OptionPluginInterface.                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  115    Method                                                                 
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior::  
         getStyleOptionPlugin() has invalid return type                         
         Drupal\style_options\Contracts\OptionPluginInterface.                  
  116    Call to method getOptionDefinition() on an unknown class               
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  119    Call to method createInstance() on an unknown class                    
         Drupal\style_options\Contracts\OptionPluginManagerInterface.           
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols    
  132    Method                                                                 
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior::  
         styleOptionPluginConfigurationDiscovery() has invalid return type      
         Drupal\style_options\OptionPluginConfigurationDiscovery.               
  142    Method                                                                 
         Drupal\style_options\Plugin\paragraphs\Behavior\StyleOptionBehavior::  
         styleOptionPluginManager() has invalid return type                     
         Drupal\style_options\Contracts\OptionPluginManagerInterface.           
 ------ ----------------------------------------------------------------------- 

 ------ --------------------------------------------------------------------- 
  Line   style_options.install                                                
 ------ --------------------------------------------------------------------- 
  17     Call to static method loadMultiple() on an unknown class             
         Drupal\paragraphs\Entity\ParagraphsType.                             
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols  
  27     PHPDoc tag @var for variable $paragraph contains unknown class       
         Drupal\paragraphs\Entity\Paragraph.                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols  
  28     Call to method getAllBehaviorSettings() on an unknown class          
         Drupal\paragraphs\Entity\Paragraph.                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols  
  53     Call to method setAllBehaviorSettings() on an unknown class          
         Drupal\paragraphs\Entity\Paragraph.                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols  
  54     Call to method save() on an unknown class                            
         Drupal\paragraphs\Entity\Paragraph.                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols  
 ------ --------------------------------------------------------------------- 

 ------ --------------------------------------------------------------------- 
  Line   style_options.module                                                 
 ------ --------------------------------------------------------------------- 
  37     Call to static method loadMultiple() on an unknown class             
         Drupal\paragraphs\Entity\ParagraphsType.                             
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols  
  51     PHPDoc tag @var for variable $paragraph contains unknown class       
         Drupal\paragraphs\Entity\Paragraph.                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols  
  52     Call to method getAllBehaviorSettings() on an unknown class          
         Drupal\paragraphs\Entity\Paragraph.                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols  
  55     Call to method setAllBehaviorSettings() on an unknown class          
         Drupal\paragraphs\Entity\Paragraph.                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols  
  56     Call to method save() on an unknown class                            
         Drupal\paragraphs\Entity\Paragraph.                                  
         💡 Learn more at https://phpstan.org/user-guide/discovering-symbols  
 ------ --------------------------------------------------------------------- 

 [ERROR] Found 53 errors                                                        

Thanks for using drupal-check!

Thanks!

Comment #5

16 October 2022 at 14:33

reenaraghavan made their first commit to this issue’s fork.

Comment #6

reenaraghavan commented 16 October 2022 at 15:07

Status	File	Size
new	style_options-3298180-6.patch	1.03 KB

Comment #7

project update bot commented 17 October 2022 at 19:29

Issue summary:

View changes

Updating bot issue summary.See #3313904: Update project bot templates for RTBC status support and human interaction tips

Comment #8

j-lee

he/him

German

🇩🇪🇪🇺

commented 31 January 2023 at 12:28

Issue summary:

View changes

Patch #6 looks good.

There is another deprecation in src/Plugin/StyleOption/BackgroundImage.phpsrc/Plugin/StyleOption/BackgroundImage.php at line 40.

Call to deprecated method toInt() of class Drupal\Component\Utility\Bytes. Deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Use Drupal\Component\Utility\Bytes::toNumber() instead

Comment #9

sharique commented 8 February 2023 at 19:03

Status:

Needs work

» Needs review

Status	File	Size
new	style_options-3298180-9.patch	1.54 KB

2 files were hidden/shown/deleted

Status	File	Size
hidden	style_options.1.0.x-dev.rector.patch	677 bytes
hidden	style_options-3298180-6.patch	1.03 KB

I updated patch and tested on Drupal 10 the module is working fine these changes.

Comment #10

12 March 2023 at 03:09

doidd made their first commit to this issue’s fork.

Comment #11

yashingole commented 13 March 2023 at 11:54

Status	File	Size
new	Add-Paragraphs-type-10.png	12.38 KB
new	Drupal-10-upgrade-status-95 (23).png	27.17 KB

I have reviewed and checked Patch #9 and this works for drupal 9.5 and drupal 10.0. and 10.0.1
Screenshots of the compatibility on 9.5 and the Paragraph on 10 have been attached for reference:

Comment #12

15 March 2023 at 07:06

doidd opened merge request !7

Comment #13

j-lee

he/him

German

🇩🇪🇪🇺

commented 6 April 2023 at 06:53

Status:

Needs review

» Reviewed & tested by the community

MR7 and Patch #9 are identical.

Comment #14

8 April 2023 at 19:14

nmangold made their first commit to this issue’s fork.

Comment #15

16 April 2023 at 15:48

justin2pin made their first commit to this issue’s fork.

Comment #16

16 April 2023 at 16:57

justin2pin committed 4c49f9c5 on 1.0.x authored by doidd

Issue #3298180: Automated Drupal 10 compatibility fixes

Comment #17

justin2pin commented 16 April 2023 at 16:59

Status:

Reviewed & tested by the community

» Fixed

Made a slight change to MR to use dependency injection instead of invoking Drupal::service() directly, and rebased by merging with 1.0.x. Thanks everybody for working on this. This issue makes me realize we really need automated testing.

Comment #18

30 April 2023 at 17:04

Status:

Fixed

» Closed (fixed)

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

Automated Drupal 10 compatibility fixes

Problem/Motivation

Proposed resolution

Remaining tasks

Providing feedback

Issue fork style_options-3298180

Comments

Comment #1

Comment #2

Drupal 10 Compatibility

Debug info

Comment #3

Comment #4

Comment #5

Comment #6

Comment #7

Comment #8

Comment #9

Comment #10

Comment #11

Comment #12

Comment #13

Comment #14

Comment #15

Comment #16

Comment #17

Comment #18

News items

Our community

Documentation

Drupal code base

Governance of community