drupal 8 – Page 2 – AgileAdam.com

Development

Overriding “Required Message” on Composite Fields in Webform (Drupal 8)

/ June 18, 2020

The more commonly used fields in Webform (text, radios, etc.) offer the ability to set a custom Required message string. This is the text that shows in the error message when a required field is not filled.

Here’s what that screen looks like when you’re configuring a field on the Build screen:

There are several element types that do not provide a UI field to set this Required message value. The composite Name and Advanced Address field are two examples I encountered. For these fields you have to dig a little deeper, but it’s easy once you get the hang of it. Visit the Advanced tab for the field, then scroll to the bottom where you’ll see a Custom Settings fieldset.

read more

Using Drupal 8 Persistent Login Module on Platform.sh

/ May 15, 2020

The Persistent Login module relies an extra cookie to maintain a Drupal user’s session. The configuration screen for this module lets you specify a prefix for the cookie. The default is “PL”. If you are using the site on HTTPS, the module prepends an “S” to the cookie it creates. Here’s an example cookie name: SPLfa0650d6d985433d455a3b15cc70fd9b .

Platform.sh lets you configure cookie cache settings via routes.yaml .

If you’re using Persistent Login you must tell the system not to ignore this cookie.

Here’s a standard (and simple) routes.yaml file on a Drupal 8 site:

"https://{all}/":
  type: upstream
  upstream: "app:http"
  cache:
    enabled: true
    # Base the cache on the session cookie.
    # Ignore all other cookies.
    cookies: ['/^SS?ESS/', '/^Drupal.visitor/']

"https://{all}/":

type: upstream

upstream: "app:http"

cache:

enabled: true

# Base the cache on the session cookie.

# Ignore all other cookies.

cookies: ['/^SS?ESS/', '/^Drupal.visitor/']

Here’s a modified version which allows Persistent Login to work correctly:

"https://{all}/":
  type: upstream
  upstream: "app:http"
  cache:
    enabled: true
    # Base the cache on the session cookie and persistent login cookie.
    # Ignore all other cookies.
    cookies: ['/^SS?ESS/', '/^S?PL/', '/^Drupal.visitor/']

"https://{all}/":

type: upstream

upstream: "app:http"

cache:

enabled: true

# Base the cache on the session cookie and persistent login cookie.

# Ignore all other cookies.

cookies: ['/^SS?ESS/', '/^S?PL/', '/^Drupal.visitor/']

There is a bit more discussion around how these cookies are handled here: https://www.drupal.org/node/2898065/discuss

Development

Overriding a Webform Confirmation Message in Drupal 8

/ April 23, 2020
There are a few reasons you may need to override a webform confirmation:
- Out of the box webform doesn’t allow you to add some tags (e.g., <button>) to a webform confirmation message. When you save it strips them out.
- What if you needed to alter the webform message based on the values submitted in the webform?
- What if you needed to alter the webform message based on where the user saw the webform?
- etc…
Thankfully, you can use a standard preprocess hook to override the confirmation output.

In this particular example I needed to override the output of the message to include a button tag. I needed this to only happen if specific GET params had specific values.

First, I modified the confirmation message settings as shown here:
read more
Development

Using Lazy Builders and Auto Placeholders in Drupal 8

/ March 30, 2020

Introduction

I’ve been working on a site that features a lot of user-specific customization and output. The site offers workshops (courses) using the Opigno LMS for Drupal 8. The workshops are rendered in a few different ways throughout the site. For the most part, the rendered workshops appear the same for all users. Here’s an example of a “card” view mode for a workshop:

If a user has successfully completed a workshop, a special badge will appear on the card view mode. Also, the card will be highlighted:

There are two parts of the workshop card template that have to change based on the user viewing the card:

read more

Development

NightwatchJS Command to Repeat a Keystroke

/ March 17, 2020

Here’s a simple custom command that lets you repeat a specific key (single or combo) N number of times.

In the Drupal world you want to place this in your “Commands” directory (as defined in DRUPAL_NIGHTWATCH_SEARCH_DIRECTORY in web/core/.env).

You’d want to change “sitename” to be your site’s name (so it feels namespaced).

/tests/Nightwatch/Commands/sitenameRepeatKeystroke.js

/**
 * Repeats a keystroke (can be multiple keys) a specific number of times.
 *
 * @param {array} keys
 *   Array of keys to send.
 *   Example 1: [browser.Keys.TAB]
 *   Example 2: [browser.Keys.SHIFT, browser.Keys.TAB, browser.Keys.NULL]);
 *              (it's important to terminate modifier keys with NULL)
 * @param {integer} times
 *   Number of times to repeat the key send.
 * @param {integer} pauseBetween
 *   Number of milliseconds to pause between each key send (100 ms default).
 * @param {function} callback
 *   A callback which will be called.
 * @return {object}
 *   The 'browser' object.
 */
