You are here

Home » API reference » Entity Share 8.2 » PullForm.php

class PullForm in Entity Share 8.2

Same name and namespace in other branches
  1. 8.3 modules/entity_share_client/src/Form/PullForm.php \Drupal\entity_share_client\Form\PullForm
  2. 8 modules/entity_share_client/src/Form/PullForm.php \Drupal\entity_share_client\Form\PullForm

Form controller to pull entities.

Hierarchy

Expanded class hierarchy of PullForm

1 string reference to 'PullForm'
entity_share_client.routing.yml in modules/entity_share_client/entity_share_client.routing.yml
modules/entity_share_client/entity_share_client.routing.yml

File

modules/entity_share_client/src/Form/PullForm.php, line 31

Namespace

Drupal\entity_share_client\Form
View source 
class PullForm extends FormBase {

  /**
   * The remote websites known from the website.
   *
   * @var \Drupal\entity_share_client\Entity\RemoteInterface[]
   */
  protected $remoteWebsites;

  /**
   * An array of channel infos as returned by entity_share_server entry point.
   *
   * @var array
   */
  protected $channelsInfos;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity definition update manager.
   *
   * @var \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface
   */
  protected $entityDefinitionUpdateManager;

  /**
   * The remote manager.
   *
   * @var \Drupal\entity_share_client\Service\RemoteManagerInterface
   */
  protected $remoteManager;

  /**
   * The jsonapi helper.
   *
   * @var \Drupal\entity_share_client\Service\JsonapiHelperInterface
   */
  protected $jsonapiHelper;

  /**
   * Query string parameters ($_GET).
   *
   * @var \Symfony\Component\HttpFoundation\ParameterBag
   */
  protected $query;

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The request service.
   *
   * @var \Drupal\entity_share_client\Service\RequestServiceInterface
   */
  protected $requestService;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The pager manager service.
   *
   * @var \Drupal\Core\Pager\PagerManagerInterface
   */
  protected $pagerManager;

