You are here

Home » API reference » Ubercart 8.4

OrderCreateForm.php in Ubercart 8.4

Namespace

Drupal\uc_order\Form

File

uc_order/src/Form/OrderCreateForm.php
View source 
<?php

namespace Drupal\uc_order\Form;

use Drupal\Core\Database\Query\Condition;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Mail\MailManagerInterface;
use Drupal\uc_order\Entity\Order;
use Drupal\user\Entity\User;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Creates a new order and redirect to its edit screen.
 */
class OrderCreateForm extends FormBase {

  /**
   * The mail manager service.
   *
   * @var \Drupal\Core\Mail\MailManagerInterface
   */
  protected $mailManager;

  /**
   * Form constructor.
   *
   * @param \Drupal\Core\Mail\MailManagerInterface $mail_manager
   *   The mail manager service.
   */
  public function __construct(MailManagerInterface $mail_manager) {
    $this->mailManager = $mail_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['customer_type'] = [
      '#type' => 'radios',
      '#options' => [
        'search' => $this
          ->t('Search for an existing customer.'),
        'create' => $this
          ->t('Create a new customer account.'),
        'none' => $this
          ->t('No customer account required.'),
      ],
      '#required' => TRUE,
      '#default_value' => 'search',
      '#ajax' => [
        'callback' => [
          $this,
          'customerSelect',
        ],
        'wrapper' => 'uc-order-customer',
        'progress' => [
          'type' => 'throbber',
        ],
      ],
    ];
    $form['customer'] = [
      '#prefix' => '<div id="uc-order-customer">',
      '#suffix' => '</div>',
      '#tree' => TRUE,
    ];

    // Create form elements needed for customer search.
    // Shown only when the 'Search for an existing customer.' radio is selected.
    if (!$form_state
      ->hasValue('customer_type') || $form_state
      ->getValue('customer_type') == 'search') {

      // Container for customer search fields.
      $form['customer'] += [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('Customer search'),
        '#description' => $this
          ->t('Enter full or partial information in one or more of the following fields, then press the "Search" button. Search results will match all the provided information.'),
      ];

      // Customer first name.
      $form['customer']['first_name'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('First name'),
        '#size' => 24,
        '#maxlength' => 32,
      ];

      // Customer last name.
      $form['customer']['last_name'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Last name'),
        '#size' => 24,
        '#maxlength' => 32,
      ];

      // Customer e-mail address.
      $form['customer']['email'] = [
        '#type' => 'email',
        '#title' => $this
          ->t('E-mail'),
        '#size' => 24,
        '#maxlength' => 96,
      ];

      // Customer username.
      $form['customer']['username'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Username'),
        '#size' => 24,
        '#maxlength' => 96,
      ];
      $form['customer']['search'] = [
        '#type' => 'button',
        '#value' => $this
          ->t('Search'),
        '#limit_validation_errors' => [],
        '#submit' => [],
        '#ajax' => [
          'callback' => [
            $this,
            'customerSearch',
          ],
          'wrapper' => 'uc-order-customer-results',
          'progress' => [
            'type' => 'throbber',
          ],
        ],
      ];
      $form['customer']['uid'] = [
        '#prefix' => '<div id="uc-order-customer-results">',
        '#suffix' => '</div>',
      ];

      // Search for existing customer by e-mail address.
      if ($form_state
        ->getValue('customer')) {
        $query = \Drupal::database()
          ->select('users_field_data', 'u')
          ->distinct();
        $query
          ->leftJoin('uc_orders', 'o', 'u.uid = o.uid');
        $query
          ->fields('u', [
          'uid',
          'name',
          'mail',
        ])
          ->fields('o', [
          'billing_first_name',
          'billing_last_name',
          'created',
        ])
          ->condition('u.uid', 0, '>')
          ->condition((new Condition('OR'))
          ->isNull('o.billing_first_name')
          ->condition('o.billing_first_name', \Drupal::database()
          ->escapeLike(trim($form_state
          ->getValue([
          'customer',
          'first_name',
        ]))) . '%', 'LIKE'))
          ->condition((new Condition('OR'))
          ->isNull('o.billing_last_name')
          ->condition('o.billing_last_name', \Drupal::database()
          ->escapeLike(trim($form_state
          ->getValue([
          'customer',
          'last_name',
        ]))) . '%', 'LIKE'))
          ->condition((new Condition('OR'))
          ->condition('o.primary_email', \Drupal::database()
          ->escapeLike(trim($form_state
          ->getValue([
          'customer',
          'email',
        ]))) . '%', 'LIKE')
          ->condition('u.mail', \Drupal::database()
          ->escapeLike(trim($form_state
          ->getValue([
          'customer',
          'email',
        ]))) . '%', 'LIKE'))
          ->condition('u.name', \Drupal::database()
          ->escapeLike(trim($form_state
          ->getValue([
          'customer',
          'username',
        ]))) . '%', 'LIKE')
          ->orderBy('o.created', 'DESC')
          ->range(0, $limit = 11);
        $result = $query
          ->execute();
        $options = [];
        foreach ($result as $user) {
          $name = '';
          if (!empty($user->billing_first_name) && !empty($user->billing_last_name)) {
            $name = $user->billing_first_name . ' ' . $user->billing_last_name . ' ';
          }

          // Options formatted as "First Last <email@example.com> (username)".
          $options[$user->uid] = $name . '&lt;' . $user->mail . '&gt;' . ' (' . $user->name . ')';
        }
        $max = FALSE;
        if (count($options) == $limit) {
          array_pop($options);
          $max = TRUE;
        }
        if (!empty($options)) {

          // Display search results.
          $form['customer']['uid'] += [
            '#type' => 'radios',
            '#title' => $this
              ->t('Select customer'),
            '#description' => $max ? $this
              ->t('More than @limit results found. Refine your search to find other customers.', [
              '@limit' => $limit - 1,
            ]) : '',
            '#options' => $options,
            '#default_value' => key($options),
          ];
        }
        else {

          // No search results found.
          $form['customer']['uid'] += [
            '#markup' => '<p>' . $this
              ->t('Search returned no results.') . '</p>',
          ];
        }
      }
    }
    elseif ($form_state
      ->getValue('customer_type') == 'create') {

      // Container for new customer information.
      $form['customer'] += [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('New customer details'),
      ];

      // Customer e-mail address.
      $form['customer']['email'] = [
        '#type' => 'email',
        '#title' => $this
          ->t('Customer e-mail address'),
        '#size' => 24,
        '#maxlength' => 96,
      ];

      // Option to notify customer.
      $form['customer']['sendmail'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('E-mail account details to customer.'),
      ];
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Create order'),
    ];
    return $form;
  }