exports.command = function myCommand(keys, times, pauseBetween = 100, callback) {
  const self = this;

  for (let i = 0; i < times; i++) {
    this.keys(keys);
    if (pauseBetween) {
      this.pause(pauseBetween);
    }
  }

  if (typeof callback === 'function') {
    callback.call(self);
  }

  return this;
};

/**

* Repeats a keystroke (can be multiple keys) a specific number of times.

* @param {array} keys

* Array of keys to send.

* Example 1: [browser.Keys.TAB]

* Example 2: [browser.Keys.SHIFT, browser.Keys.TAB, browser.Keys.NULL]);

* (it's important to terminate modifier keys with NULL)

* @param {integer} times

* Number of times to repeat the key send.

* @param {integer} pauseBetween

* Number of milliseconds to pause between each key send (100 ms default).

* @param {function} callback

* A callback which will be called.

* @return {object}

* The 'browser' object.

exports.command = function myCommand(keys, times, pauseBetween = 100, callback) {

const self = this;

for (let i = 0; i < times; i++) {

this.keys(keys);

if (pauseBetween) {

this.pause(pauseBetween);

}

if (typeof callback === 'function') {

callback.call(self);

}

return this;

};

Using this in /tests/Nightwatch/Tests/misc.js with a 1000ms pause between each keystroke:

/* eslint-disable no-unused-expressions */
module.exports = {
  '@tags': ['mysite', 'learn-page', 'accessibility'],

  'When I hit shift-tab 9 times on the Learn page my logo becomes the active element': browser => {
    browser.drupalRelativeURL('/learn');
    browser.sitenameRepeatKeystroke(
      [browser.Keys.SHIFT, browser.Keys.TAB, browser.Keys.NULL],
      9,
      1000,
    );
  },
};

/* eslint-disable no-unused-expressions */

