Custom Module Configuration

Drupal 8 & 9 Custom Module with Configuration or Setting Page

So you have been building a custom module. Congradulations! This is a big step, but now you want more. You would like to be able to have a configuration page so that you can set some settings particular to your module. This tutorial will give you the very basics to get you a configuration page for your custom module.

Here are the building block you will need and some assumptions of what you will start off with.

  • Building blocks
    • Basic custom module
    • CustomModuleForm.php
    • custom_module.routing.yml
    • custom_module.schema.yml
  • Assumptions
    • You already have at least a basic Drupal site up and running
    • You have access to the files that make up the site
    • You can edit these files with a text editor
    • You have at least a basic custom module already set up

You can get all the completed code on the Custom Module Configuration repository on gitub.

Building blocks

Basic Custom Module

If you don’t have a module already please create one first before going through these instructions. It will make a lot more sense about what actually is needed to add a configuration page. Visit the Drupal 9 Basic Custom Module page on this site for building you own custom module.

CustomModuleForm.php

For you to save a configuration you need some way to gather the information. The CustomModuleForm.php is a very important piece to the puzzle. This file will be stored in a subdirectory of your custom module (e.g., /docroot/sites/default/modules/custom/custom_module/src/Form/CustomModuleForm.php). This file is used to build the form that you will use to enter your desired configuration.

You need the following parts to this file in order for your form to work:

  • Form class
  • Methods of the class
    • getEditableConfigNames() – gets the configuration name
    • getFormId() – returns the form’s unique ID
    • buildForm() – returns the form array
    • validateForm() – validates the form
    • submitForm() – processes the form submission

Form class

The form class is the basis of the form. There is some configuration before the class to get everything needed to get the form available in the right space. All the methods in this section will be within this class. Here is a complete file.

<?php

/**
 * @file
 * Contains Drupal\custom_module\Form\CustomModuleForm.
 */

namespace Drupal\custom_module\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;

class CustomModuleForm extends ConfigFormBase {
	// Methods below and code go in this class
}

getEditableConfigNames()

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'custom_module.settings',
    ];
  }

getFormId()

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'custom_module_form';
  }

validateForm()

This function has to be here but currently it is not validating anything for simplicity.

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

  }

submitForm()

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this->config('custom_module.settings');
    $config->set('custom_module.custom_module_settings', $form_state->getValue('custom_module_settings'));
    $config->save();
    return parent::submitForm($form, $form_state);
  }

custom_module.schema.yml

Let drupal know where to save the configuration in the database with the schema file located at /docroot/sites/default/modules/custom/custom_module/config/schema/custom_module.schema.yml.

custom_module.settings:
  type: config_object
  label: 'Custom module settings'
  mapping:
    policy_library:
      type: mapping
      mapping:
        custom_module_settings:
          type: text
          label: 'Custom module settings'

custom_module.routing.yml

The routing.yml file is stored in the root directory of your custom module file structure at /docroot/sites/default/modules/custom/custom_module/. Like most of the other files in this folder it starts off with the custom module name. In this case it is custom_module. So the full file path is /docroot/sites/default/modules/custom/custom_module/custom_module.routing.yml.

The custom_module.routing.yml file, in this case, is going to tell Drupal that there is a page at /admin/config/development/custom-module. That page will have a form, title, and a required permission to access it.

custom_module.form:
  path: '/admin/config/development/custom-module'
  defaults:
    _form: '\Drupal\custom_module\Form\CustomModuleForm'
    _title: 'Custom Module settings'
  requirements:
    _permission: 'administer site configuration'

custom_module.links.menu.yml

The full path of the links.menu.yml file is /docroot/sites/default/modules/custom/custom_module/custom_module.links.menu.yml. This file lets Drupal know that there should be a menu item under the Home > Administration > Configuration > Development menu structure with these settings.

custom_module.form:
  title: 'Custom module settings'
  description: 'Configure settings for the custom module.'
  route_name: custom_module.form
  parent: 'system.admin_config_development'

Drupal 8 & 9 check if current page is user

You may want to check programmatically if you are on a user page or profile in Drupal 8 or 9. Use Drupal’s routeMatch to grab user. Then check if $user is an instance of user. Execute your code on that page.

$user = \Drupal::routeMatch()->getParameter('user');
if ($user instanceof \Drupal\user\UserInterface) {
  // It's a user page!
}

Mac OS Terminal Custom Prompt with Git Branch

This article explains how I set up my new Mac’s terminal to be more simple and incorporate the Git branch in the prompt.

Get .git-promt.sh

Get the code from the source on GitHub.

