Maybe module for Drupal 8

This module lets you access Drupal entities without worrying about accidentally triggering a fatal exception, which is especially useful in theme preprocess functions.

The class is loosely based on the Maybe Monad, but customized for the particularities of PHP/Drupal and tailored specifically for accessing and traversing nested entities.

The module helps protect you from four common issues that would usually trigger a fatal exception:

• Calling a method on null when the previous method did not return an expected object.
• Calling a method that doesn't exist on the current object.
• Trying to access the first element of an unexpectedly empty array.
• Trying to access a field that does not exist in the current Drupal entity.

In any of these cases, the Maybe object returns null, so it can be used whenever the lack of a result won't cause problems.

Usage

Instead of calling object methods on a Drupal entity, you instead call them on a new Maybe object, and then use the return function to get the resulting object or value at the end:

use Drupal\maybe\Maybe;
...
$output = (new Maybe($entity))->function1()->function2()->return();

To help make the syntax a bit more comprehensible, the module provides a simple maybe() function that can access the namespace and create the object for you:

$output = maybe($entity)->function1()->function2()->return();

Comparison

Here is an example from a theme preprocess function for getting the download link of a file entity referenced by a media entity referenced by a paragraph entity:

$variables['file_url'] = maybe($paragraph)->get('field_media_file')->referencedEntities()->get('field_media_file')->referencedEntities()->url()->return();

That is the equivalent of this error-prone code:

$variables['file_url'] = $paragraph->get('field_media_file')->referencedEntities()[0]->get('field_media_file')->referencedEntities()[0]->url();

Without using Maybe, you would need to write 21 lines of code with 7 IF statements to traverse those references while protecting against exceptions:

// Make sure we have a file_download paragraph with a field_media_file field.
if ($paragraph->hasField('field_media_file')) {

  // Get the field that references the media item.
  $field_media_file = $paragraph->get('field_media_file');

  // Ensure this is actually a reference field.
  if ($media_reference->getFieldDefinition()->getType() == "entity_reference_revisions") {

    // Get referenced entities.
    $media_entities = $media_reference->referencedEntities();

    // Ensure that there are entities referenced by the field.
    if (!empty($media_entities)) {

      // We only need to use the first media entity.
      $media_entity = $media_entities[0];

      // Ensure this entity has the needed file reference field.
      if ($media_entity->hasField('field_media_file')) {

        // Get the field that references the file.
        $file_reference = $media_entity->get('field_media_file');

        // Ensure this is actually an image field that references files.
        if ($file_reference->getFieldDefinition()->getType() == "image") {

          // Get file entities.
          $file_entities = $file_reference->referencedEntities();

          // Make sure that there are entities referenced by the field.
          if (!empty($file_entities)) {

            // We only need to use the first entity.
            $file_entity = $file_entities[0];

            // Make sure that the referenced entity is a file.
            if ($file_entity->getEntityType()->id() = "file") {

              // Save the url for the file for use by the twig template.
              $variables['file_url'] = $file_entity->url();
            }
          }
        }
      }
    }
  }
}

Methods

Most methods you will run on the Maybe object will be directly passed to the current object it contains. However, there are several functions that the Maybe object will handle itself:

->return()

Call the return function at the end of your chain of object functions in order to fetch the result.

$output = maybe($entity)->function1()->function2()->return();

->property('name')

Access a property of the current object.

$output = maybe($entity)->function1()->property('my_property_name')->function2()->return();

->array($key, [$key2, ..])

Access a value when the current object is an indexed array, which requires specifying the desired index:

$output = maybe($entity)->function1()->array(0)->function2()->return();

If you omit this function, Maybe will pass the next function to the first item in the array, so this will return the same result:

$output = maybe($entity)->function1()->function2()->return();

You can associative arrays by passing a named key to the function:

$output = maybe($entity)->function1()->array('my_array_key')->return();

Traverse nested arrays by passing a series of keys as a multiple arguments.

$output = maybe($entity)->array('my_array_key', 0, 'value')->return();

Future development

Potential features:

• array function defaults to 0?
• shorter a() function that is alias of array()
• call a method on all items in an array
• alternatives to the ->return() function that specify the intended result type, such as ->string() or ->array().

Please feel free to submit an issue if you find a bug or would like to request a feature: https://github.com/mikemccaffrey/maybe