#1938670: Convert unicode.inc to \Drupal\Component\Utility\Unicode comes with some PHP function wrappers. Unicode::truncate(), Unicode::mimeHeaderEncode(), etc. Some of them arn't living under the naming conventions:

  • Unicode::ucfirst()
  • Unicode::substr()

Although it is nice to have PHP wrappers be similarly named to the PHP functions, it's even nicer to have consistent coding standards.

Possible solutions:

  1. Fix the case of the functions: Unicode::ucFirst(), Unicode::subStr(), etc.
  2. Rename the functions entirely: Unicode::upperCaseFirst(), Unicode::subString(), etc.
  3. Leave as is and live with the broken coding standards
CommentFileSizeAuthor
#4 core-funcname-codestyle-1985104.patch5.15 KBjameswoods

Comments

ParisLiakos’s picture

ParisLiakos commented

so, even if these methods stay, we should update our standards for that. eg for php standard function wrappers do that.

my +1 goes to option 2

ParisLiakos’s picture

ParisLiakos commented
Status: Postponed » Active
jameswoods’s picture

jameswoods commented
Assigned: Unassigned » jameswoods

First time contributor here. Using option #2 "Rename the functions entirely: Unicode::upperCaseFirst(), Unicode::subString(), etc." per ParisLiakos' suggestion in comment #1.

jameswoods’s picture

jameswoods commented
Status: Active » Needs review
StatusFileSize
new core-funcname-codestyle-1985104.patch5.15 KB

I began running the test on my local machine...and it was taking forEVER...so I'm going to upload and leverage the testbots 8^)

jameswoods’s picture

jameswoods commented
Assigned: jameswoods » Unassigned

Status: Needs review » Needs work

The last submitted patch, core-funcname-codestyle-1985104.patch, failed testing.

jameswoods’s picture

jameswoods commented

It seems like the failure is:

Fatal error: Call to undefined method Drupal\Component\Utility\Unicode::substr() in /var/lib/drupaltestbot/sites/default/files/checkout/core/lib/Drupal/Component/Utility/Unicode.php on line 467
FATAL Drupal\aggregator\Tests\UpdateFeedItemTest: test runner returned a non-zero error code (255).

I'm not sure how to fix that...the file with the error lives in sites/default/files/..... Do I need to fix the tests or something?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

No, I think you are perhaps misinterpreting the error message. I think there are calls in Core to the old function/method names that need to be replaced with your new names.

For instance, this other error:
PHP Fatal error: Call to undefined method Drupal\Component\Utility\Unicode::strtolower() in /var/lib/drupaltestbot/sites/default/files/checkout/core/modules/system/lib/Drupal/system/MachineNameController.php on line 67

That looks like it is probably in core/modules/system/lib/Drupal/system/MachineNameController.php. Your patch didn't seem to touch other files in core outside of the Unicode classes, but presumably those classes are being used?

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented

See also: #2042625: Unicode::substr() isn't really \substr() like the docs say.

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented
Issue summary: View changes

a

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

mile23’s picture

mile23
Primary language English
Location Seattle, WA
commented
Version: 8.3.x-dev » 8.4.x-dev
Issue summary: View changes

The current methods would need to be deprecated as per the deprecation policy: https://www.drupal.org/core/deprecation

Bump up to 8.4.x because of disruption.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

quietone commented
Parent issue: » #3123066: [meta] Fix 'Drupal.NamingConventions.ValidFunctionName' coding standard

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.