class ContentHubExportQueueForm in Acquia Content Hub 8.2
Implements a form to Process items from the Content Hub Export Queue.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\acquia_contenthub_publisher\Form\ContentHubExportQueueForm
Expanded class hierarchy of ContentHubExportQueueForm
1 string reference to 'ContentHubExportQueueForm'
- acquia_contenthub_publisher.routing.yml in modules/
acquia_contenthub_publisher/ acquia_contenthub_publisher.routing.yml - modules/acquia_contenthub_publisher/acquia_contenthub_publisher.routing.yml
File
- modules/
acquia_contenthub_publisher/ src/ Form/ ContentHubExportQueueForm.php, line 13
Namespace
Drupal\acquia_contenthub_publisher\FormView source
class ContentHubExportQueueForm extends FormBase {
/**
* The Export Queue Service.
*
* @var \Drupal\acquia_contenthub_publisher\ContentHubExportQueue
*/
protected $contentHubExportQueue;
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'acquia_contenthub.export_queue_settings';
}
/**
* {@inheritdoc}
*/
public function __construct(ContentHubExportQueue $export_queue) {
$this->contentHubExportQueue = $export_queue;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('acquia_contenthub_publisher.acquia_contenthub_export_queue'));
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form['description'] = [
'#markup' => $this
->t('Instruct the content hub module to manage content export with a queue.'),
];
$queue_count = intval($this->contentHubExportQueue
->getQueueCount());
$form['run_export_queue'] = [
'#type' => 'details',
'#title' => $this
->t('Run Export Queue'),
'#description' => '<strong>For development & testing use only!</strong><br /> Running the export queue from the UI can cause php timeouts for large datasets.
A cronjob to run the queue should be used instead.',
'#open' => TRUE,
];
$form['run_export_queue']['queue-list'] = [
'#type' => 'item',
'#title' => $this
->t('Number of queue items in the Export Queue'),
'#description' => $this
->t('%num @items.', [
'%num' => $queue_count,
'@items' => $queue_count === 1 ? $this
->t('item') : $this
->t('items'),
]),
];
$form['run_export_queue']['submit'] = [
'#type' => 'submit',
'#value' => t('Export Items'),
'#name' => 'run_export_queue',
];
if ($queue_count > 0) {
$form['run_export_queue']['purge_queue'] = [
'#type' => 'item',
'#title' => $this
->t('Purge existing queues'),
'#description' => $this
->t('It is possible an existing queue has becomed orphaned, use this function to wipe all existing queues'),
];
$form['run_export_queue']['purge'] = [
'#type' => 'submit',
'#value' => t('Purge'),
'#name' => 'purge_export_queue',
];
}
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$queue_count = intval($this->contentHubExportQueue
->getQueueCount());
$trigger = $form_state
->getTriggeringElement();
switch ($trigger['#name']) {
case 'run_export_queue':
if (!empty($queue_count)) {
$this->contentHubExportQueue
->processQueueItems();
}
else {
$this
->messenger()
->addWarning($this
->t('You cannot run the export queue because it is empty.'));
}
break;
case 'purge_export_queue':
$this->contentHubExportQueue
->purgeQueues();
$this
->messenger()
->addMessage($this
->t('Purged all contenthub export queues.'));
break;
default:
break;
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContentHubExportQueueForm:: |
protected | property | The Export Queue Service. | |
ContentHubExportQueueForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
ContentHubExportQueueForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
ContentHubExportQueueForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
ContentHubExportQueueForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
ContentHubExportQueueForm:: |
public | function | ||
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |