social_mentions.module in Open Social 10.3.x

Contains social_mentions.module.

File

modules/social_features/social_mentions/social_mentions.module

<?php

/**
 * @file
 * Contains social_mentions.module.
 */
use Drupal\Core\Form\FormStateInterface;
use Drupal\comment\CommentInterface;
use Drupal\Core\Url;
use Drupal\Component\Serialization\Json;
use Drupal\mentions\Entity\MentionsType;
use Drupal\Core\Asset\AttachedAssetsInterface;
use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;

/**
 * Implements hook_form_alter().
 */
function social_mentions_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  $mentions_forms = [
    'social_post_entity_form',
    'comment_post_comment_form',
    'comment_comment_form',
  ];
  if (in_array($form_id, $mentions_forms)) {

    // Initialize variables.
    $prefix = '[~';
    $suffix = ']';
    $config = \Drupal::config('mentions.settings');
    if ($config
      ->get('suggestions_format') === 'username') {
      if ($usermention = MentionsType::load('UserMention')) {
        $usermention = $usermention
          ->getInputSettings();
        $prefix = $usermention['prefix'];
        $suffix = $usermention['suffix'];
      }
    }
    else {
      if ($profilemention = MentionsType::load('ProfileMention')) {
        $profilemention = $profilemention
          ->getInputSettings();
        $prefix = $profilemention['prefix'];
        $suffix = $profilemention['suffix'];
      }
    }
    $form['#attached']['library'][] = 'social_mentions/social_mentions';
    $form['#attached']['drupalSettings']['socialMentions'] = [
      'suggestionsFormat' => $config
        ->get('suggestions_format'),
      'prefix' => $prefix,
      'suffix' => $suffix,
    ];
  }
}

/**
 * Implements hook_theme().
 */
function social_mentions_theme($existing, $type, $theme, $path) {
  $items = [
    'mentions' => [
      'render element' => 'elements',
      'template' => 'mentions',
    ],
    'profile__profile__autocomplete_item' => [
      'template' => 'profile--profile--autocomplete_item',
      'path' => $path . '/templates',
      'render element' => 'elements',
      'base hook' => 'profile',
    ],
  ];
  return $items;
}

/**
 * Implements hook_preprocess_hook().
 */
function social_mentions_preprocess_mentions(&$variables) {
  if (!empty($variables['elements']['#mentions'])) {
    $mention = $variables['elements']['#mentions'];
    if (isset($mention->entity_type)) {
      $entity_type = $mention
        ->getMentionedEntityTypeId();
      $entity = $mention
        ->getMentionedEntity();
      if ($entity) {
        $content = \Drupal::entityTypeManager()
          ->getViewBuilder($entity_type)
          ->view($entity, 'activity');
        $variables['mention_context'] = $content;
      }
    }
  }
}

/**
 * Implements hook_comment_links_alter().
 */
