moderation_note-8.x-1.0-beta3/src/Controller/ModerationNoteController.php

<?php

namespace Drupal\moderation_note\Controller;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Ajax\AjaxResponse;
use Drupal\Core\Ajax\AppendCommand;
use Drupal\Core\Ajax\ReplaceCommand;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Url;
use Drupal\moderation_note\ModerationNoteInterface;
use Drupal\user\UserInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Endpoints for the Moderation Note module.
 */
class ModerationNoteController extends ControllerBase {

  /**
   * Returns the form for a new Moderation Note.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity this note is related to.
   * @param string $field_name
   *   The name of the field that is being notated.
   * @param string $langcode
   *   The name of the language for which the field is being notated.
   * @param string $view_mode_id
   *   The view mode the field is rendered in.
   *
   * @return array
   *   A render array representing the form.
   */
  public function createNote(EntityInterface $entity, $field_name, $langcode, $view_mode_id) {
    $note_storage = $this->entityTypeManager()->getStorage('moderation_note');
    $values = [
      'entity_type' => $entity->getEntityTypeId(),
      'entity_id' => $entity->id(),
      'entity_field_name' => $field_name,
      'entity_langcode' => $langcode,
      'entity_view_mode_id' => $view_mode_id,
    ];
    $moderation_note = $note_storage->create($values);
    $form = $this->entityFormBuilder()->getForm($moderation_note, 'create');
    $form['#attributes']['data-moderation-note-new-form'] = TRUE;

    return $form;
  }

  /**
   * Checks route access to create moderation note.
   */
  public function createNoteAccess(EntityInterface $entity, $field_name, $langcode, $view_mode_id) {
    $account = $this->currentUser();

    return AccessResult::allowedIf(_moderation_note_on_entity($entity, $account))
      ->orIf(AccessResult::allowedIfHasPermission($account, 'administer moderation notes'))
      ->cachePerPermissions()->cachePerUser()->addCacheableDependency($entity);
  }

  /**
   * Views a moderation note, and all its replies.
   *
   * @param \Drupal\moderation_note\ModerationNoteInterface $moderation_note
   *   The moderation note you want to view.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @return array
   *   A render array representing the moderation note.
   */
  public function viewNote(ModerationNoteInterface $moderation_note, Request $request) {
    $view_builder = $this->entityTypeManager()->getViewBuilder('moderation_note');
    $build = [
      '#type' => 'container',
      '#attributes' => ['class' => ['moderation-note-sidebar-wrapper']],
    ];

    // If this request was made from a preview, provide a return link.
    if ($request->get('from-preview', FALSE)) {
      $params = [
        'entity_type' => $moderation_note->getModeratedEntityTypeId(),
        'entity' => $moderation_note->getModeratedEntityId(),
      ];
      $build[] = [
        '#type' => 'link',
        '#url' => Url::fromRoute('moderation_note.list', $params),
        '#title' => $this->t('← Back'),
        '#attributes' => [
          'class' => ['use-ajax'],
          'data-dialog-type' => 'dialog',
          'data-dialog-renderer' => 'off_canvas',
        ],
      ];
    }

    $build[] = $view_builder->view($moderation_note);

    $replies = $moderation_note->getChildren();
    $build[] = $view_builder->viewMultiple($replies);

    if ($moderation_note->access('reply') && $moderation_note->isPublished()) {
      $note_storage = $this->entityTypeManager()->getStorage('moderation_note');
      $new_note = $note_storage->create([
        'parent' => $moderation_note,
        'entity_type' => $moderation_note->getModeratedEntityTypeId(),
        'entity_id' => $moderation_note->getModeratedEntityId(),
      ]);
      $build[] = $this->entityFormBuilder()->getForm($new_note, 'reply');
    }

    $build['#attached']['drupalSettings']['highlight_moderation_note'] = [
      'id' => $moderation_note->id(),
      'quote' => $moderation_note->getQuote(),
      'quote_offset' => $moderation_note->getQuoteOffset(),
    ];

    return $build;
  }