  /**
   * Constructs a ContentEntityForm object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface $entity_definition_update_manager
   *   The entity definition update manager.
   * @param \Drupal\entity_share_client\Service\RemoteManagerInterface $remote_manager
   *   The remote manager service.
   * @param \Drupal\entity_share_client\Service\JsonapiHelperInterface $jsonapi_helper
   *   The jsonapi helper service.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\entity_share_client\Service\RequestServiceInterface $request_service
   *   The request service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Pager\PagerManagerInterface $pager_manager
   *   The pager manager service.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, EntityDefinitionUpdateManagerInterface $entity_definition_update_manager, RemoteManagerInterface $remote_manager, JsonapiHelperInterface $jsonapi_helper, RequestStack $request_stack, LanguageManagerInterface $language_manager, RequestServiceInterface $request_service, RendererInterface $renderer, ModuleHandlerInterface $module_handler, PagerManagerInterface $pager_manager) {
    $this->entityTypeManager = $entity_type_manager;
    $this->entityDefinitionUpdateManager = $entity_definition_update_manager;
    $this->remoteWebsites = $entity_type_manager
      ->getStorage('remote')
      ->loadMultiple();
    $this->remoteManager = $remote_manager;
    $this->jsonapiHelper = $jsonapi_helper;
    $this->query = $request_stack
      ->getCurrentRequest()->query;
    $this->languageManager = $language_manager;
    $this->requestService = $request_service;
    $this->renderer = $renderer;
    $this->moduleHandler = $module_handler;
    $this->pagerManager = $pager_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('entity.definition_update_manager'), $container
      ->get('entity_share_client.remote_manager'), $container
      ->get('entity_share_client.jsonapi_helper'), $container
      ->get('request_stack'), $container
      ->get('language_manager'), $container
      ->get('entity_share_client.request'), $container
      ->get('renderer'), $container
      ->get('module_handler'), $container
      ->get('pager.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'entity_share_client_pull_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $remote_options = $this
      ->prepareRemoteOptions();
    $remote_disabled = FALSE;
    $remote_default_value = $this->query
      ->get('remote');

    // If only one option. Pre-select it and disable the select.
    if (count($remote_options) == 1) {
      $remote_disabled = TRUE;
      $remote_default_value = key($remote_options);
      $form_state
        ->setValue('remote', $remote_default_value);
    }
    $form['remote'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Remote website'),
      '#options' => $remote_options,
      '#default_value' => $remote_default_value,
      '#empty_value' => '',
      '#required' => TRUE,
      '#disabled' => $remote_disabled,
      '#ajax' => [
        'callback' => [
          get_class($this),
          'buildAjaxChannelSelect',
        ],
        'effect' => 'fade',
        'method' => 'replace',
        'wrapper' => 'channel-wrapper',
      ],
    ];

    // Container for the AJAX.
    $form['channel_wrapper'] = [
      '#type' => 'container',
      // Force an id because otherwise default id is changed when using AJAX.
      '#attributes' => [
        'id' => 'channel-wrapper',
      ],
    ];
    $this
      ->buildChannelSelect($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * Ensure at least one entity is selected.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function validateSelectedEntities(array &$form, FormStateInterface $form_state) {
    $selected_entities = $form_state
      ->getValue('entities');
    if (!is_null($selected_entities)) {
      $selected_entities = array_filter($selected_entities);
      if (empty($selected_entities)) {
        $form_state
          ->setErrorByName('entities', $this
          ->t('You must select at least one entity.'));
      }
    }
  }

  /**
   * Form submission handler for the 'synchronize' action.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function synchronizeSelectedEntities(array &$form, FormStateInterface $form_state) {
    $selected_entities = $form_state
      ->getValue('entities');
    $selected_entities = array_filter($selected_entities);
    $selected_remote = $form_state
      ->getValue('remote');
    $selected_channel = $form_state
      ->getValue('channel');
    $searched_text = $form_state
      ->getValue('search', '');
    $redirect_parameters = [
      'query' => [
        'remote' => $selected_remote,
        'channel' => $selected_channel,
        'search' => $searched_text,
      ],
    ];
    $get_offset = $this->query
      ->get('offset');
    if (!is_null($get_offset) && is_numeric($get_offset)) {
      $redirect_parameters['query']['offset'] = $get_offset;
    }
    $get_page = $this->query
      ->get('page');
    if (!is_null($get_page) && is_numeric($get_page)) {
      $redirect_parameters['query']['page'] = $get_page;
    }
    $get_sort = $this->query
      ->get('sort', '');
    if (!empty($get_sort)) {
      $redirect_parameters['query']['sort'] = $get_sort;
    }
    $get_order = $this->query
      ->get('order', '');
    if (!empty($get_order)) {
      $redirect_parameters['query']['order'] = $get_order;
    }
    $form_state
      ->setRedirect('entity_share_client.admin_content_pull_form', [], $redirect_parameters);

    // Add the selected UUIDs to the URL.
    // We do not handle offset or limit as we provide a maximum of 50 UUIDs.
    $url = $this->channelsInfos[$selected_channel]['url'];
    $parsed_url = UrlHelper::parse($url);
    $query = $parsed_url['query'];
    $query['filter']['uuid-filter'] = [
      'condition' => [
        'path' => 'id',
        'operator' => 'IN',
        'value' => array_values($selected_entities),
      ],
    ];
    $query = UrlHelper::buildQuery($query);
    $prepared_url = $parsed_url['path'] . '?' . $query;
    $selected_remote = $this->remoteWebsites[$selected_remote];
    $http_client = $this->remoteManager
      ->prepareJsonApiClient($selected_remote);
    $response = $this->requestService
      ->request($http_client, 'GET', $prepared_url);
    $json = Json::decode((string) $response
      ->getBody());
    if (!isset($json['errors'])) {
      $batch = [
        'title' => $this
          ->t('Synchronize entities'),
        'operations' => [
          [
            '\\Drupal\\entity_share_client\\JsonapiBatchHelper::importEntityListBatch',
            [
              $selected_remote,
              EntityShareUtility::prepareData($json['data']),
            ],
          ],
        ],
        'finished' => '\\Drupal\\entity_share_client\\JsonapiBatchHelper::importEntityListBatchBatchFinished',
      ];
      batch_set($batch);
    }
  }

  /**
   * Helper function.
   *
   * @return string[]
   *   An array of remote websites.
   */
  protected function prepareRemoteOptions() {
    $options = [];
    foreach ($this->remoteWebsites as $id => $remote_website) {
      $options[$id] = $remote_website
        ->label();
    }
    return $options;
  }

  /**
   * Helper function.
   *
   * @return string[]
   *   An array of remote channels.
   */
  protected function getChannelOptions() {
    $options = [];
    foreach ($this->channelsInfos as $channel_id => $channel_infos) {
      $options[$channel_id] = $channel_infos['label'];
    }
    return $options;
  }

