class OrphanedCompositeEntitiesDeleteForm in Entity Reference Revisions 8

Class OrphanedCompositeEntitiesDeleteForm.

@package Drupal\entity_reference_revisions\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\entity_reference_revisions\Form\OrphanedCompositeEntitiesDeleteForm

Expanded class hierarchy of OrphanedCompositeEntitiesDeleteForm

1 string reference to 'OrphanedCompositeEntitiesDeleteForm'

entity_reference_revisions.routing.yml in ./entity_reference_revisions.routing.yml: entity_reference_revisions.routing.yml

File

src/Form/OrphanedCompositeEntitiesDeleteForm.php, line 17

Namespace

Drupal\entity_reference_revisions\Form

View source

class OrphanedCompositeEntitiesDeleteForm extends FormBase {

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

  /**
   * The messenger.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * The entity reference revisions orphan purger service.
   *
   * @var \Drupal\entity_reference_revisions\EntityReferenceRevisionsOrphanPurger
   */
  protected $purger;

  /**
   * OrphanedCompositeEntitiesDeleteForm constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager
   *   The EntityTypeManager service.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   * @param \Drupal\entity_reference_revisions\EntityReferenceRevisionsOrphanPurger $purger
   *   The entity reference revisions orphan purger.
   */
  public function __construct(EntityTypeManagerInterface $entity_manager, MessengerInterface $messenger, EntityReferenceRevisionsOrphanPurger $purger) {
    $this->entityTypeManager = $entity_manager;
    $this->messenger = $messenger;
    $this->purger = $purger;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->messenger
      ->addWarning($this
      ->t('The submission of the current form can cause the deletion of entities that are still used, backup all data first.'), 'warning');
    $form['description'] = [
      '#markup' => $this
        ->t('Delete orphaned composite entities revisions that are no longer referenced. If there are no revisions left, the entity will be deleted as long as it is not used.'),
    ];
    $options = [];
    foreach ($this->purger
      ->getCompositeEntityTypes() as $entity_type) {
      $options[$entity_type
        ->id()] = $entity_type
        ->getLabel();
    }
    $form['composite_entity_types'] = [
      '#type' => 'checkboxes',
      '#required' => TRUE,
      '#title' => $this
        ->t('Select the entity types to check for orphans'),
      '#options' => $options,
      '#default_value' => array_keys($options),
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#value' => $this
        ->t('Delete orphaned composite revisions'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->purger
      ->setBatch(array_filter($form_state
      ->getValue('composite_entity_types')));
  }

}

Members

Name	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.
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	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OrphanedCompositeEntitiesDeleteForm::$entityTypeManager	protected	property	The Entity type manager service.
OrphanedCompositeEntitiesDeleteForm::$messenger	protected	property	The messenger. Overrides MessengerTrait::$messenger
OrphanedCompositeEntitiesDeleteForm::$purger	protected	property	The entity reference revisions orphan purger service.
OrphanedCompositeEntitiesDeleteForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
OrphanedCompositeEntitiesDeleteForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
OrphanedCompositeEntitiesDeleteForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
OrphanedCompositeEntitiesDeleteForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
OrphanedCompositeEntitiesDeleteForm::__construct	public	function	OrphanedCompositeEntitiesDeleteForm constructor.
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.

You are here

class OrphanedCompositeEntitiesDeleteForm in Entity Reference Revisions 8

Hierarchy

File

Namespace

Members

API Navigation