function social_mentions_comment_links_alter(array &$links, CommentInterface $entity, array &$context) {
  $field_name = $entity
    ->getFieldName();
  $commented_entity = $entity
    ->getCommentedEntity();
  if ($entity
    ->hasParentComment() && $commented_entity
    ->get($field_name)->status == CommentItemInterface::OPEN) {

    /** @var \Drupal\Core\Session\AccountInterface $account */
    $account = $entity
      ->getOwner();
    $storage = \Drupal::entityTypeManager()
      ->getStorage('profile');
    $config = \Drupal::config('mentions.settings');
    $suggestions_format = $config
      ->get('suggestions_format');
    $item = [
      'uid' => $account
        ->id(),
      'username' => $account
        ->getAccountName(),
      'value' => $account
        ->getAccountName(),
      'html_item' => '',
      'profile_id' => '',
    ];
    if ($suggestions_format != SOCIAL_PROFILE_SUGGESTIONS_USERNAME) {

      /** @var \Drupal\profile\Entity\ProfileInterface $profile */
      if ($storage && ($profile = $storage
        ->loadByUser($account, 'profile', TRUE))) {
        $item['profile_id'] = $profile
          ->id();
        $item['value'] = $account
          ->getDisplayName();
      }
    }

    // Disable reply if full name is not set for only username format.
    if ($suggestions_format == SOCIAL_PROFILE_SUGGESTIONS_FULL_NAME && $account
      ->getAccountName() == $account
      ->getDisplayName()) {
      return;
    }
    $links['comment']['#links']['comment-reply'] = [
      'title' => t('Reply'),
    ];

    // If the comment is not published disable the reply link.
    if ($entity
      ->isPublished()) {
      $links['comment']['#links']['comment-reply']['url'] = Url::fromUserInput('#' . $entity
        ->getParentComment()
        ->id());
      $links['comment']['#links']['comment-reply']['attributes'] = [
        'class' => [
          'mention-reply',
        ],
        'data-author' => Json::encode($item),
      ];
    }
    else {
      $links['comment']['#links']['comment-reply']['url'] = Url::fromRoute('<nolink>');
    }
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function social_mentions_form_comment_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  if (!$form_state
    ->getFormObject()
    ->getEntity()
    ->hasParentComment()) {
    $form['pid'] = [
      '#type' => 'hidden',
      '#attributes' => [
        'class' => [
          'parent-comment',
        ],
      ],
    ];
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 *
 * Add social specific configurations to mentions settings form.
 */
function social_mentions_form_mentions_settings_form_alter(&$form, FormStateInterface $form_state, $form_id) {
  $config = \Drupal::config('mentions.settings');
  $form['display'] = [
    '#type' => 'details',
    '#title' => t('Display settings'),
    '#open' => TRUE,
  ];
  $options = [
    SOCIAL_PROFILE_SUGGESTIONS_USERNAME => t('Only username'),
    SOCIAL_PROFILE_SUGGESTIONS_FULL_NAME => t('Only full name (first and last)'),
    SOCIAL_PROFILE_SUGGESTIONS_ALL => t('Both (username and full name)'),
  ];
  $form['display']['suggestions_format'] = [
    '#type' => 'radios',
    '#required' => TRUE,
    '#options' => $options,
    '#title' => t('Suggestions format'),
    '#default_value' => $config
      ->get('suggestions_format'),
  ];
  $form['#submit'][] = 'social_mentions_form_mentions_settings_form_submit';
}

/**
 * Form submit for mentions_settings_form.
 */
function social_mentions_form_mentions_settings_form_submit($form, FormStateInterface $form_state) {

  // Save config.
  $config = \Drupal::configFactory()
    ->getEditable('mentions.settings');
  $config
    ->set('suggestions_format', $form_state
    ->getValue('suggestions_format'));
  $config
    ->save();
}

/**
 * Implements hook_js_alter().
 */
function social_mentions_js_alter(&$javascript, AttachedAssetsInterface $assets) {
  $path = drupal_get_path('module', 'social_mentions') . '/js/social_mentions.js';
  if (isset($javascript[$path]) && isset($javascript['core/assets/vendor/ckeditor/ckeditor.js'])) {
    $javascript[$path]['weight'] += $javascript['core/assets/vendor/ckeditor/ckeditor.js']['weight'];
  }
}

Functions

Name	Description
social_mentions_comment_links_alter	Implements hook_comment_links_alter().
social_mentions_form_alter	Implements hook_form_alter().
social_mentions_form_comment_form_alter	Implements hook_form_FORM_ID_alter().
social_mentions_form_mentions_settings_form_alter	Implements hook_form_FORM_ID_alter().
social_mentions_form_mentions_settings_form_submit	Form submit for mentions_settings_form.
social_mentions_js_alter	Implements hook_js_alter().
social_mentions_preprocess_mentions	Implements hook_preprocess_hook().
social_mentions_theme	Implements hook_theme().