  /**
   * Ajax callback.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @return array
   *   Subform.
   */
  public static function buildAjaxChannelSelect(array $form, FormStateInterface $form_state) {

    // We just need to return the relevant part of the form here.
    return $form['channel_wrapper'];
  }

  /**
   * Ajax callback.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   *
   * @return array
   *   Subform.
   */
  public static function buildAjaxEntitiesSelectTable(array $form, FormStateInterface $form_state) {

    // We just need to return the relevant part of the form here.
    return $form['channel_wrapper']['entities_wrapper'];
  }

  /**
   * Helper function to generate channel select.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   */
  protected function buildChannelSelect(array &$form, FormStateInterface $form_state) {
    $selected_remote = $form_state
      ->getValue('remote', $this->query
      ->get('remote'));

    // No remote selected.
    if (empty($this->remoteWebsites[$selected_remote])) {
      return;
    }
    $selected_remote = $this->remoteWebsites[$selected_remote];
    $this->channelsInfos = $this->remoteManager
      ->getChannelsInfos($selected_remote);
    $channel_options = $this
      ->getChannelOptions();
    $channel_disabled = FALSE;
    $channel_default_value = $this->query
      ->get('channel');

    // If only one channel. Pre-select it and disable the select.
    if (count($channel_options) == 1) {
      $channel_disabled = TRUE;
      $channel_default_value = key($channel_options);
      $form_state
        ->setValue('channel', $channel_default_value);
    }
    $form['channel_wrapper']['channel'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Channel'),
      '#options' => $channel_options,
      '#default_value' => $channel_default_value,
      '#empty_value' => '',
      '#required' => TRUE,
      '#disabled' => $channel_disabled,
      '#ajax' => [
        'callback' => [
          get_class($this),
          'buildAjaxEntitiesSelectTable',
        ],
        'effect' => 'fade',
        'method' => 'replace',
        'wrapper' => 'entities-wrapper',
      ],
    ];

    // Container for the AJAX.
    $form['channel_wrapper']['entities_wrapper'] = [
      '#type' => 'container',
      // Force an id because otherwise default id is changed when using AJAX.
      '#attributes' => [
        'id' => 'entities-wrapper',
      ],
    ];
    $this
      ->buildEntitiesSelectTable($form, $form_state);
  }