As directed in the comments, place the code in your home directory (e.g. ~/.git-prompt.sh). You will most likely need to create this file.

Add or edit .bashrc or .zshrc

You will need to know what shell you are running. A really easy way to see this is to just type some gibberish in the terminal prompt and hit enter.

asdf
bash: asdf: command not found

The above shows you are running the Bash shell. Below shows you are using the ZSH shell.

asdf
zsh: command not found: asdf

Create or edit your .bashrc or .zshrc file in your home directory (e.g. ~/.zshrc). Then add the following to your file and save:

Bash Shell

source ~/.git-prompt.sh
PS1='[\u@\h \W$(__git_ps1 " ({5eae014a9d3ebefef46f176d33543e78fecc824a150a3220e1441ced9189d4b1}s)")]\$ '

ZSH Shell

source ~/.git-prompt.sh
setopt PROMPT_SUBST ; PS1='[{5eae014a9d3ebefef46f176d33543e78fecc824a150a3220e1441ced9189d4b1}n@{5eae014a9d3ebefef46f176d33543e78fecc824a150a3220e1441ced9189d4b1}m {5eae014a9d3ebefef46f176d33543e78fecc824a150a3220e1441ced9189d4b1}c$(__git_ps1 " ({5eae014a9d3ebefef46f176d33543e78fecc824a150a3220e1441ced9189d4b1}s)")]\$ '

Reload Shell rc File

Run the following command to reload your RC file.

Bash Shell

source ~/.bashrc

ZSH Shell

source ~/.zshrc

Your New Prompt

Your new prompt will look something like this depending on if you are in a git repository or not:

 
 

There are many options to customize your prompt even more by customizing what you put in your RC file. Doing a search on google will help you find what you need.

Migration From Drupal 7 to Drupal 8: How do I find which items were ignored?

You are migrating from Drupal 7 to Drupal 8 and you have ignored items after you run a migration. This leads to the very important question of which ones were ignored?

What you see

[notice] Processed 632 items (630 created, 0 updated, 0 failed, 2 ignored) - done with 'node_form'

The above is what I will use in my examples.

What you want to know

What are the items ignored!? For this we can look into the database. I assume you have access to a console…

The migrate_map_migration_name table in your database will give you the information you need. There will be a column named source_row_status. The value of 2 equals the status of ignored. So run the following MySQL command:

SELECT * FROM `migrate_map_node_form` WHERE source_row_status = 2;

The sourceid1 column of the returned rows will contain the id of the item that was ignored.

Example output:

source_ids_hash sourceid1 destid1 source_row_status source_row_status last_imported hash
8530eb5d63ad4cfea47134a28e3339e089f639164d218287c3… 10931 NULL 2 0 0
ddd550e747c2a26a2a5058d49be0e146616fd5c45f6bef88f3… 11656 NULL 2 0 0

Answers on stackoverflow.

Migration of Files from Dupal 7 to Drupal 8 with: [notice] Field discovery failed for Drupal core version 7. Did this site have the CCK or Field module installed? Error: No database connection configured for source plugin d7_field_instance

When migrating files in Drupal 7 to Drupal 8 you receive one or more notices:

[notice] Field discovery failed for Drupal core version 7. Did this site have the CCK or Field module installed? Error: No database connection configured for source plugin d7_field_instance

At the end of the migration you will see something like this:

[notice] Processed 2607 items (2474 created, 0 updated, 15 failed, 118 ignored) - done with 'file'

The numbers will be different according to the amount of files you are migrating. In my case each of the 118 ignored files all had generated [notice] Field discovery failed....

After looking through the database I found that one of my fields held reference data to a user that no longer existed.

Process I took to find the problem

  1. Google and Drupal site
    1. There was very little information to be found with searching for: [notice] Field discovery failed for Drupal core version 7. Did this site have the CCK or Field module installed? Error: No database connection configured for source plugin d7_field_instance.
  2. Dive into the database – splash
    1. Find which files didn’t get migrated from the migration map with MYSQL on the D8 database.
      SELECT * FROM `migrate_map_file` where source_row_status <> 0;
      
      You’ll want to note that all the files that don’t have a d8_database > migrate_map_file > migrate_map_status of 0 are not created. The status of 2 means the file is ignored and 3 means it failed the migration.
    2. Use MYSQL on the D7 database to select a few files each that were ignored and created.
      SELECT * FROM `file_managed` WHERE fid = 5981 OR fid = 6051 OR fid = 5816 OR fid = 6906 OR fid = 16231 OR fid = 3709
      
      The file_managed table is where you can pull each FID (field id) from the fid column. In the example the last two FIDs where files that were created. The other 3 FIDs where ones that had been ignored. By comparing these I found that the only thing that stood out was the UIDs (user ids). A couple of the files ignored had the same UID.
    3. On the Drupal 7 site I viewed the user by the UID (mysite.com/user/123). This ended up in a page not found. You can also check this in the database with the following command.
      SELECT * FROM `users` WHERE uid = 123;
      

