DbtngExampleUpdateForm.php in Examples for Developers 3.x

Namespace

Drupal\dbtng_example\Form

File

modules/dbtng_example/src/Form/DbtngExampleUpdateForm.php

<?php

namespace Drupal\dbtng_example\Form;

use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\dbtng_example\DbtngExampleRepository;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Sample UI to update a record.
 *
 * @ingroup dbtng_example
 */
class DbtngExampleUpdateForm extends FormBase {

  /**
   * Our database repository service.
   *
   * @var \Drupal\dbtng_example\DbtngExampleRepository
   */
  protected $repository;

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $form = new static($container
      ->get('dbtng_example.repository'));
    $form
      ->setStringTranslation($container
      ->get('string_translation'));
    $form
      ->setMessenger($container
      ->get('messenger'));
    return $form;
  }

  /**
   * Construct the new form object.
   */
  public function __construct(DbtngExampleRepository $repository) {
    $this->repository = $repository;
  }

  /**
   * Sample UI to update a record.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    // Wrap the form in a div.
    $form = [
      '#prefix' => '<div id="updateform">',
      '#suffix' => '</div>',
    ];

    // Add some explanatory text to the form.
    $form['message'] = [
      '#markup' => $this
        ->t('Demonstrates a database update operation.'),
    ];

    // Query for items to display.
    $entries = $this->repository
      ->load();

    // Tell the user if there is nothing to display.
    if (empty($entries)) {
      $form['no_values'] = [
        '#value' => $this
          ->t('No entries exist in the table dbtng_example table.'),
      ];
      return $form;
    }
    $keyed_entries = [];
    $options = [];
    foreach ($entries as $entry) {
      $options[$entry->pid] = $this
        ->t('@pid: @name @surname (@age)', [
        '@pid' => $entry->pid,
        '@name' => $entry->name,
        '@surname' => $entry->surname,
        '@age' => $entry->age,
      ]);
      $keyed_entries[$entry->pid] = $entry;
    }

    // Grab the pid.
    $pid = $form_state
      ->getValue('pid');

    // Use the pid to set the default entry for updating.
    $default_entry = !empty($pid) ? $keyed_entries[$pid] : $entries[0];

    // Save the entries into the $form_state. We do this so the AJAX callback
    // doesn't need to repeat the query.
    $form_state
      ->setValue('entries', $keyed_entries);
    $form['pid'] = [
      '#type' => 'select',
      '#options' => $options,
      '#title' => $this
        ->t('Choose entry to update'),
      '#default_value' => $default_entry->pid,
      '#ajax' => [
        'wrapper' => 'updateform',
        'callback' => [
          $this,
          'updateCallback',
        ],
      ],
    ];
    $form['name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Updated first name'),
      '#size' => 15,
      '#default_value' => $default_entry->name,
    ];
    $form['surname'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Updated last name'),
      '#size' => 15,
      '#default_value' => $default_entry->surname,
    ];
    $form['age'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Updated age'),
      '#size' => 4,
      '#default_value' => $default_entry->age,
      '#description' => $this
        ->t('Values greater than 127 will cause an exception'),
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Update'),
    ];
    return $form;
  }

  /**
   * AJAX callback handler for the pid select.
   *
   * When the pid changes, populates the defaults from the database in the form.
   */
  public function updateCallback(array $form, FormStateInterface $form_state) {

    // Gather the DB results from $form_state.
    $entries = $form_state
      ->getValue('entries');

    // Use the specific entry for this $form_state.
    $entry = $entries[$form_state
      ->getValue('pid')];

    // Setting the #value of items is the only way I was able to figure out
    // to get replaced defaults on these items. #default_value will not do it
    // and shouldn't.
    foreach ([
      'name',
      'surname',
      'age',
    ] as $item) {
      $form[$item]['#value'] = $entry->{$item};
    }
    return $form;
  }

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

    // Confirm that age is numeric.
    if (!intval($form_state
      ->getValue('age'))) {
      $form_state
        ->setErrorByName('age', $this
        ->t('Age needs to be a number'));
    }
  }

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

    // Gather the current user so the new record has ownership.
    $account = $this
      ->currentUser();

    // Save the submitted entry.
    $entry = [
      'pid' => $form_state
        ->getValue('pid'),
      'name' => $form_state
        ->getValue('name'),
      'surname' => $form_state
        ->getValue('surname'),
      'age' => $form_state
        ->getValue('age'),
      'uid' => $account
        ->id(),
    ];
    $count = $this->repository
      ->update($entry);
    $this
      ->messenger()
      ->addMessage($this
      ->t('Updated entry @entry (@count row updated)', [
      '@count' => $count,
      '@entry' => print_r($entry, TRUE),
    ]));
  }

}

Classes

Name	Description
DbtngExampleUpdateForm	Sample UI to update a record.