  /**
   * Helper function to generate entities table.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state object.
   */
  protected function buildEntitiesSelectTable(array &$form, FormStateInterface $form_state) {
    $triggering_element = $form_state
      ->getTriggeringElement();

    // Form state by default, else from query.
    $selected_remote = $form_state
      ->getValue('remote', $this->query
      ->get('remote'));
    $selected_channel = $form_state
      ->getValue('channel', $this->query
      ->get('channel'));

    // If Ajax was triggered set offset to default value: 0.
    $offset = !is_array($triggering_element) ? $this->query
      ->get('offset', 0) : 0;
    if (!is_array($triggering_element) && is_numeric($this->query
      ->get('page'))) {
      $offset = $this->query
        ->get('page') * 50;
    }
    if (empty($this->remoteWebsites[$selected_remote]) || empty($this->channelsInfos[$selected_channel])) {
      return;
    }
    $selected_remote_id = $selected_remote;
    $selected_remote = $this->remoteWebsites[$selected_remote];
    $http_client = $this->remoteManager
      ->prepareJsonApiClient($selected_remote);
    $parsed_url = UrlHelper::parse($this->channelsInfos[$selected_channel]['url']);

    // Add offset to the selected channel.
    $parsed_url['query']['page']['offset'] = $offset;

    // Handle search.
    $searched_text = $form_state
      ->getValue('search', '');
    if (empty($searched_text)) {
      $triggering_element = $form_state
        ->getTriggeringElement();
      $get_searched_text = $this->query
        ->get('search', '');

      // If it is not an ajax trigger, check if it is in the GET parameters.
      if (!is_array($triggering_element) && !empty($get_searched_text)) {
        $searched_text = $get_searched_text;
      }
    }
    if (!empty($searched_text)) {
      $search_filter_and_group = [
        'channel_searched_text_group' => [
          'group' => [
            'conjunction' => 'OR',
          ],
        ],
      ];
      foreach ($this->channelsInfos[$selected_channel]['search_configuration'] as $search_key => $search_info) {
        $search_filter_and_group['search_filter_' . $search_key] = [
          'condition' => [
            'path' => $search_info['path'],
            'operator' => 'CONTAINS',
            'value' => $searched_text,
            'memberOf' => 'channel_searched_text_group',
          ],
        ];
      }
      $parsed_url['query']['filter'] = isset($parsed_url['query']['filter']) ? array_merge_recursive($parsed_url['query']['filter'], $search_filter_and_group) : $search_filter_and_group;
    }

    // Change the sort if a sort had been selected.
    $sort_field = $this->query
      ->get('order', '');
    $sort_direction = $this->query
      ->get('sort', '');
    $sort_context = [
      'name' => $sort_field,
      'sort' => $sort_direction,
      'query' => [
        'remote' => $selected_remote_id,
        'channel' => $selected_channel,
        'search' => $searched_text,
      ],
    ];
    if (!empty($sort_field) && !empty($sort_direction) && isset($this->channelsInfos[$selected_channel]['field_mapping'][$sort_field])) {
      $parsed_url['query']['sort'] = [
        $sort_field => [
          'path' => $this->channelsInfos[$selected_channel]['field_mapping'][$sort_field],
          'direction' => strtoupper($sort_direction),
        ],
      ];
    }
    $query = UrlHelper::buildQuery($parsed_url['query']);
    $prepared_url = $parsed_url['path'] . '?' . $query;
    $response = $this->requestService
      ->request($http_client, 'GET', $prepared_url);
    $json = Json::decode((string) $response
      ->getBody());

    // Search.
    $form['channel_wrapper']['entities_wrapper']['search'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Search'),
      '#default_value' => $searched_text,
      '#weight' => -20,
      '#ajax' => [
        'callback' => [
          get_class($this),
          'buildAjaxEntitiesSelectTable',
        ],
        'disable-refocus' => TRUE,
        'effect' => 'fade',
        'keypress' => TRUE,
        'method' => 'replace',
        'wrapper' => 'entities-wrapper',
      ],
    ];
    if (isset($this->channelsInfos[$selected_channel]['search_configuration']) && !empty($this->channelsInfos[$selected_channel]['search_configuration'])) {
      $search_list = [
        '#theme' => 'item_list',
        '#items' => [],
      ];
      foreach ($this->channelsInfos[$selected_channel]['search_configuration'] as $search_info) {
        $search_list['#items'][] = $search_info['label'];
      }
      $search_list = $this->renderer
        ->render($search_list);
      $search_description = $this
        ->t('The search (CONTAINS operator) will occur on the following fields:') . $search_list;
    }
    else {
      $search_description = $this
        ->t('There is no field on the server site to search on this channel.');
    }
    $form['channel_wrapper']['entities_wrapper']['search']['#description'] = $search_description;

    // Full pager.
    if (isset($json['meta']['count'])) {
      $this->pagerManager
        ->createPager($json['meta']['count'], 50);
      $form['channel_wrapper']['entities_wrapper']['pager'] = [
        '#type' => 'pager',
        '#route_name' => 'entity_share_client.admin_content_pull_form',
        '#parameters' => [
          'remote' => $selected_remote_id,
          'channel' => $selected_channel,
          'search' => $searched_text,
          'order' => $sort_field,
          'sort' => $sort_direction,
        ],
        '#attached' => [
          'library' => [
            'entity_share_client/full-pager',
          ],
        ],
      ];
    }
    else {

      // Store the JSON:API links to use its in the pager submit handlers.
      $storage = $form_state
        ->getStorage();
      $storage['links'] = $json['links'];
      $form_state
        ->setStorage($storage);

      // Pager.
      $form['channel_wrapper']['entities_wrapper']['pager'] = [
        '#type' => 'actions',
        '#weight' => -10,
      ];
      if (isset($json['links']['first']['href'])) {
        $form['channel_wrapper']['entities_wrapper']['pager']['first'] = [
          '#type' => 'submit',
          '#value' => $this
            ->t('First'),
          '#submit' => [
            '::firstPage',
          ],
        ];
      }
      if (isset($json['links']['prev']['href'])) {
        $form['channel_wrapper']['entities_wrapper']['pager']['prev'] = [
          '#type' => 'submit',
          '#value' => $this
            ->t('Previous'),
          '#submit' => [
            '::prevPage',
          ],
        ];
      }
      if (isset($json['links']['next']['href'])) {
        $form['channel_wrapper']['entities_wrapper']['pager']['next'] = [
          '#type' => 'submit',
          '#value' => $this
            ->t('Next'),
          '#submit' => [
            '::nextPage',
          ],
        ];
      }
      if (isset($json['links']['last']['href'])) {
        $form['channel_wrapper']['entities_wrapper']['pager']['last'] = [
          '#type' => 'submit',
          '#value' => $this
            ->t('Last'),
          '#submit' => [
            '::lastPage',
          ],
        ];
      }
    }
    if (!empty($sort_field) || !empty($sort_direction)) {
      $form['channel_wrapper']['entities_wrapper']['reset_sort'] = [
        '#type' => 'actions',
        '#weight' => -15,
        'reset_sort' => [
          '#type' => 'submit',
          '#value' => $this
            ->t('Reset sort'),
          '#submit' => [
            '::resetSort',
          ],
        ],
      ];
    }
    $form['channel_wrapper']['entities_wrapper']['actions_top']['#type'] = 'actions';
    $form['channel_wrapper']['entities_wrapper']['actions_top']['#weight'] = -1;
    $form['channel_wrapper']['entities_wrapper']['actions_top']['synchronize'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Synchronize entities'),
      '#button_type' => 'primary',
      '#validate' => [
        '::validateSelectedEntities',
      ],
      '#submit' => [
        '::synchronizeSelectedEntities',
      ],
    ];

    // Table to select entities.
    $header = [
      'label' => $this
        ->getHeader($this
        ->t('Label'), 'label', $sort_context),
      'type' => $this
        ->t('Type'),
      'bundle' => $this
        ->t('Bundle'),
      'language' => $this
        ->t('Language'),
      'changed' => $this
        ->getHeader($this
        ->t('Remote entity changed date'), 'changed', $sort_context),
      'status' => $this
        ->t('Status'),
    ];
    $form['channel_wrapper']['entities_wrapper']['entities'] = [
      '#type' => 'tableselect',
      '#header' => $header,
      '#options' => $this->jsonapiHelper
        ->buildEntitiesOptions($json['data'], $selected_remote, $selected_channel),
      '#empty' => $this
        ->t('No entities to be pulled have been found.'),
      '#attached' => [
        'library' => [
          'entity_share_client/admin',
        ],
      ],
    ];
    if ($this->moduleHandler
      ->moduleExists('diff')) {
      $form['channel_wrapper']['entities_wrapper']['entities']['#attached']['library'][] = 'core/drupal.dialog.ajax';
    }
    $form['channel_wrapper']['entities_wrapper']['actions_bottom']['#type'] = 'actions';
    $form['channel_wrapper']['entities_wrapper']['actions_bottom']['synchronize'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Synchronize entities'),
      '#button_type' => 'primary',
      '#validate' => [
        '::validateSelectedEntities',
      ],
      '#submit' => [
        '::synchronizeSelectedEntities',
      ],
    ];
  }

