wieni / wmsettings Goto Github PK

Summary

Add an event listener / hook implementation that installs new base fields when necessary.

Motivation

The wmsettings_key base field isn't being installed on new entity types until automatic entity updates have been run. Since Drupal 8.7.x, support for automatic entity updates has been removed, so now this base field isn't being installed at all.

We noticed in the slow query log that there is a recurring query on a non-indexed column:

(site: bruzzdev)

SELECT base_table.id AS id, base_table.id AS base_table_id
FROM 
settings base_table
INNER JOIN settings_field_data settings_field_data ON settings_field_data.id = base_table.id
WHERE settings_field_data.wmsettings_key LIKE 'global\\_settings' ESCAPE '\\';

Task at hand: solve by

a. Add an index on that basefield (https://drupal.stackexchange.com/questions/221410/how-to-add-a-database-index-to-a-base-field)

b. cache the results of the query

Note: I don't know where that query happens. I suspect somewhere in wmsettings but that's not a given.

• Add phpstan.neon config file referencing the wmcodestyle rule files (example)
• Add phpstan analyse to the coding-standards composer script
• Add autoload-dev entry to ensure autoloading during analysis

When wmsettings installs it makes a Global bundle. This has a problem. When you create model out of it then the word global and the class global all have issues. Have it create a bundle called "site".

Summary

Automatically remove bundle from config when it's deleted.

Motivation

Saves time.

• Cleanup code using wieni/wmcodestyle
• Normalise composer.json
• Add LICENSE in case it's missing. Also add the license to composer.json.
• Add CHANGELOG.md (and UPGRADING.md, if applicable)
• Add issue & pull request templates
• Update repo description & tags
• Update README
• Update .gitignore
• Check dependencies: ensure composer.json has a php & drupal/core version requirements and add missing requirements to the .info file

Summary

• Find a new name without the wm prefix
• Create the Drupal project (example)
• Change the license to GPLv2 to comply with Drupal.org requirements (example)
• Update the composer install command in the README
• Add contributing section to the README (example)
• Remove Wieni code style & fix code to adhere to Drupal code style

3a65134

Why was this needed?
If you need to provide a template with a Setting entity, do so from the controller / preprocessor.

By loading it from within the template you've skipped registering it's cache tags!

Summary

Replace all calls to the applyUpdates method of the entity.definition_update_manager service with a custom solution. Since new base fields are added dynamically, we can't use update hooks to install these fields. The same problem has been fixed already on the latest version of wmcontent.

Motivation

Since Drupal 8.7.x, support for automatic entity updates has been removed.