  /**
   * Lists all top-level notes for the given Entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity whose notes you want to view.
   *
   * @return array
   *   A render array representing multiple moderation notes.
   */
  public function listNotes(EntityInterface $entity) {
    $build = [];
    $storage = $this->entityTypeManager()->getStorage('moderation_note');
    $query = $storage
      ->getQuery();
    $ids = $query
      ->accessCheck(FALSE)
      ->condition('entity_type', $entity->getEntityTypeId())
      ->condition('entity_id', $entity->id())
      ->condition('entity_langcode', $this->languageManager()->getCurrentLanguage()->getId())
      ->sort('published', 'DESC')
      ->sort('created', 'DESC')
      ->notExists('parent')
      ->execute();

    if (empty($ids)) {
      $build[] = [
        '#markup' => $this->t('<p>There are no notes for this entity. Go create some!</p>'),
      ];
      CacheableMetadata::createFromRenderArray($build)
        ->addCacheTags(['moderation_note_list'])
        ->applyTo($build);
    }
    else {
      $view_builder = $this->entityTypeManager()->getViewBuilder('moderation_note');
      $notes = $storage->loadMultiple($ids);
      $build[] = $view_builder->viewMultiple($notes, 'preview');
    }

    return $build;
  }

  /**
   * Lists all assigned notes for the given User.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user being viewed.
   *
   * @return array
   *   A render array representing multiple moderation notes.
   */
  public function listAssignedNotes(UserInterface $user) {
    $build = [];
    $storage = $this->entityTypeManager()->getStorage('moderation_note');
    $query = $storage->getQuery();
    $ids = $query
      ->accessCheck(FALSE)
      ->condition('assignee', $user->id())
      ->condition('published', 1)
      ->execute();

    if (empty($ids)) {
      $build[] = [
        '#markup' => $this->t('<p>There are no assigned notes for this user.</p>'),
      ];
    }
    else {
      $view_builder = $this->entityTypeManager()->getViewBuilder('moderation_note');
      $notes = $storage->loadMultiple($ids);
      $build[] = $view_builder->viewMultiple($notes, 'preview');
    }

    return $build;
  }

  /**
   * Deletes a moderation note.
   *
   * @param \Drupal\moderation_note\ModerationNoteInterface $moderation_note
   *   The moderation note you want to delete.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   A response containing the delete form.
   */
  public function deleteNote(ModerationNoteInterface $moderation_note) {
    $response = new AjaxResponse();
    $selector = '[data-moderation-note-id="' . $moderation_note->id() . '"]';
    $content = $this->entityFormBuilder()->getForm($moderation_note, 'delete');
    $command = new ReplaceCommand($selector, $content);
    $response->addCommand($command);
    return $response;
  }

  /**
   * Resolves a moderation note.
   *
   * @param \Drupal\moderation_note\ModerationNoteInterface $moderation_note
   *   The moderation note you want to resolve.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   A response containing the delete form.
   */
  public function resolveNote(ModerationNoteInterface $moderation_note) {
    $response = new AjaxResponse();
    $selector = '[data-moderation-note-id="' . $moderation_note->id() . '"]';
    $content = $this->entityFormBuilder()->getForm($moderation_note, 'resolve');
    $command = new ReplaceCommand($selector, $content);
    $response->addCommand($command);
    return $response;
  }

  /**
   * Edits a moderation note.
   *
   * @param \Drupal\moderation_note\ModerationNoteInterface $moderation_note
   *   The moderation note you want to edit.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   A response containing the edit form.
   */
  public function editNote(ModerationNoteInterface $moderation_note) {
    $response = new AjaxResponse();
    $selector = '[data-moderation-note-id="' . $moderation_note->id() . '"]';
    $content = $this->entityFormBuilder()->getForm($moderation_note, 'edit');
    $command = new ReplaceCommand($selector, $content);
    $response->addCommand($command);
    return $response;
  }

  /**
   * Replies to a moderation note.
   *
   * @param \Drupal\moderation_note\ModerationNoteInterface $moderation_note
   *   The moderation note you want to reply to.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   A response containing the deletion form.
   */
  public function replyToNote(ModerationNoteInterface $moderation_note) {
    $note_storage = $this->entityTypeManager()->getStorage('moderation_note');
    $response = new AjaxResponse();
    $new_note = $note_storage->create([
      'parent' => $moderation_note,
      'entity_type' => $moderation_note->getModeratedEntityTypeId(),
      'entity_id' => $moderation_note->getModeratedEntityId(),
    ]);
    $content = $this->entityFormBuilder()->getForm($new_note, 'reply');
    $command = new AppendCommand('.moderation-note-sidebar-wrapper', $content);
    $response->addCommand($command);
    return $response;
  }

}