  /**
   * Helper function.
   *
   * Prepare a header sortable link.
   *
   * Inspired from \Drupal\Core\Utility\TableSort::header().
   *
   * @param \Drupal\Component\Render\MarkupInterface $header
   *   The header label.
   * @param string $header_machine_name
   *   The header machine name.
   * @param array $context
   *   The context of sort.
   *
   * @return array
   *   A sort link to be put in a table header.
   */
  protected function getHeader(MarkupInterface $header, $header_machine_name, array $context) {
    $cell = [];
    $title = new TranslatableMarkup('sort by @s', [
      '@s' => $header,
    ]);
    if ($header_machine_name == $context['name']) {

      // aria-sort is a WAI-ARIA property that indicates if items in a table
      // or grid are sorted in ascending or descending order. See
      // http://www.w3.org/TR/wai-aria/states_and_properties#aria-sort
      $cell['aria-sort'] = $context['sort'] == 'asc' ? 'ascending' : 'descending';
      $context['sort'] = $context['sort'] == 'asc' ? 'desc' : 'asc';
      $cell['class'][] = 'is-active';
      $tablesort_indicator = [
        '#theme' => 'tablesort_indicator',
        '#style' => $context['sort'],
      ];
      $image = $this->renderer
        ->render($tablesort_indicator);
    }
    else {

      // If the user clicks a different header, we want to sort ascending
      // initially.
      $context['sort'] = 'asc';
      $image = '';
    }
    $cell['data'] = Link::createFromRoute(new FormattableMarkup('@cell_content@image', [
      '@cell_content' => $header,
      '@image' => $image,
    ]), '<current>', [], [
      'attributes' => [
        'title' => $title,
      ],
      'query' => array_merge($context['query'], [
        'sort' => $context['sort'],
        'order' => $header_machine_name,
      ]),
    ]);
    return $cell;
  }

