You are here

Home » API reference » Acquia Content Hub 8 » ContentHubImportQueueForm.php

class ContentHubImportQueueForm in Acquia Content Hub 8

Form for the Content Hub Import Queue.

@package Drupal\acquia_contenthub\Form

Hierarchy

Expanded class hierarchy of ContentHubImportQueueForm

1 string reference to 'ContentHubImportQueueForm'
acquia_contenthub.routing.yml in ./acquia_contenthub.routing.yml
acquia_contenthub.routing.yml

File

src/Form/ContentHubImportQueueForm.php, line 16

Namespace

Drupal\acquia_contenthub\Form
View source 
class ContentHubImportQueueForm extends ConfigFormBase {

  /**
   * The queue factory for running the import queue.
   *
   * @var \Drupal\Core\Queue\QueueFactory
   */
  protected $queueFactory;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, QueueFactory $queue_factory) {
    parent::__construct($config_factory);
    $this->queueFactory = $queue_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('queue'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'acquia_contenthub.import_queue_settings';
  }

  /**
   * {@inheritdoc}
   */
  public function getEditableConfigNames() {
    return [
      'acquia_contenthub.entity_config',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this->configFactory
      ->get('acquia_contenthub.entity_config');
    $form['description'] = [
      '#markup' => $this
        ->t('Instruct the content hub module to manage content syndication with a queue.'),
    ];
    $form['import_with_queue'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Import via queue'),
      '#description' => $this
        ->t('Enable content import queuing for this site'),
      '#default_value' => $config
        ->get('import_with_queue'),
    ];
    $form['import_queue_configuration'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Queue Settings'),
      '#states' => [
        'invisible' => [
          ':input[name="import_with_queue"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
      '#open' => TRUE,
    ];
    $number_of_items = [
      1,
      5,
      10,
      20,
      50,
      100,
      200,
      500,
      1000,
    ];
    $number_of_items = array_combine($number_of_items, $number_of_items);
    $form['import_queue_configuration']['batch_size'] = [
      '#type' => 'select',
      '#options' => [
        'all' => $this
          ->t('- All -'),
      ] + $number_of_items,
      '#title' => $this
        ->t('Queue batch size'),
      '#description' => $this
        ->t('Number of queue items that will be processed in the same batch queue process. This has an impact on the importing site, the higher the number the more time spent in a single batch process. Set to "1" by default.'),
      '#default_value' => $config
        ->get('import_queue_batch_size'),
    ];
    $wait_time = [
      3,
      5,
      10,
      15,
      30,
    ];
    $wait_time = array_combine($wait_time, $wait_time);

    // @todo remove import_queue_wait_time, not used anywhere.
    $form['import_queue_configuration']['wait_time'] = [
      '#type' => 'select',
      '#options' => $wait_time,
      '#title' => $this
        ->t('Queue waiting time between items'),
      '#description' => $this
        ->t('Waiting time in seconds between queue items being processed. This can be used to prevent stampeding and can be used with cron settings to control frequency.'),
      '#default_value' => $config
        ->get('import_queue_wait_time'),
    ];
    $form['run_import_queue'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Run the import queue'),
      '#description' => $this
        ->t('Manually process the remaining items in the queue.'),
      '#states' => [
        'invisible' => [
          ':input[name="import_with_queue"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['run_import_queue']['actions'] = [
      '#type' => 'actions',
    ];
    $queue_count = $this->queueFactory
      ->get('acquia_contenthub_import_queue')
      ->numberOfItems();
    $form['run_import_queue']['queue_list'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Number of items in the import queue'),
      '#description' => $this
        ->t('%num @items', [
        '%num' => $queue_count,
        '@items' => $queue_count == 1 ? 'item' : 'items',
      ]),
    ];
    $form['run_import_queue']['actions']['run'] = [
      '#type' => 'submit',
      '#name' => 'run_import_queue',
      '#value' => $this
        ->t('Run import queue'),
      '#op' => 'run',
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['save'] = [
      '#type' => 'submit',
      '#name' => 'import_queue_configuraiton',
      '#value' => $this
        ->t('Save configuration'),
      '#op' => 'save',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $trigger = $form_state
      ->getTriggeringElement();
    switch ($trigger['#op']) {
      case 'save':
        $config = $this
          ->config('acquia_contenthub.entity_config');
        $config
          ->set('import_with_queue', $form_state
          ->getValue('import_with_queue'));
        $config
          ->set('import_queue_batch_size', $form_state
          ->getValue('batch_size'));
        $config
          ->set('import_queue_wait_time', $form_state
          ->getValue('wait_time'));
        $config
          ->save();
        break;
      case 'run':
        $form_state
          ->setRedirect('acquia_contenthub.import_queue_batch');
        break;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
ContentHubImportQueueForm::$queueFactory protected property The queue factory for running the import queue.
ContentHubImportQueueForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
ContentHubImportQueueForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
ContentHubImportQueueForm::getEditableConfigNames public function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ContentHubImportQueueForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ContentHubImportQueueForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
ContentHubImportQueueForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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::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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
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.