varbase_media-9.0.0-alpha1/includes/helpers.inc

<?php

/**
 * @file
 * Contains List of all varbase_media helpers.
 *
 * Add custom needed helper functions.
 */

use Drupal\image\Entity\ImageStyle;
use Drupal\media\MediaInterface;
use Drupal\node\Entity\Node;

/**
 * Managed Varbase Media Library configurations.
 *
 * Fix [Media Library] and the [Media Grid and Media Table]
 * admin pages to work with Drupal ^8.8.x and ^8.7.x .
 */
function varbase_media__managed_media_library_configs() {
  $module_path = Drupal::service('module_handler')->getModule('varbase_media')->getPath();
  $managed_config_path = DRUPAL_ROOT . '/' . $module_path . '/config';

  if (version_compare(Drupal::VERSION, '8.8.0', 'lt') === TRUE) {
    $managed_config_path = $managed_config_path . '/managed/lt80800';
  }
  else {
    // Use the latest managed configs from the managed latest directory.
    $managed_config_path = $managed_config_path . '/managed/latest';
  }

  // Override the media view.
  $media_config_path = $managed_config_path . '/views.view.media.yml';
  if (file_exists($media_config_path)) {
    $media_config_content = file_get_contents($media_config_path);
    $media_config_data = (array) Yaml::parse($media_config_content);
    $media_config_factory = \Drupal::configFactory()->getEditable('views.view.media');
    $media_config_factory->setData($media_config_data)->save(TRUE);
  }

  // Override the media library view.
  $media_library_config_path = $managed_config_path . '/views.view.media_library.yml';
  if (file_exists($media_library_config_path)) {
    $media_library_config_content = file_get_contents($media_library_config_path);
    $media_library_config_data = (array) Yaml::parse($media_library_config_content);
    $media_library_config_factory = \Drupal::configFactory()->getEditable('views.view.media_library');
    $media_library_config_factory->setData($media_library_config_data)->save(TRUE);
  }

}

/**
 * Helper function to rename slick_media config dependencies to slick.
 *
 * Https://git.drupalcode.org/project/slick_media/-/blob/8.x-3.x/slick_media.install.
 *
 * @param string $dependency_type
 *   The type of the dependency, such as "module" or "config".
 * @param string $dependency_id
 *   The name of the dependency to be updated.
 * @param callable $map
 *   A callback to be passed to array_map() to actually perform the config name
 *   substitution.
 */
function varbase_media__slick_media_fix_dependencies($dependency_type, $dependency_id, callable $map) {
  $dependents = \Drupal::service('config.manager')
    ->findConfigEntityDependents($dependency_type, [$dependency_id]);

  $key = 'dependencies.' . $dependency_type;
  $key2 = 'dependencies.enforced.' . $dependency_type;

  foreach (array_keys($dependents) as $name) {
    $config = \Drupal::configFactory()->getEditable($name);
    $dependencies = $config->get($key);
    if (is_array($dependencies)) {
      $config->set($key, array_map($map, $dependencies));
    }

    $dependencies2 = $config->get($key2);
    if (is_array($dependencies2)) {
      $config->set($key2, array_map($map, $dependencies2));
    }

    $config->save();
  }
}

/**
 * Get the URL with image style for a selected media entity.
 *
 * @param \Drupal\media\MediaInterface $media_entity
 *   The entity object for media with image.
 * @param string|null $style_name
 *   The name of the image style.
 *
 * @return string|null
 *   The image url by media entity and image style name.
 */
function varbase_media__image_url(MediaInterface $media_entity, ?string $style_name = NULL) {

  $image_field_name = varbase_media__default_image_field_name($media_entity);

  if ($img_entity = $media_entity->get($image_field_name)->first()) {
    if ($file_entity = $img_entity->get('entity')->getTarget()) {
      if (!empty($style_name)) {
        return ImageStyle::load($style_name)
          ->buildUrl($file_entity->get('uri')
            ->first()
            ->getString());
      }
      else {
        return \Drupal::service('file_url_generator')->generateAbsoluteString($file_entity->get('uri')->getString());
      }
    }
  }

  return varbase_media__get_fallback_social_share_image_url();
}