module.exports = {

'@tags': ['mysite', 'learn-page', 'accessibility'],

'When I hit shift-tab 9 times on the Learn page my logo becomes the active element': browser => {

browser.drupalRelativeURL('/learn');

browser.sitenameRepeatKeystroke(

[browser.Keys.SHIFT, browser.Keys.TAB, browser.Keys.NULL],

1000,

);

};

Development

Faster Debugging with Lando and xdebug

/ February 19, 2020

I’ve been struggling with the speed (or lack thereof) of Lando for Drupal sites. I have suspected xdebug was part of the issue. Sure enough, disabling xdebug speeds up the lando instance considerably. Re-enabling it slows it right back down again. I use xdebug often, so having to lando rebuild to turn xdebug on and off is not an option. I wondered if there’s a way to leave the extension enabled but only use it when needed.

While researching config directives like xdebug.remote_enable and xdebug.remote_autostart, I came across this issue thread on the github Lando project: Allow faster xdebug on/off toggling

The title sounds promising, right?

read more
Development

Quickly Protecting a Few Nodes from Deletion in Drupal 8

/ January 28, 2020
I’m working on a Drupal 8 site with some critical pages for which we do not want to allow deletion. The homepage, for example, is a basic page; we do not want to allow anyone (even UID #1) to delete this page. If there comes a time where UID #1 decides they need to, they’ll have to update this simple code to support that. We need not make it any more complicated than that for this particular project.

Here’s a solution that:
- shows nothing but an error on the “Delete” form for specific nodes (works for all users)
- prevents deletion by any means (works for all users except UID #1)
  
  why except UID #1? because hook_node_access doesn’t run for this user
read more
Development

Testing Tokens with Entity Ref Traversal via Drush

/ December 3, 2019
I am working on a project that has some complicated depth. I needed a way to quickly test token replacement. It’s pretty simple when you understand a few things.

Example Architecture

Here’s the Drupal architecture for this example:
- Discussion Group (content type)
  
  Title
  
  Intro
  
  Body
  
  “Associated Experts” paragraph field (allows one “Associated Experts” paragraph item)
- Associated Experts (paragraph type, used by many content types like Discussion Group above)
  
  Heading
  
  Intro
  
  Experts (allows unlimited number of “Expert” nodes)
- Expert (content type)
  
  Title
  
  Photo
read more
Development

Rendering a Drupal 8 Link with Anchor and Destination

/ August 10, 2019

I’m working on a site that contains several complicated views (many exposed filters). The views render entities using a couple different view modes. These view modes use Display Suite. Within these view modes I’ve leveraged DS custom fields for several needs.

I needed to render a node “Edit” link within some of these view modes. The user would click the edit link, edit the node, then click “Save”. The system would then bring the user to the exact position of the page they were on before, filters and settings intact.

This type of solution would work without Display Suite (leveraging other methods). You’re getting a DS-based example because that’s what the site called for.

In my particular case I needed to separate the anchor from the edit link. If you’re okay having them in the same place you could skip Step 1 and just include the anchor within the markup for the edit link.

read more

Development

Getting a Field from an Entity in Drupal 8

/ June 14, 2019

// @see https://drupal.stackexchange.com/a/99711/28091

// Using magic methods we can check if a specific property of the first item
// in the field has a value. $entity->field_name is equivalent to
// $entity->__get('field_name')). This may not be as safe as using
// ->get('field_name') but is useful. Read on...

// For simple text fields, booleans, etc. we can ask for ->value, for an
// entity reference we'd look at ->target_id. ->uri and ->title for a link.
// ->format and ->value for a long text field. Etc.

// Due to how __get('field_name') works, if the field doesn't exist on the
// entity, an InvalidArgumentException will not be thrown. If instead you
// use get('field_name') an exception would be thrown if field_name didn't
// exist on the entity. You would want to, in this case, check if the
// entity has a field with $entity->hasField('field_name');

// So, to see if a field exists and has a value, here are a few examples:

// Example 1 (top level entity already loaded):
if (isset($entity->field_name->target_id)) {
  do_something();
}

// Example 2 (in a DSField plugin, load an entity then traverse it):
if (!isset($this->entity()->field_fullcalendar_subtitle->value)) {
  do_something();
}

// If we need to loop through multiple items/values in a field (even if
// there is only one), you can either ask for an array using ->getValue(),
// or you can foreach the field using
// foreach ($entity->field_name as $field_item) {}. If you use this approach
// the items are objects. This is convenient for field types that have more
// methods. For example, you can get to the referenced taxonomy term via
// $field_item->entity->name->value, $field_item->entity->tid->value, etc.

// Example 3:
foreach ($entity->field_location as $field_item) {
  $location_name = $field_item->entity->name->value;
}

// Here are some additional examples:

// Example 4:
$myentity->field_myref->entity->title->value

// Example 5:
$myentity->field_myref->referencedEntities()[0]->title->value

// Example 6:
foreach ($myentity->field_myref->referencedEntities() as $entity) {
  $body_format = $entity->field_body->format;
  $body_value = $entity->field_body->value;
}

// @see https://drupal.stackexchange.com/a/99711/28091

// Using magic methods we can check if a specific property of the first item

// in the field has a value. $entity->field_name is equivalent to

// $entity->__get('field_name')). This may not be as safe as using

// ->get('field_name') but is useful. Read on...

// For simple text fields, booleans, etc. we can ask for ->value, for an

// entity reference we'd look at ->target_id. ->uri and ->title for a link.

// ->format and ->value for a long text field. Etc.

// Due to how __get('field_name') works, if the field doesn't exist on the

// entity, an InvalidArgumentException will not be thrown. If instead you

// use get('field_name') an exception would be thrown if field_name didn't

// exist on the entity. You would want to, in this case, check if the

// entity has a field with $entity->hasField('field_name');

// So, to see if a field exists and has a value, here are a few examples:

// Example 1 (top level entity already loaded):

if (isset($entity->field_name->target_id)) {

do_something();

}

// Example 2 (in a DSField plugin, load an entity then traverse it):

if (!isset($this->entity()->field_fullcalendar_subtitle->value)) {

do_something();

}

// If we need to loop through multiple items/values in a field (even if

// there is only one), you can either ask for an array using ->getValue(),

// or you can foreach the field using

// foreach ($entity->field_name as $field_item) {}. If you use this approach

// the items are objects. This is convenient for field types that have more

// methods. For example, you can get to the referenced taxonomy term via

// $field_item->entity->name->value, $field_item->entity->tid->value, etc.

// Example 3:

foreach ($entity->field_location as $field_item) {

$location_name = $field_item->entity->name->value;

}

// Here are some additional examples:

// Example 4:

$myentity->field_myref->entity->title->value

// Example 5:

$myentity->field_myref->referencedEntities()[0]->title->value

// Example 6:

foreach ($myentity->field_myref->referencedEntities() as $entity) {

$body_format = $entity->field_body->format;

$body_value = $entity->field_body->value;

}

Introduction

Example Architecture