dgi_members.module

<?php

/**
 * @file
 * Contains dgi_members.module.
 */

use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\node\NodeInterface;
use Drupal\views\ViewExecutable;

/**
 * Implements hook_help().
 */
function dgi_members_help($route_name, RouteMatchInterface $route_match) : ?string {
  switch ($route_name) {
    // Main module help for the dgi_members module.
    case 'help.page.dgi_members':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('Facilitates display of compounds objects') . '</p>';
      return $output;

    default:
      return NULL;
  }
}

/**
 * Implements hook_views_pre_render().
 */
function dgi_members_views_pre_render(ViewExecutable $view) : void {
  // XXX: Messing with some views results for displaying non-compound compound
  // objects. This is not generally applicable, but a quick fix kind of
  // adjustment to allow some objects to display similarly to functionality
  // available in i7 that allows for child objects on non-compound objects,
  // where the display allowed one node to behave as the parent and display as
  // the first child of its set.
  if (
    dgi_members_treat_parent_as_first_sibling()
    &&
    (
      (
        ($view->id() === 'manage_members')
        &&
        ($view->current_display === 'block_1')
      )
      ||
      ($view->id() === 'compound_navigation')
    )
  ) {
    $members = dgi_members_get_members();
    $k = 0;
    $temp = [];
    $entity_id = (int) $view->argument['field_member_of_target_id']->argument;
    // If there are more members than view rows, check if our processing
    // prepended the compound as a member of itself, and if so, persist that in
    // the view result display.
    if (
      $members
      && count($members) > $view->total_rows
      && $view->getCurrentPage() == 0
      && reset($members) == $entity_id
    ) {
      foreach ($view->result as $value) {
        if ($k == 0) {
          $entity = \Drupal::entityTypeManager()
            ->getStorage('node')
            ->load($entity_id);
          $first_result = new $value();
          $first_result->_entity = $entity;
          $first_result->index = $k;
          $first_result->nid = $entity_id;
          $temp[] = $first_result;
          $k++;
        }
        $value->index = $k;
        $temp[] = $value;
        $k++;
      }
      $view->result = $temp;
    }
  }

  if ($view->id() === 'compound_navigation') {
    $members = dgi_members_get_members();
    $active = dgi_members_get_active();
    $config = \Drupal::config('dgi_members.settings');

    if ($active) {
      $active_node_id = $active->id();
      $view->element['#attached']['library'][] = 'dgi_members/compound_parts';
      $view->element['#attached']['drupalSettings']['dgi_members']['has_members'] = !(empty($members));
      $view->element['#attached']['drupalSettings']['dgi_members']['active_nid']
        = $active_node_id;
      $view->element['#attached']['drupalSettings']['dgi_members']['display_compound_object_metadata']
        = $config->get('display_compound_object_metadata_by_default') ?? FALSE;
    }
  }
}

/**
 * Implements hook_form_form_id_alter().
 */
function dgi_members_form_block_form_alter(&$form, $form_state, $form_id) : void {
  // In following with how Islandora core is handling block visibility,
  // implementing this hook to unset our custom condition. There's too many to
  // use well within the core block placement UI, and no other reasonable way to
  // filter them out. See https://www.drupal.org/node/2284687. Use
  // /admin/structure/context instead if you want to use these conditions
  // to alter block layout.
  // This hook is also doing the same thing in Islandora core, to hide the
  // conditions it provides.
  unset($form['visibility']['node_compound_current_has_term']);
}

/**
 * Implements hook_entity_view_mode_alter().
 */
