You are here

Home » API reference » Examples for Developers 3.x » RestExampleClientEdit.php

class RestExampleClientEdit in Examples for Developers 3.x

Edit or create a new node on a remote Drupal site.

Hierarchy

Expanded class hierarchy of RestExampleClientEdit

Related topics

Example: REST
This module will give you a brief demonstration of how the REST service works.
1 string reference to 'RestExampleClientEdit'
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/RestExampleClientEdit.php, line 16

Namespace

Drupal\rest_example\Form
View source 
class RestExampleClientEdit extends FormBase {

  /**
   * RestExampleClientCalls service.
   *
   * @var \Drupal\rest_example\RestExampleClientCalls
   */
  private $client;

  /**
   * {@inheritdoc}
   */
  public function __construct(RestExampleClientCalls $restExampleClientCalls) {
    $this->client = $restExampleClientCalls;
  }

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

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

  /**
   * {@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('submit', $this
        ->t('The ID passed in the URL is not an integer'));
    }
  }

  /**
   * {@inheritdoc}
   *
   * @throws \GuzzleHttp\Exception\GuzzleException
   */
  public function buildForm(array $form, FormStateInterface $form_state, $id = NULL) {
    $config_factory = \Drupal::configFactory();
    if (empty($config_factory
      ->get('rest_example.settings')
      ->get('server_url'))) {
      $this
        ->messenger()
        ->addError($this
        ->t('The remote endpoint service address have not been set. Please go and provide the credentials and the endpoint address on the <a href="@url">config page</a>.', [
        '@url' => base_path() . 'examples/rest-client-settings',
      ]));
      return [
        'error' => [
          '#markup' => 'Unable to establish to the remote site.',
        ],
      ];
    }
    if (!is_null($id) && !is_numeric($id)) {
      return new Response('The ID passed in the URL is not an integer', 500);
    }
    $title = '';
    $form_state
      ->set('node_id', NULL);
    $form_state
      ->set('node_type', 'rest_example_test');

    // If this an existing node, we pull the data from the remote and set the
    // variables that we use as default values later on.
    if (is_numeric($id)) {
      $node = $this->client
        ->index($id);
      if (isset($node[0])) {
        $title = $node[0]['title'];
        $form_state
          ->set('node_id', $id);
      }
    }
    $form['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Node title'),
      '#default_value' => $title,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   *
   * @throws \GuzzleHttp\Exception\GuzzleException
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $node_id = $form_state
      ->get('node_id');
    $node_type = $form_state
      ->get('node_type');
    $form_values = $form_state
      ->getValues();
    $node = [
      'nid' => $node_id,
      'title' => $form_values['title'],
      'type' => $node_type,
    ];
    if (is_null($node_id)) {
      $this->client
        ->create($node);
    }
    else {
      $this->client
        ->update($node);
    }
    $this
      ->messenger()
      ->addStatus($this
      ->t('Node was successfully created'));
    $form_state
      ->setRedirect('rest_example.client_actions_index');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
RestExampleClientEdit::$client private property RestExampleClientCalls service.
RestExampleClientEdit::buildForm public function Overrides FormInterface::buildForm
RestExampleClientEdit::create public static function Instantiates a new instance of this class. Overrides FormBase::create
RestExampleClientEdit::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RestExampleClientEdit::submitForm public function Overrides FormInterface::submitForm
RestExampleClientEdit::validateForm public function Form validation handler. Overrides FormBase::validateForm
RestExampleClientEdit::__construct public function
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.