Conclusion

There were files with an author that no longer existed in the database. As an example, the file with the FID of 5981. This file referenced the author, which was a user, with a UID of 123 that was no longer in the database. This caused the notice and for the file to be ignored in the migration.

Linting HTML with Sublime Text 3, SublimeLinter, HTML Tidy for Windows, and SublimeLinter HTML Tidy on Windows

Linting is the process of running a program that will analyse code for potential errors.

In this article we will be Sublime Text 3, SublimeLinter, SublimeLinter HTML Tidy, and HTML Tidy for Windows to lint some HTML code.

  1. Install Sublime Text 3
  2. Install SublimeLinter
  3. Install HTML Tidy for Windows
  4. Install SublimeLinter HTML Tidy

Install Sublime Text 3

Sublime Text 3 is a sophisticated text editor for code, markup, and prose.

This is a free software to try and the trial period doesn’t stop but it does have a pop up every so often that reminds to you play fair. Purcase the software like I did. It is a solid investment if you are going to do any coding.

Install SublimeLinter

SublimeLinter is a plugin for Sublime Text that provides a framework for linting code.

  1. With Sublime Text 3 open hold CTRL + SHIFT + P and type install
  2. Select Package Control: Install Package
  3. Type SublimeLinter
  4. Select SublimeLinter
  5. You will get a Package Control Message that says the package is installed

Install HTML Tidy for Windows

HTML Tidy for Windows is a binary that is needed by the SublimeLinter HTML Tidy plugin. It allows you to run Tidy on Windows.

  1. Navigate to the HTML Tidy for Windows website
  2. Select the tidy.zip link to download
  3. Extract the tidy.exe file to a place that SublimeLinter will have access to it
    1. For example C:\Users\Username\tidy

Install SublimeLinter HTML Tidy

SublimeLinter HTML Tidy

  1. With Sublime Text 3 open hold CTRL + SHIFT + P and type install
  2. Select Package Control: Install Package
  3. Type Sublimelinter-html-tidy
  4. Select Sublimelinter-html-tidy
  5. You will get a Package Control Message that says the package is installed
  6. To use tidy you have to point SublimeLinter to the tidy.exe file
    1. In Sublime Text 3 navigate to Preferences > Package Settings > SublimeLinter > Settings

    2. In the new window scroll down to paths

    3. Copy that section to the tab on the right

      "paths": {
          "linux": [],
          "osx": [],
          "windows": []
      },
      
    4. Enter your path to tidy.exe in the windows option

      {
        "paths": {
            "linux": [],
            "osx": [],
            "windows": ["~/tidy"]
        },
      }
      

      Note: You need to use forward slashes.

    5. Save the setting with CTRL + S

    6. Close the window

  7. Now open a HTML document and errors in your HTML will be displayed

How to pay Minnesota sales tax and record it in QuickBooks Desktop

  1. Set up sales tax in QuickBooks Desktop
  2. Make sales and collect sales tax
  3. Run report Reports > Vendors & Payables > Sales Tax Liability
    1. This will give you the numbers for your sales tax liability
  4. Log into MN e-Services
    1. File the appropriate quarter
    2. Enter the information from your sales tax liability report
    3. Pay sales and use tax
    4. Print transaction for your tax records
  5. In QuickBooks navigate to Vendors > Sales Tax > Pay Sales Tax
    1. If you have paid your previous sales tax appropriately you should only have the last quarter’s tax numbers listed
    2. Confirm the check date is the date you paid the taxes
    3. Confirm you have the last quarter date selected
    4. Adjust the tax amount as needed Note: Minnesota rounds the amount to whole dollars. This will mean that you will have to adjust the tax paid up or down.
      1. Click Adjust
      2. Confirm that the Adjustment Date is the date you paid the taxes
      3. Select your Sales Tax Vendor
      4. Select your Adjustment Account
        Note: If you round down you will recieve a credit. That credit needs to go somewhere in QuickBooks so you will have to set up an Income account to track it. The same is true if you have to round up. Except for this you will need an Expense account. Reference
      5. Select the type of adjustment. Increase Sales Tax By for rounding up (or if you have to pay a late fee) or Reduce Sales Tax By for rounding down.
      6. Enter the Amount of the increase or reduction
      7. In the memo I find it helpful to enter the reason for the adjustment (e.g. Sales Tax Adjustment – Round up)
      8. Click OK
    5. Select each of the line items you would like to pay including any adjustments
    6. Click OK
  6. That is it you have paid for your taxes and tracked them in QuickBooks

