class OrderUpdateForm in Ubercart 8.4

Updates an order's status and optionally adds comments.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\uc_order\Form\OrderUpdateForm

Expanded class hierarchy of OrderUpdateForm

File

uc_order/src/Form/OrderUpdateForm.php, line 17

Namespace

Drupal\uc_order\Form

View source

class OrderUpdateForm extends FormBase {

  /**
   * The event_dispatcher service.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * Form constructor.
   *
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event_dispatcher service.
   */
  public function __construct(EventDispatcherInterface $event_dispatcher) {
    $this->eventDispatcher = $event_dispatcher;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, OrderInterface $order = NULL) {
    $form['order_comment_field'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Add an order comment'),
    ];
    $form['order_comment_field']['order_comment'] = [
      '#type' => 'textarea',
      '#description' => $this
        ->t('Order comments are used primarily to communicate with the customer.'),
    ];
    $form['admin_comment_field'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Add an admin comment'),
    ];
    $form['admin_comment_field']['admin_comment'] = [
      '#type' => 'textarea',
      '#description' => $this
        ->t('Admin comments are only seen by store administrators.'),
    ];
    $form['current_status'] = [
      '#type' => 'value',
      '#value' => $order
        ->getStatusId(),
    ];
    $form['order_id'] = [
      '#type' => 'value',
      '#value' => $order
        ->id(),
    ];
    $form['controls'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'uc-inline-form',
        ],
      ],
      '#weight' => 10,
    ];
    $form['controls']['status'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Order status'),
      '#default_value' => $order
        ->getStatusId(),
      '#options' => OrderStatus::getOptionsList(),
    ];
    $form['controls']['notify'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Send e-mail notification on update.'),
    ];
    $form['controls']['actions'] = [
      '#type' => 'actions',
    ];
    $form['controls']['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Update'),
      '#button_type' => 'primary',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $uid = $this
      ->currentUser()
      ->id();
    if (!$form_state
      ->isValueEmpty('order_comment')) {
      uc_order_comment_save($form_state
        ->getValue('order_id'), $uid, $form_state
        ->getValue('order_comment'), 'order', $form_state
        ->getValue('status'), $form_state
        ->getValue('notify'));
    }
    if (!$form_state
      ->isValueEmpty('admin_comment')) {
      uc_order_comment_save($form_state
        ->getValue('order_id'), $uid, $form_state
        ->getValue('admin_comment'));
    }
    if ($form_state
      ->getValue('status') != $form_state
      ->getValue('current_status')) {
      Order::load($form_state
        ->getValue('order_id'))
        ->setStatusId($form_state
        ->getValue('status'))
        ->save();
      if ($form_state
        ->isValueEmpty('order_comment')) {
        uc_order_comment_save($form_state
          ->getValue('order_id'), $uid, '-', 'order', $form_state
          ->getValue('status'), $form_state
          ->getValue('notify'));
      }
    }

    // Let Rules send email if requested.
    if ($form_state
      ->getValue('notify')) {
      $order = Order::load($form_state
        ->getValue('order_id'));

      /* rules_invoke_event('uc_order_status_email_update', $order); */
      $event = new OrderStatusEmailUpdateEvent($order);
      $this->eventDispatcher
        ->dispatch($event::EVENT_NAME, $event);
    }
    $this
      ->messenger()
      ->addMessage($this
      ->t('Order updated.'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
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::logger	protected	function	Gets the logger for a specific channel.
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.
OrderUpdateForm::$eventDispatcher	protected	property	The event_dispatcher service.
OrderUpdateForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
OrderUpdateForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
OrderUpdateForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
OrderUpdateForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
OrderUpdateForm::__construct	public	function	Form constructor.
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
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
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 OrderUpdateForm in Ubercart 8.4

Hierarchy

File

Namespace

Members

API Navigation