Missing param type for getOption() [#2600004]

Problem/Motivation

Param definition in function comment is missing a type. This is important because many code editors use the functional documentation to describe parameters when you're using the function.

Proposed resolution

Add type to the param

Remaining tasks

Submit a patch

User interface changes

None

API changes

None - just improved documentation

Data model changes

None - just improved documentation

Comment	File	Size	Author
#2	missing_param_type_for-2600004-2.patch	530 bytes	koppie
#2	8.0.x: PHP 5.5 & MySQL 5.5 14,251 pass

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

23 October 2015 at 18:09

koppie created an issue. See original summary.

Comment #2

koppie CreditAttribution: koppie at Pantheon commented 23 October 2015 at 18:18

Assigned:	koppie	» Unassigned
Status:	Active	» Needs review

File	Size
missing_param_type_for-2600004-2.patch	530 bytes
8.0.x: PHP 5.5 & MySQL 5.5 14,251 pass

I've rolled a patch that adds the type to the param. Please review. :-)

Comment #3

YesCT CreditAttribution: YesCT commented 23 October 2015 at 18:19

Status:

Needs review

» Reviewed & tested by the community

yeah, I think string is the correct type.

thanks!

Comment #4

YesCT CreditAttribution: YesCT commented 23 October 2015 at 19:31

Issue tags:

+rc eligible

allowed and adding the tag per https://www.drupal.org/core/d8-allowed-changes#rc

Comment #5

23 October 2015 at 19:52

xjm committed bb7142f on 8.0.x

Issue #2600004 by koppie, YesCT: Missing param type for getOption()

Comment #6

xjm

she/her

English

CreditAttribution: xjm at Acquia commented 23 October 2015 at 19:53

Status:

Reviewed & tested by the community

» Fixed

Thanks @koppie for the patch!

I reviewed this to confirm that the $name parameter is only ever a string. It's used as an array key in getOption(), which means it needs to be a string or integer, and all the calls to getOption() in core pass a string literal. Also, the documented usage for the parameter (on t()) says this:

 * @param $options
 *   An associative array of additional options, with the following elements:
 *   - 'langcode' (defaults to the current language): The language code to
 *     translate to a language other than what is used to display the page.
 *   - 'context' (defaults to the empty context): The context the source string
 *     belongs to.

So based on that, this is the correct parameter type documentation.

As a docs-only change, this is RC eligible. Committed and pushed to 8.0.x. Thanks!