Just a note… I am not an authority figure on QuickBooks. This is just what has worked for me.

Troubleshooting

I had a mess when I paid the taxes in QuickBooks with a check instead of the Pay Taxes feature. I had to make some adjustments. See the Sales Tax Payable is incorrect after using the Write Cheques window to pay sales tax heading on the How to resolve common sales tax issues QuickBooks page.

Order of Link Pseudo Classes (Lord Vader Hates Furry Animals)

Remember: Lord Vader Hates Furry Animals (CSS-TRICKS > Link Pseudo-Classes (In Order))

  1. :link selector to style links to unvisited pages (CSS :link Selector)
  2. :visited selector to style links to visited pages(CSS :visited Selector)
  3. :hover selector to style links when you mouse over them (CSS :hover Selector)
  4. :focus selector is used to select the element that has focus (w3schools.com > CSS :focus Selector)
  5. :active selector is used to select and style the active link (w3schools.com > CSS :active Selector)
    • :active MUST come after :hover (if present) in the CSS definition in order to be effective!
    • a link becomes active when you click on it
Drupal 8: Missing Login

Drupal 8: What happened to my login page!?

The Short

If you are working on the page.html.twig file and you now can’t get to the login screen confirm you are rendering the content section in your template by having {{ page.content }} in the page.html.twig file.

The Long

Recently, I have been learning to use Drupal 8 while at the same time getting more and more familiar with Drupal 7. I hit a little problem along the way and thought I would share as Drupal is notoriously hard to find information on when you need it. Unfortunately, part of the reason why is because if you read the documentation you can figure it out with some effort.

Who wants to put that kind of effort into it when it seems like there is a simple fix? So here is a simple fix or something you can check if you have a similar problem.

What I was doing…

I was in the process of building a custom theme and was building a template using YOURTHEME/templates/page.html.twig.

After logging out I was unable to log back in. I tried logging in via the login path built into Drupal 8 (mysite.com/user/login). It came up with the same page as the main page I was working on. I determined the template was the problem by renaming the template so as not to be rendered by Drupal. Note you can’t clear the cache if you can’t login. You will have to run the drush in the command line in the root folder (the folder with sites in it…) of your site: drush cr. Now the login page work by going to mysite.com/user/login.

The problem was that I had defined the content area in the MYTHEME.info.yml but did not add the code to the template to render the content in the content area of my theme. To resolve enter {{ page.content }} where you want to render your login information in your theme. Clear the all caches and change the name of the template back to what it was (page.html.twig).

AOL equals LAME – AOL does not allow you to forward your emails.

These posts are incorrect. AOL no longer forwards emails to other addresses (not even other AOL addresses)! (https://www.techwalla.com/articles/how-to-forward-aol-mail; http://www.justanswer.com/email/7l0qq-aol-email-automatically-forwarded.html)

However, there is a work around. Techwalla had this very helpful article.

Basically you have to have Google Mail forward you email for you. You add your something@aol.com email address to your gmail account (you will have to create one if you don’t have one).

  1. In your Gmail account  click the settings cog wheel at the top right.
  2. Click “Accounts and Import”
  3. Click “Add a mail account you own” (a popup window will apprear)
  4. Enter your AOL email address, click “Next Step”
  5. Fill in your AOL username and password (username is youraccount@aol.com).
  6. Check “Label Incoming Messages” to tag emails sent to your AOL address and help separate them from Gmail messages.
  7. Before pressing “Add Account,” check “Leave a Copy…” if you want your AOL emails to appear both on Gmail and on the AOL website or AOL Desktop.

Then if you want to use a different email account (i.e. not Gmail) you can forward the Gmail account to another email.

  1. In your Gmail account  click the settings cog wheel at the top right.
  2. Click Forwarding and POP/IMAP
  3. Click “Add a forwarding address”
  4. Add your email address (not AOL or Gmail) and save.
  5. Gmail will send that email a confirmation. Go to that account’s inbox and click the box to confirm the forward. This will open a browser window click confirm.
  6. Now one more step… In the Forwarding and POP/IMAP section of Gmails settings you need to enable forwarding to the address by selecting the Forward a copy of incoming mail to yourforwardedemail@somewhere.com.
  7. Click save. Now you will be able to get your email! 🙂