social_comment_upload.module in Open Social 10.0.x

Module file for Social Comment Upload.

File

modules/social_features/social_comment_upload/social_comment_upload.module

<?php

/**
 * @file
 * Module file for Social Comment Upload.
 */
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\file\Entity\File;
use Drupal\Core\Link;

/**
 * Implements hook_form_FORM_ID_alter().
 *
 * Alter the weight of the actions, so the upload is last.
 */
function social_comment_upload_form_comment_comment_form_alter(&$form, FormStateInterface $form_state, $form_id) {

  // If we don't have a file upload field there's nothing to change.
  if (!isset($form['field_comment_files'])) {
    return;
  }
  if (social_comment_upload_is_enabled()) {
    $form['field_comment_files']['widget']['#file_upload_title'] = '';
    $form['#attached']['library'][] = 'social_comment_upload/comment_upload';
    $form['#after_build'][] = 'social_comment_upload_form_comment_comment_form_after_build';

    // Workaround for fixing behat tests,
    // which is caused by alter in social_comment module.
    $form['field_comment_files']['#weight'] = 9;
    $form['actions']['#weight'] = 8;
  }
  else {

    // Turn it off.
    $form['field_comment_files']['#access'] = FALSE;
  }
}

/**
 * Removes the select list with "weight" value.
 */
function social_comment_upload_form_comment_comment_form_after_build($form, FormStateInterface $form_state) {
  foreach ($form['field_comment_files']['widget'] as &$element) {
    if (is_array($element) && isset($element['_weight'])) {
      unset($element['_weight']);
    }
  }
  return $form;
}

/**
 * Implements hook_preprocess_HOOK().
 */
function social_comment_upload_preprocess_comment(&$variables) {

  // Alter comments in activity when social_comment_upload is enabled.
  if (social_comment_upload_is_enabled()) {
    $count_arr = [];
    $comment = $variables['elements']['#comment'];

    // For comments in activities we show the amount of attachments.
    if ($variables['elements']['#view_mode'] === 'activity' || $variables['elements']['#view_mode'] === 'activity_comment') {

      /** @var \Drupal\comment\Entity\Comment $comment */
      if ($comment
        ->hasField('field_comment_files')) {
        foreach ($comment->field_comment_files as $value) {
          if (isset($value->target_id)) {
            $count_arr[] = $value->target_id;
          }
        }

        // Add the amount of attachments to the comment.
        if (!empty($count_arr)) {
          $text = \Drupal::translation()
            ->formatPlural(count($count_arr), '1 attachment.', '@count attachments.');
          $variables['comment_attachments_count'] = Link::fromTextAndUrl($text, $comment
            ->permalink());
        }
      }
    }
  }
}

/**
 * Implements hook_preprocess_HOOK().
 */
function social_comment_upload_preprocess_file_widget_multiple(&$variables) {
  if (social_comment_upload_is_enabled()) {
    $element = $variables['element'];
    if ($element['#field_name'] == 'field_comment_files') {

      // Remove "weight" column.
      foreach ($variables['table']['#rows'] as $key => $row) {
        if (!empty($element['#display_field'])) {
          unset($variables['table']['#rows'][$key]['data'][2]);
        }
        else {
          unset($variables['table']['#rows'][$key]['data'][1]);
        }
      }

      // Remove headers and disable sorting rows.
      $variables['table']['#header'] = [];
      $variables['table']['#tabledrag'] = [];
    }
  }
}

/**
 * Implements hook_comment_delete().
 */
function social_comment_upload_comment_delete(EntityInterface $entity) {

  // If this comment has any files, delete those as well.
  _social_comment_upload_delete_comment_files($entity);
}

/**
 * Deletes the files associated with a comment.
 *
 * This can be used to clean up files that were uploaded with a comment once
 * that comment is being removed.
 *
 * @param \Drupal\Core\Entity\EntityInterface $entity
 *   The comment for which attached files should be deleted.
 *
 * @throws \Drupal\Core\Entity\EntityStorageException
 */
function _social_comment_upload_delete_comment_files(EntityInterface $entity) {

  // If this comment doesn't have any attached files we abort early.
  if (!$entity
    ->hasField('field_comment_files') || $entity
    ->get('field_comment_files')
    ->isEmpty()) {
    return;
  }

  // Extract all the file ids referred.
  $file_ids = array_column($entity
    ->get('field_comment_files')
    ->getValue(), 'target_id');

  // Try to load the actual file objects.
  if ($files = File::loadMultiple($file_ids)) {

    // Iterate and delete individual file objects.
    foreach ($files as $file) {

      // Delete the file object.
      $file
        ->delete();
    }
  }
}

/**
 * A shortcut function for the allow_upload_comments setting.
 *
 * @return bool
 *   Whether attachment uploading for comments is enabled.
 */
function social_comment_upload_is_enabled() {
  return \Drupal::config('social_comment_upload.settings')
    ->get('allow_upload_comments');
}

Functions

Name	Description
social_comment_upload_comment_delete	Implements hook_comment_delete().
social_comment_upload_form_comment_comment_form_after_build	Removes the select list with "weight" value.
social_comment_upload_form_comment_comment_form_alter	Implements hook_form_FORM_ID_alter().
social_comment_upload_is_enabled	A shortcut function for the allow_upload_comments setting.
social_comment_upload_preprocess_comment	Implements hook_preprocess_HOOK().
social_comment_upload_preprocess_file_widget_multiple	Implements hook_preprocess_HOOK().
_social_comment_upload_delete_comment_files	Deletes the files associated with a comment.