You are here

Home » API reference » Paragraphs frontend ui 8 » ParagraphsFrontendUIController.php

class ParagraphsFrontendUIController in Paragraphs frontend ui 8

Same name and namespace in other branches
  1. 8.2 src/Controller/ParagraphsFrontendUIController.php \Drupal\paragraphs_frontend_ui\Controller\ParagraphsFrontendUIController

Controller for up and down actions.

Hierarchy

Expanded class hierarchy of ParagraphsFrontendUIController

File

src/Controller/ParagraphsFrontendUIController.php, line 16

Namespace

Drupal\paragraphs_frontend_ui\Controller
View source 
class ParagraphsFrontendUIController extends ControllerBase {

  /**
   * Shift up a single paragraph.
   */
  public function up($paragraph, $js = 'nojs') {
    $paragraph = $paragraph
      ->getTranslation($this
      ->langcode());
    extract($this
      ->getParentData($paragraph));
    $paragraph_items = $parent->{$parent_field_name}
      ->getValue();
    foreach ($paragraph_items as $delta => $paragraph_item) {
      if ($paragraph_item['target_id'] == $paragraph
        ->id()) {
        if ($delta > 0) {
          $prev_paragraph = $paragraph_items[$delta - 1];
          $paragraph_items[$delta - 1] = $paragraph_items[$delta];
          $paragraph_items[$delta] = $prev_paragraph;
        }
        break;
      }
    }
    $parent->{$parent_field_name}
      ->setValue($paragraph_items);
    $parent
      ->save();
    return $this
      ->refreshWithAJaxResponse($parent, $parent_field_name);
  }

  /**
   * Shift down a single paragraph.
   */
  public function down($paragraph, $js = 'nojs') {
    $paragraph = $paragraph
      ->getTranslation($this
      ->langcode());
    extract($this
      ->getParentData($paragraph));
    $paragraph_items = $parent->{$parent_field_name}
      ->getValue();
    $numitems = count($paragraph_items);
    foreach ($paragraph_items as $delta => $paragraph_item) {
      if ($paragraph_item['target_id'] == $paragraph
        ->id()) {
        if ($delta < $numitems) {
          $next_paragraph = $paragraph_items[$delta + 1];
          $paragraph_items[$delta + 1] = $paragraph_items[$delta];
          $paragraph_items[$delta] = $next_paragraph;
        }
        break;
      }
    }
    $parent->{$parent_field_name}
      ->setValue($paragraph_items);
    $parent
      ->save();
    return $this
      ->refreshWithAJaxResponse($parent, $parent_field_name);
  }

  /**
   * Duplicate a paragraph.
   */
  public function duplicate($paragraph, $js = 'nojs') {
    $paragraph
      ->getTranslation($this
      ->langcode());
    extract($this
      ->getParentData($paragraph));
    $paragraph_items = $parent->{$parent_field_name}
      ->getValue();
    $paragraphs_new = [];
    foreach ($paragraph_items as $delta => $paragraph_item) {
      $paragraphs_new[] = $paragraph_item;
      if ($paragraph_item['target_id'] == $paragraph
        ->id()) {
        $cloned_paragraph = $paragraph
          ->createDuplicate();
        $cloned_paragraph
          ->save();
        $paragraphs_new[] = [
          'target_id' => $cloned_paragraph
            ->id(),
          'target_revision_id' => $cloned_paragraph
            ->getRevisionId(),
        ];
      }
    }
    $parent->{$parent_field_name}
      ->setValue($paragraphs_new);
    $parent
      ->save();
    return $this
      ->refreshWithAJaxResponse($parent, $parent_field_name);
  }

  /**
   * Select a paragraph type.
   */
  public function addSet($paragraph, $js = 'nojs') {
    $form = \Drupal::formBuilder()
      ->getForm('Drupal\\paragraphs_frontend_ui\\Form\\ParagraphsFrontendUIAddSet', $paragraph);
    return $form;
  }

