Add missing type hinting to Contextual module docblocks [#1816764]

This is a sub-issue of #1800046: [META] Add missing type hinting to core docblocks, fix Drupal.Commenting.FunctionComment.Missing* focused on correctly adding @param and @return type hinting to the Contextual module.

Documentation patches that include type hinting are time consuming to both review and commit because one must dig into the actual code to confirm that the type hints are both correct and complete. Hence, please be patient and try to limit type hint patches to covering only a limited number of docblocks (20-25 as a guess).

How To Review This Issue

Attempt to apply the patch to see if it needs a reroll.
Use the phpcs one-liner to evaluate whether all the relevant standards errors have been resolved: https://gist.github.com/paul-m/227822ac7723b0e90647
Look at each change and determine whether the type hint is correct.

Related sprint issues:

	Sprint Topic	Sub Issue
	#1518116: [meta] Make Core pass Coder Review	#1533208: Make contextual module pass Coder Review
	#1310084: [meta] API documentation cleanup sprint	#1332648: Clean up API docs for contextual module
	#500866: [META] remove t() from assert message	N.A.

Comment	File	Size	Author
#4	1816764_4.patch	4.27 KB	Mile23
#4

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

Wim Leers

Ghent 🇧🇪🇪🇺

CreditAttribution: Wim Leers commented 23 August 2013 at 10:48

Status:

Active

» Closed (duplicate)

This is a subset of #1533208: Make contextual module pass Coder Review, which already has a patch. Hence merging into that issue.

Comment #2

Mile23

English

Seattle, WA

CreditAttribution: Mile23 commented 7 January 2015 at 06:37

Issue summary:	View changes
Parent issue:		» #1800046: [META] Add missing type hinting to core docblocks, fix Drupal.Commenting.FunctionComment.Missing*

Comment #3

Mile23

English

Seattle, WA

CreditAttribution: Mile23 commented 15 January 2015 at 03:03

Status:

Closed (duplicate)

» Active

This issue may be a subset of #1533208: Make contextual module pass Coder Review, but its limited scope makes it very achievable, reasonably easy to review, and it will help IDEs do autocomplete.

Marking as active.

Comment #4

Mile23

English

Seattle, WA

CreditAttribution: Mile23 commented 18 January 2015 at 01:30

Status:

Active

» Needs review

File	Size
1816764_4.patch	4.27 KB

Shazam.

Comment #5

Mile23

English

Seattle, WA

CreditAttribution: Mile23 commented 28 February 2015 at 17:22

Still applies.

Comment #6

Mile23

English

Seattle, WA

CreditAttribution: Mile23 commented 28 February 2015 at 23:37

Issue summary:

View changes

Comment #7

martin107 CreditAttribution: martin107 commented 1 March 2015 at 11:14

Status:

Needs review

» Reviewed & tested by the community

I've double checked this. these look good to me.

Comment #8

alexpott

he/they

English

🇪🇺🌍

CreditAttribution: alexpott commented 10 March 2015 at 10:07

Status:

Reviewed & tested by the community

» Needs work

Committed e7fcbb2 and pushed to 8.0.x. Thanks!

+++ b/core/modules/contextual/src/Tests/ContextualDynamicContextTest.php
@@ -134,8 +137,6 @@ function testDifferentPermissions() {
-   *
-   * @return bool
    */
   protected function assertContextualLinkPlaceHolder($id) {

@@ -146,8 +147,6 @@ protected function assertContextualLinkPlaceHolder($id) {
-   *
-   * @return bool
    */
   protected function assertNoContextualLinkPlaceHolder($id) {

Assertions should return a bool - these methods just need to return the result of their assertions.