class EdgeEntityDeleteForm in Apigee Edge 8

Default entity delete form implementation for Apigee Edge entities.

It requires from the user to type the "id" of the entity to confirm removal.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
  - class \Drupal\Core\Entity\EntityConfirmFormBase implements ConfirmFormInterface
    class \Drupal\Core\Entity\EntityDeleteForm uses EntityDeleteFormTrait
    class \Drupal\apigee_edge\Entity\Form\EdgeEntityDeleteForm

Expanded class hierarchy of EdgeEntityDeleteForm

1 file declares its use of EdgeEntityDeleteForm

TeamDeleteForm.php in modules/apigee_edge_teams/src/Entity/Form/TeamDeleteForm.php

File

src/Entity/Form/EdgeEntityDeleteForm.php, line 33

Namespace

Drupal\apigee_edge\Entity\Form

View source

class EdgeEntityDeleteForm extends EntityDeleteForm {

  /**
   * EdgeEntityDeleteForm constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {

    // Ensure the entity type manager is always initialized.
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $form['verification_code'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Type "%verification_code" to proceed', [
        '%verification_code' => $this
          ->verificationCode(),
      ]),
      '#default_value' => '',
      '#required' => TRUE,
      '#element_validate' => [
        '::validateVerificationCode',
      ],
    ];
    return $form;
  }

  /**
   * Element validate callback for the verification code form element.
   *
   * @param array $element
   *   Element to validate.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   * @param array $complete_form
   *   The complete form.
   */
  public final function validateVerificationCode(array &$element, FormStateInterface $form_state, array &$complete_form) {
    if ($element['#value'] !== $this
      ->verificationCode()) {
      $form_state
        ->setError($element, $this
        ->verificationCodeErrorMessage());
    }
  }

  /**
   * Returns the verification code that the user should provide to confirm.
   *
   * @return string
   *   The verification code.
   */
  protected function verificationCode() {

    // By default this it the entity's default entity id.
    return $this
      ->getEntity()
      ->id();
  }

  /**
   * The error message that the user should see when verification fails.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The error message to be displayed to the user.
   */
  protected function verificationCodeErrorMessage() {
    return $this
      ->t('The provided text does not match the id of @entity that you are attempting to delete.', [
      '@entity' => mb_strtolower($this->entityTypeManager
        ->getDefinition($this
        ->getEntity()
        ->getEntityTypeId())
        ->getSingularLabel()),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to delete the %label @entity-type?', [
      '@entity-type' => mb_strtolower($this
        ->getEntity()
        ->getEntityType()
        ->getSingularLabel()),
      '%label' => $this
        ->getEntity()
        ->label(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  protected function getDeletionMessage() {
    return $this
      ->t('The %label @entity-type has been deleted.', [
      '@entity-type' => mb_strtolower($this
        ->getEntity()
        ->getEntityType()
        ->getSingularLabel()),
      '%label' => $this
        ->getEntity()
        ->label(),
    ]);
  }

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

    // \Drupal\Core\Entity\EntityForm::buildEntity() would call set() on
    // $entity that only exists on config and content entities.
    // @see \Drupal\Core\Entity\EntityForm::copyFormValuesToEntity()
    return $this->entity;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigDependencyDeleteFormTrait::addDependencyListsToForm	protected	function	Adds form elements to list affected configuration entities.
ConfigDependencyDeleteFormTrait::t	abstract protected	function	Translates a string to the current language or to a given language.
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
EdgeEntityDeleteForm::buildEntity	public	function	Builds an updated entity object based upon the submitted form values. Overrides EntityForm::buildEntity
EdgeEntityDeleteForm::buildForm	public	function	Form constructor. Overrides EntityDeleteForm::buildForm
EdgeEntityDeleteForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
EdgeEntityDeleteForm::getDeletionMessage	protected	function	Gets the message to display to the user after deleting the entity. Overrides EntityDeleteFormTrait::getDeletionMessage
EdgeEntityDeleteForm::getQuestion	public	function	Overrides EntityDeleteFormTrait::getQuestion
EdgeEntityDeleteForm::validateVerificationCode	final public	function	Element validate callback for the verification code form element.
EdgeEntityDeleteForm::verificationCode	protected	function	Returns the verification code that the user should provide to confirm.	1
EdgeEntityDeleteForm::verificationCodeErrorMessage	protected	function	The error message that the user should see when verification fails.	2
EdgeEntityDeleteForm::__construct	public	function	EdgeEntityDeleteForm constructor.
EntityConfirmFormBase::actions	protected	function	Returns an array of supported actions for the current entity form. Overrides EntityForm::actions	1
EntityConfirmFormBase::delete	public	function	The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form.
EntityConfirmFormBase::getBaseFormId	public	function	Returns a string identifying the base form. Overrides EntityForm::getBaseFormId
EntityConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText
EntityConfirmFormBase::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription	10
EntityConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
EntityConfirmFormBase::save	public	function	The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. Overrides EntityForm::save
EntityDeleteForm::getConfigManager	protected	function	Gets the configuration manager.
EntityDeleteForm::getConfigNamesToDelete	protected	function	Returns config names to delete for the deletion confirmation form.	1
EntityDeleteFormTrait::getCancelUrl	public	function		3
EntityDeleteFormTrait::getConfirmText	public	function		1
EntityDeleteFormTrait::getEntity	abstract public	function	Gets the entity of this form.
EntityDeleteFormTrait::getRedirectUrl	protected	function	Returns the URL where the user should be redirected after deletion.	5
EntityDeleteFormTrait::logDeletionMessage	protected	function	Logs a message about the deleted entity.	2
EntityDeleteFormTrait::logger	abstract protected	function	Gets the logger for a specific channel.
EntityDeleteFormTrait::submitForm	public	function		4
EntityForm::$entity	protected	property	The entity being used by this form.	7
EntityForm::$entityTypeManager	protected	property	The entity type manager.	3
EntityForm::$moduleHandler	protected	property	The module handler service.
EntityForm::$operation	protected	property	The name of the current operation.
EntityForm::$privateEntityManager	private	property	The entity manager.
EntityForm::actionsElement	protected	function	Returns the action form element for the current entity form.
EntityForm::afterBuild	public	function	Form element #after_build callback: Updates the entity with submitted data.
EntityForm::copyFormValuesToEntity	protected	function	Copies top-level form values to entity properties	7
EntityForm::form	public	function	Gets the actual form array to be built.	30
EntityForm::getEntityFromRouteMatch	public	function	Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch	1
EntityForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId	10
EntityForm::getOperation	public	function	Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init	protected	function	Initialize the form state and the entity before the first form build.	3
EntityForm::prepareEntity	protected	function	Prepares the entity object before the form is built first.	3
EntityForm::prepareInvokeAll	protected	function	Invokes the specified prepare hook variant.
EntityForm::processForm	public	function	Process callback: assigns weights and hides extra fields.
EntityForm::setEntity	public	function	Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityManager	public	function	Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
EntityForm::setEntityTypeManager	public	function	Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler	public	function	Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation	public	function	Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::__get	public	function
EntityForm::__set	public	function
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::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
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 EdgeEntityDeleteForm in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation