class RestExampleClientDelete in Examples for Developers 3.x

Delete a new node on a remote Drupal site.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
    • class \Drupal\rest_example\Form\RestExampleClientDelete

Related topics

Example: REST

This module will give you a brief demonstration of how the REST service works.

1 string reference to 'RestExampleClientDelete'

rest_example.routing.yml in modules/rest_example/rest_example.routing.yml

modules/rest_example/rest_example.routing.yml

File

modules/rest_example/src/Form/RestExampleClientDelete.php, line 16

Namespace

Drupal\rest_example\Form

class RestExampleClientDelete extends ConfirmFormBase {

  /**
   * RestExampleClientCalls object.
   *
   * @var \Drupal\rest_example\RestExampleClientCalls
   */
  private $restExampleClientCalls;

  /**
   * RestExampleClientController constructor.
   *
   * @param \Drupal\rest_example\RestExampleClientCalls $rest_example_client_calls
   *   RestExampleClientCalls service.
   */
  public function __construct(RestExampleClientCalls $rest_example_client_calls) {
    $this->restExampleClientCalls = $rest_example_client_calls;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure that you want to delete this content.');
  }

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

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Delete');
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if (is_null($form_state
      ->get('node_id')) || !is_numeric($form_state
      ->get('node_id'))) {
      $form_state
        ->setErrorByName('delete', $this
        ->t('The ID passed in the URL is not an integer'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $id = NULL) {
    $form = parent::buildForm($form, $form_state);
    $form_state
      ->set('node_id', $id);
    return $form;
  }

  /**
   * {@inheritdoc}
   *
   * @throws \GuzzleHttp\Exception\GuzzleException
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $node_id = $form_state
      ->get('node_id');
    $node = [
      'nid' => $node_id,
    ];
    $this->restExampleClientCalls
      ->delete($node);
    $this
      ->messenger()
      ->addStatus($this
      ->t('Node was successfully deleted'));
    $form_state
      ->setRedirect('rest_example.client_actions_index');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	2
ConfirmFormBase::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription	14
ConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
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.	3
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.
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.
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.
RestExampleClientDelete::$restExampleClientCalls	private	property	RestExampleClientCalls object.
RestExampleClientDelete::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm
RestExampleClientDelete::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
RestExampleClientDelete::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
RestExampleClientDelete::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
RestExampleClientDelete::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
RestExampleClientDelete::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
RestExampleClientDelete::submitForm	public	function	Overrides FormInterface::submitForm
RestExampleClientDelete::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
RestExampleClientDelete::__construct	public	function	RestExampleClientController constructor.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.