  /**
   * Ajax callback: updates the customer selection fields.
   */
  public function customerSelect(array $form, FormStateInterface $form_state) {
    return $form['customer'];
  }

  /**
   * Ajax callback: updates the customer search results.
   */
  public function customerSearch(array $form, FormStateInterface $form_state) {
    return $form['customer']['uid'];
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    switch ($form_state
      ->getValue('customer_type')) {
      case 'search':
        if (!$form_state
          ->hasValue([
          'customer',
          'uid',
        ])) {
          $form_state
            ->setErrorByName('customer][uid', $this
            ->t('Please select a customer.'));
        }
        break;
      case 'create':
        $email = trim($form_state
          ->getValue([
          'customer',
          'email',
        ]));
        $uid = \Drupal::database()
          ->query('SELECT uid FROM {users_field_data} WHERE mail LIKE :mail', [
          ':mail' => $email,
        ])
          ->fetchField();
        if ($uid) {
          $form_state
            ->setErrorByName('customer][mail', $this
            ->t('An account already exists for that e-mail.'));
        }
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    switch ($form_state
      ->getValue('customer_type')) {
      case 'search':
        $uid = $form_state
          ->getValue([
          'customer',
          'uid',
        ]);
        break;
      case 'create':

        // Create new account.
        $email = trim($form_state
          ->getValue([
          'customer',
          'email',
        ]));
        $fields = [
          'name' => uc_store_email_to_username($email),
          'mail' => $email,
          // @todo Replace the following line with:
          // 'pass' => \Drupal::service('password_generator')->generate(),
          // when Drupal 9.1 becomes the lowest-supported version of Drupal.
          // @see https://www.drupal.org/project/ubercart/issues/3217319
          'pass' => user_password(),
          'status' => $this
            ->config('uc_cart.settings')
            ->get('new_customer_status_active') ? 1 : 0,
        ];
        $account = User::create($fields);
        $account
          ->save();
        $uid = $account
          ->id();
        if ($form_state
          ->getValue([
          'customer',
          'sendmail',
        ])) {

          // Manually set the password so it appears in the e-mail.
          $account->password = $fields['pass'];
          $this->mailManager
            ->mail('user', 'register_admin_created', $email, uc_store_mail_recipient_langcode($email), [
            'account' => $account,
          ], uc_store_email_from());
          $this
            ->messenger()
            ->addMessage($this
            ->t('A welcome message has been e-mailed to the new user.'));
        }
        break;
      default:
        $uid = 0;
    }
    $order = Order::create([
      'uid' => $uid,
      'order_status' => uc_order_state_default('post_checkout'),
    ]);
    $order
      ->save();
    uc_order_comment_save($order
      ->id(), $this
      ->currentUser()
      ->id(), $this
      ->t('Order created by the administration.'), 'admin');
    $form_state
      ->setRedirect('entity.uc_order.edit_form', [
      'uc_order' => $order
        ->id(),
    ]);
  }

}

Classes

Namesort descending Description
OrderCreateForm Creates a new order and redirect to its edit screen.