/**
 * Get the default image field name for any media entity types.
 *
 * @param \Drupal\media\MediaInterface $media_entity
 *   The entity object for media with image.
 *
 * @return string
 *   The field name for the image for a media type.
 */
function varbase_media__default_image_field_name(MediaInterface $media_entity) {

  // Media entities with a valid field media image data it will come first.
  if (isset($media_entity->field_media_image)
      && !empty($media_entity->get('field_media_image')->first())) {
    return 'field_media_image';
  }
  // Media entities with a valid field media cover image data it will be used.
  elseif (isset($media_entity->field_media_cover_image)
      && !empty($media_entity->get('field_media_cover_image')->first())) {
    return 'field_media_cover_image';
  }
  // Media entities without field image or cover image, will get the thumbnail.
  else {
    return 'thumbnail';
  }

}

/**
 * Get a url for the fullback social share image from the active theme.
 *
 * @return mixed
 */
function varbase_media__get_fallback_social_share_image_url() {
  $active_theme = \Drupal::theme()->getActiveTheme()->getPath();
  $origin_url = \Drupal::request()->getSchemeAndHttpHost() . \Drupal::request()->getBaseUrl();
  $share_image_url = $origin_url . '/' . $active_theme . '/share-image.png';
  return $share_image_url;
}

/**
 * Get the share image URL for a node.
 *
 * @param \Drupal\node\Entity\Node $node
 *   The node entity.
 * @param string|null $style_name
 *   (optional) The image style to apply. Defaults to NULL.
 * @param string|null $field_name
 *   (optional) The specific field name to check for the share image. If not provided,
 *   the function will check fields in a priority order.
 *
 * @return string
 *   The URL of the share image, or the fallback URL if not found.
 */
function varbase_media__get_node_share_image_url(Node $node, ?string $style_name = 'social_large', ?string $field_name = '') {

  $image_url = '';

  // When no filed name.
  if ($field_name == '') {
    // Check if the node has field_media and it has data.
    if ($node->hasField('field_media') && !$node->get('field_media')->isEmpty()) {
      $entity = $node->get('field_media')->entity;
      if ($entity instanceof MediaInterface) {
        // Set the social share image from the field_media field.
        $image_url = varbase_media__image_url($entity, $style_name);
      }
    }
    // When no field_media check if the node has field_image and it has data.
    elseif ($node->hasField('field_image') && !$node->get('field_image')->isEmpty()) {
      $entity = $node->get('field_image')->entity;
      if ($entity instanceof MediaInterface) {
        // Set the social share image from the field_image field.
        $image_url = varbase_media__image_url($entity, $style_name);
      }
    }
    // When no field_image check if the node has field_video and it has data.
    elseif ($node->hasField('field_video') && !$node->get('field_video')->isEmpty()) {
      $entity = $node->get('field_video')->entity;
      if ($entity instanceof MediaInterface) {
        // Set the social share image from the field_video field.
        $image_url = varbase_media__image_url($entity, $style_name);
      }
    }
  }
  // When the field name is provided.
  elseif ($field_name != '') {
    // Check if the node has the filed and it has data.
    if ($node->hasField($field_name) && !$node->get($field_name)->isEmpty()) {
      $entity = $node->get($field_name)->entity;
      if ($entity instanceof MediaInterface) {
        // Set the social share image from the field.
        $image_url = varbase_media__image_url($entity, $style_name);
      }
    }
  }

  // When image url still empty, then set the fallback social share image from the default active theme.
  if ($image_url === '') {
    $image_url = varbase_media__get_fallback_social_share_image_url();
  }

  return $image_url;
}