class CourierMaintenanceForm in Courier 8

Courier maintenance form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\courier\Form\CourierMaintenanceForm

1 string reference to 'CourierMaintenanceForm'

courier.routing.yml in ./courier.routing.yml

courier.routing.yml

File

src/Form/CourierMaintenanceForm.php, line 18

Contains \Drupal\courier\Form\CourierMaintenanceForm.

Namespace

Drupal\courier\Form

class CourierMaintenanceForm extends FormBase {

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

  /**
   * Constructs a CourierMaintenanceForm object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['mqi'] = [
      '#type' => 'details',
      '#open' => TRUE,
    ];
    $form['mqi']['delete_age'] = [
      '#title' => $this
        ->t('Delete old messages'),
      '#description' => $this
        ->t('This is used to delete messages queue items that have gotten stuck in the queue.'),
      '#type' => 'number',
      '#field_prefix' => $this
        ->t('Delete message older than'),
      '#field_suffix' => $this
        ->t('seconds'),
      '#min' => 1,
      '#default_value' => 60 * 60 * 24,
    ];
    $form['mqi']['actions'] = [
      '#type' => 'actions',
    ];
    $form['mqi']['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Delete messages'),
      '#button_type' => 'danger',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $time = REQUEST_TIME - $form_state
      ->getValue('delete_age');
    $storage = $this->entityTypeManager
      ->getStorage('courier_message_queue_item');
    $ids = $storage
      ->getQuery()
      ->condition('created', $time, '<')
      ->execute();
    $storage
      ->delete($storage
      ->loadMultiple($ids));
    drupal_set_message($this
      ->formatPlural(count($ids), '@count message deleted.', '@count messages deleted.'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CourierMaintenanceForm::$entityTypeManager	protected	property	The entity type manager.
CourierMaintenanceForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
CourierMaintenanceForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
CourierMaintenanceForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
CourierMaintenanceForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
CourierMaintenanceForm::__construct	public	function	Constructs a CourierMaintenanceForm object.
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.
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.