class DeleteForm in Optimizely 8

Implements the confirmation form for deleting a project.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
    • class \Drupal\optimizely\DeleteForm

1 string reference to 'DeleteForm'

optimizely.routing.yml in ./optimizely.routing.yml

optimizely.routing.yml

File

src/DeleteForm.php, line 12

Namespace

Drupal\optimizely

class DeleteForm extends ConfirmFormBase {
  private $oid = NULL;

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'optimizely-delete-page-confirm';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {

    // More like a heading than a question.
    return $this
      ->t('Delete');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('Are you sure you want to delete this configuration?
                    <p>This action cannot be undone.</p>');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {

    // Default is 'Confirm'.
    return $this
      ->t('Delete');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('optimizely.listing');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $oid = NULL) {

    // Implement this method so we can record the project id for submitForm().
    $this->oid = $oid;
    return parent::buildForm($form, $form_state);
  }

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

    // Prevent deletion of default project.
    if ($this->oid == 1) {
      drupal_set_message($this
        ->t('Default project cannot be deleted.'), 'error');

      // Return to project listing page.
      $form_state
        ->setRedirect('optimizely.listing');
      return;
    }

    // Lookup entry details before delete.
    $query = \Drupal::database()
      ->select('optimizely', 'o', [
      'target' => 'slave',
    ])
      ->fields('o', [
      'path',
      'enabled',
    ])
      ->condition('o.oid', $this->oid, '=');
    $record = $query
      ->execute()
      ->fetchObject();

    // Delete entry in database based on the target $oid.
    $query = \Drupal::database()
      ->delete('optimizely')
      ->condition('oid', $this->oid);
    $query
      ->execute();

    // Only clear page cache for entries that are active when deleted.
    if ($record->enabled) {

      // Always serialized when saved.
      $path_array = unserialize($record->path);
      CacheRefresher::doRefresh($path_array);
    }
    drupal_set_message(t('The project entry has been deleted.'), 'status');

    // Return to project listing page.
    $form_state
      ->setRedirect('optimizely.listing');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	1
ConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DeleteForm::$oid	private	property
DeleteForm::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm
DeleteForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
DeleteForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
DeleteForm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
DeleteForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
DeleteForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
DeleteForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.