  /**
   * Check if this is the first paragraph in an entity, if not, deny access.
   */
  public function accessUp($paragraph) {
    $paragraph = Paragraph::load($paragraph);
    extract($this
      ->getParentData($paragraph));
    $paragraph_items = $parent->{$parent_field_name}
      ->getValue();
    if ($paragraph_items[0]['target_id'] == $paragraph
      ->id()) {
      return AccessResult::forbidden();
    }
    else {
      return AccessResult::allowed();
    }
  }

  /**
   * Check if this is the last paragraph in an entity, if not, deny access.
   */
  public function accessDown($paragraph) {
    $paragraph = Paragraph::load($paragraph);
    extract($this
      ->getParentData($paragraph));
    $paragraph_items = $parent->{$parent_field_name}
      ->getValue();
    $last_item = end($paragraph_items);
    if ($last_item['target_id'] == $paragraph
      ->id()) {
      return AccessResult::forbidden();
    }
    else {
      return AccessResult::allowed();
    }
  }

  /**
   * Helper function to get the required data about the parent of the paragraph.
   */
  private function getParentData($paragraph) {
    $parent = $paragraph
      ->getParentEntity()
      ->getTranslation($this
      ->langcode());
    return [
      'parent' => $parent,
      'parent_type' => $parent
        ->getEntityTypeId(),
      'parent_bundle' => $parent
        ->getType(),
      'parent_entity_id' => $parent
        ->id(),
      'parent_field_name' => $paragraph
        ->get('parent_field_name')
        ->getValue()[0]['value'],
    ];
  }

  /**
   * Helper function to refresh the field with ajax.
   */
  private function refreshWithAJaxResponse($entity, $field_name) {
    $identifier = '[data-paragraphs-frontend-ui=' . $field_name . '-' . $entity
      ->id() . ']';
    $field = $entity
      ->get($field_name);
    $this
      ->forceValueLanguage($field, $this
      ->langcode());
    $response = new AjaxResponse();

    // Refresh the paragraphs field.
    $response
      ->addCommand(new ReplaceCommand($identifier, $field
      ->view('default')));
    return $response;
  }

  /**
   * Helper function to get the current langcode
   */
  private function langcode() {
    return $this
      ->languageManager()
      ->getCurrentLanguage()
      ->getId();
  }

  /**
   * After reloading a translated paragraph field with ajax,
   * the original language is shown instead of the translation
   * I am using the workaround provided in
   * https://www.drupal.org/project/paragraphs/issues/2753201#comment-11834096
   * to force the language
   *
   * @param \Drupal\Core\TypedData\TypedData $value
   * @param $language
   */
  function forceValueLanguage(TypedData &$value, $language) {
    $parent = $value
      ->getParent()
      ->getValue();
    if (!$parent
      ->hasTranslation($language)) {
      return;
    }
    $parent_translated = $parent
      ->getTranslation($language);
    $name = $value
      ->getName();
    $adapter = EntityAdapter::createFromEntity($parent_translated);
    $value
      ->setContext($name, $adapter);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
ParagraphsFrontendUIController::accessDown public function Check if this is the last paragraph in an entity, if not, deny access.
ParagraphsFrontendUIController::accessUp public function Check if this is the first paragraph in an entity, if not, deny access.
ParagraphsFrontendUIController::addSet public function Select a paragraph type.
ParagraphsFrontendUIController::down public function Shift down a single paragraph.
ParagraphsFrontendUIController::duplicate public function Duplicate a paragraph.
ParagraphsFrontendUIController::forceValueLanguage function After reloading a translated paragraph field with ajax, the original language is shown instead of the translation I am using the workaround provided in https://www.drupal.org/project/paragraphs/issues/2753201#comment-11834096 to force the language
ParagraphsFrontendUIController::getParentData private function Helper function to get the required data about the parent of the paragraph.
ParagraphsFrontendUIController::langcode private function Helper function to get the current langcode
ParagraphsFrontendUIController::refreshWithAJaxResponse private function Helper function to refresh the field with ajax.
ParagraphsFrontendUIController::up public function Shift up a single paragraph.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.