function dgi_members_entity_view_mode_alter(&$view_mode, EntityInterface $entity) : void {
  // Change the view mode based on user input from a 'view_mode_alter'.
  // This is very similar to the implementation of this hook in the core
  // islandora module. The difference here is that we are only allowing the view
  // mode to be switched away from a known view mode,
  // (repository_item_top_viewer), and if the entity (node) being processed
  // differs from the menu route object, evaluations are allowed to continue if
  // said node is a member of the menu router object.
  if ($view_mode === "repository_item_top_viewer") {
    $storage = \Drupal::service('entity_type.manager')->getStorage('entity_view_mode');
    $context_manager = \Drupal::service('context.manager');
    if (dgi_members_entity_is_member($entity)) {
      foreach ($context_manager->getActiveReactions('\Drupal\islandora\Plugin\ContextReaction\ViewModeAlterReaction') as $reaction) {
        // Construct the new view mode's machine name.
        $entity_type = $entity->getEntityTypeId();
        $mode = $reaction->execute();
        $machine_name = "$entity_type.$mode";

        // Try to load it.
        $new_mode = $storage->load($machine_name);

        // If successful, alter the view mode.
        if ($new_mode) {
          $view_mode = $mode;
        }
        else {
          // Otherwise, leave it be, but log a message.
          \Drupal::logger('dgi_members')
            ->info("EntityViewMode $machine_name does not exist.  View mode cannot be altered.");
        }
      }
    }
  }
}

/**
 * Determine if the view mode entity is a member of the menu router object.
 *
 * @param Drupal\Core\Entity\EntityInterface $entity
 *   A node to evaluate.
 *
 * @return bool
 *   TRUE if is a member, FALSE if not.
 */
function dgi_members_entity_is_member(EntityInterface $entity) : bool {
  $members = dgi_members_get_members();
  return $members && in_array($entity->id(), $members, FALSE);
}

/**
 * Retrieve the active member, if available.
 *
 * @return false|\Drupal\node\NodeInterface
 *   FALSE if no node available, or the active Node.
 */
function dgi_members_get_active() : NodeInterface|false {
  $active_member_param = reset(\Drupal::config('dgi_members.settings')->get('member_parameters'));
  /** @var \Drupal\dgi_members\DgiMembersEntityOperationsInterface $service */
  $service = \Drupal::service('dgi_members.entity_service');
  return $service->retrieveActiveMember($active_member_param);
}

/**
 * Return members of the menu route object.
 *
 * @return false|array
 *   FALSE if no member available, indexed array of members otherwise.
 */
function dgi_members_get_members() : array|false {
  /** @var \Drupal\dgi_members\DgiMembersEntityOperationsInterface $service */
  $service = \Drupal::service('dgi_members.entity_service');
  return $service->membersQueryExecute();
}

/**
 * Return whether to treat parent as first child.
 *
 * This was expected behaviour configurable in i7, and allowing this display
 * option is, in some cases, more desirable than a massive restructuring of
 * migrated content.
 *
 * @return bool
 *   Default to FALSE for standard Compound Object behaviour.
 *   TRUE if the capability to treat objects as a member of themselves is
 *   desired.
 */
function dgi_members_treat_parent_as_first_sibling() : bool {
  return \Drupal::config('dgi_members.settings')
    ->get('display_non_compound_compound_as_first_member_of_itself');
}

/**
 * Return whether to treat this entity as a Compound Object or not.
 *
 * This is related to dgi_members_treat_parent_as_first_sibling(), but could be
 * expanded to be relevant in a separate use case in the future.
 *
 * @param Drupal\node\NodeInterface $entity
 *   Node to evaluate.
 *
 * @return bool
 *   Default to FALSE for standard Compound Object behaviour.
 *   TRUE if object without the 'Compound Object' value in the 'Content Type'
 *   (model) field should still be treated as a Compound Object.
 */
function dgi_members_entity_understood_as_non_compound_compound(NodeInterface $entity) : bool {
  /** @var bool $allow_this_functionality */
  $allow_this_functionality = \Drupal::config('dgi_members.settings')
    ->get('allow_compound_display_for_non_compound');
  if ($allow_this_functionality) {
    /** @var \Drupal\islandora\IslandoraUtils $utils */
    $utils = \Drupal::service('islandora.utils');
    $associated_media = $utils->getMedia($entity);
    if (!empty($associated_media)) {
      return TRUE;
    }
  }
  return FALSE;
}