Fix array params

Closes #3463440

This is passed to \Drupal\Composer\Plugin\Scaffold\Handler::getPackageFileMappings which expects PackageInterface

This is iterated in a foreach loop inside this function

If it's null (or falsey) we generate a hash for the ID

The is imploded inside this function

Above comment even says it can be null

The key must be a string, but the value can be FALSE, for example in PageTitleBlock

forms: [
  'settings_tray' => FALSE,
]

I think there is a question about this line and coding standards. The @param is to be followed by a data type indicator. Those docs do not specify anything for the "<" or ">" style, nor is there an example of such usages. However, this style was first introduced in commit 54fad06e and there are other usages. Based on that we need an issue in Coding Standards project to update the documentation to include this type of example.

When I read the comment though I think that $forms can be FALSE, so I think it needs a tweak. Maybe something like "(optional) An associative array where the key is the form class name and the values are ?. The value may be FALSE."

@quietone are you suggesting that if we open the issue in coding standards we can commit this as it is (with the tweaked description) while waiting for the coding standards process to run its course, given the precedent already exist? If we have to wait for that process I'd rather just change this to @param array and improve it later in a followup.

Opened https://www.drupal.org/project/coding_standards/issues/3468236

I'm trying to improve the description for $forms but I'm struggling to figure out what it's used for. It seems it is either an empty array, ['settings_tray' => FALSE], ['settings_tray' => SomeClass], or ['secondary' => SomeClass].

It looks like there is a whole heap of docs in settings_tray.api.php which is probably now out of date, and I don't have the patience to try understand it. It doesn't seem like this should be part of the Block attribute, and was not previously mentioned in the Block annotation.

The only instance of 'secondary' is in test_multiple_forms_block which probably gives more clues about why we have this.

In ModuleInstaller::install this is built like this:

$module_filenames[$name] = new Extension($this->root, 'module', $pathname, $filename);

added 1 commit

• e2c46458 - A few more

Compare with previous version

This seems to cover all values that are currently used

This was recently made nullable but the param doc wasn't updated

We have explicit checks if this is strictly false, so it appears to be supported

added 1 commit

• 2d00027f - One more

Compare with previous version

closed

reopened

closed