  /**
   * Form submission handler to go to the first pager page.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function firstPage(array &$form, FormStateInterface $form_state) {
    $this
      ->pagerRedirect($form_state, 'first');
  }

  /**
   * Form submission handler to go to the previous pager page.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function prevPage(array &$form, FormStateInterface $form_state) {
    $this
      ->pagerRedirect($form_state, 'prev');
  }

  /**
   * Form submission handler to go to the next pager page.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function nextPage(array &$form, FormStateInterface $form_state) {
    $this
      ->pagerRedirect($form_state, 'next');
  }

  /**
   * Form submission handler to go to the last pager page.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function lastPage(array &$form, FormStateInterface $form_state) {
    $this
      ->pagerRedirect($form_state, 'last');
  }

  /**
   * Helper function to redirect with the form to right page to handle pager.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param string $link_name
   *   The link name. Possibles values: first, prev, next, last.
   */
  protected function pagerRedirect(FormStateInterface $form_state, $link_name) {
    $storage = $form_state
      ->getStorage();
    if (isset($storage['links'][$link_name]['href'])) {
      $parsed_url = UrlHelper::parse($storage['links'][$link_name]['href']);
      if (isset($parsed_url['query']['page']) && isset($parsed_url['query']['page']['offset'])) {
        $form_state
          ->setRedirect('entity_share_client.admin_content_pull_form', [], [
          'query' => [
            'remote' => $form_state
              ->getValue('remote'),
            'channel' => $form_state
              ->getValue('channel'),
            'offset' => $parsed_url['query']['page']['offset'],
            'search' => $form_state
              ->getValue('search'),
            'order' => $this->query
              ->get('order', ''),
            'sort' => $this->query
              ->get('sort', ''),
          ],
        ]);
      }
    }
  }

  /**
   * Form submission handler to reset the sort.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function resetSort(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setRedirect('entity_share_client.admin_content_pull_form', [], [
      'query' => [
        'remote' => $form_state
          ->getValue('remote'),
        'channel' => $form_state
          ->getValue('channel'),
        'search' => $form_state
          ->getValue('search'),
      ],
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
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.
PullForm::$channelsInfos protected property An array of channel infos as returned by entity_share_server entry point.
PullForm::$entityDefinitionUpdateManager protected property The entity definition update manager.
PullForm::$entityTypeManager protected property The entity type manager.
PullForm::$jsonapiHelper protected property The jsonapi helper.
PullForm::$languageManager protected property The language manager.
PullForm::$moduleHandler protected property The module handler service.
PullForm::$pagerManager protected property The pager manager service.
PullForm::$query protected property Query string parameters ($_GET).
PullForm::$remoteManager protected property The remote manager.
PullForm::$remoteWebsites protected property The remote websites known from the website.
PullForm::$renderer protected property The renderer service.
PullForm::$requestService protected property The request service.
PullForm::buildAjaxChannelSelect public static function Ajax callback.
PullForm::buildAjaxEntitiesSelectTable public static function Ajax callback.
PullForm::buildChannelSelect protected function Helper function to generate channel select.
PullForm::buildEntitiesSelectTable protected function Helper function to generate entities table.
PullForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
PullForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
PullForm::firstPage public function Form submission handler to go to the first pager page.
PullForm::getChannelOptions protected function Helper function.
PullForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PullForm::getHeader protected function Helper function.
PullForm::lastPage public function Form submission handler to go to the last pager page.
PullForm::nextPage public function Form submission handler to go to the next pager page.
PullForm::pagerRedirect protected function Helper function to redirect with the form to right page to handle pager.
PullForm::prepareRemoteOptions protected function Helper function.
PullForm::prevPage public function Form submission handler to go to the previous pager page.
PullForm::resetSort public function Form submission handler to reset the sort.
PullForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
PullForm::synchronizeSelectedEntities public function Form submission handler for the 'synchronize' action.
PullForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
PullForm::validateSelectedEntities public function Ensure at least one entity is selected.
PullForm::__construct public function Constructs a ContentEntityForm object.
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.