You are here

Home » API reference » Ubercart 8.4 » OrderPaymentsForm.php

class OrderPaymentsForm in Ubercart 8.4

Displays a list of payments attached to an order.

Hierarchy

Expanded class hierarchy of OrderPaymentsForm

1 string reference to 'OrderPaymentsForm'
uc_payment.routing.yml in payment/uc_payment/uc_payment.routing.yml
payment/uc_payment/uc_payment.routing.yml

File

payment/uc_payment/src/Form/OrderPaymentsForm.php, line 18

Namespace

Drupal\uc_payment\Form
View source 
class OrderPaymentsForm extends FormBase {

  /**
   * The order that is being viewed.
   *
   * @var \Drupal\uc_order\OrderInterface
   */
  protected $order;

  /**
   * The payment method manager.
   *
   * @var \Drupal\uc_payment\Plugin\PaymentMethodManager
   */
  protected $paymentMethodManager;

  /**
   * The datetime.time service.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * The date.formatter service.
   *
   * @var \Drupal\Core\Datetime\DateFormatterInterface
   */
  protected $dateFormatter;

  /**
   * Constructs an OrderPaymentsForm object.
   *
   * @param \Drupal\uc_payment\Plugin\PaymentMethodManager $payment_method_manager
   *   The payment method plugin manager.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The datetime.time service.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date.formatter service.
   */
  public function __construct(PaymentMethodManager $payment_method_manager, TimeInterface $time, DateFormatterInterface $date_formatter) {
    $this->paymentMethodManager = $payment_method_manager;
    $this->time = $time;
    $this->dateFormatter = $date_formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.uc_payment.method'), $container
      ->get('datetime.time'), $container
      ->get('date.formatter'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, OrderInterface $uc_order = NULL) {
    $this->order = $uc_order;
    $form['#attached']['library'][] = 'uc_payment/uc_payment.styles';
    $total = $this->order
      ->getTotal();
    $payments = uc_payment_load_payments($this->order
      ->id());
    $form['order_total'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Order total'),
      '#theme' => 'uc_price',
      '#price' => $total,
    ];
    $form['payments'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Received'),
        $this
          ->t('User'),
        $this
          ->t('Method'),
        $this
          ->t('Amount'),
        $this
          ->t('Balance'),
        $this
          ->t('Comment'),
        $this
          ->t('Action'),
      ],
      '#weight' => 10,
    ];
    foreach ($payments as $id => $payment) {
      $form['payments'][$id]['received'] = [
        '#markup' => $this->dateFormatter
          ->format($payment
          ->getReceived(), 'short'),
      ];
      $form['payments'][$id]['user'] = [
        '#theme' => 'username',
        '#account' => $payment
          ->getUser(),
      ];
      $form['payments'][$id]['method'] = [
        '#markup' => $payment
          ->getMethod()
          ->getPluginDefinition()['name'],
      ];
      $form['payments'][$id]['amount'] = [
        '#theme' => 'uc_price',
        '#price' => $payment
          ->getAmount(),
      ];
      $total -= $payment
        ->getAmount();
      $form['payments'][$id]['balance'] = [
        '#theme' => 'uc_price',
        '#price' => $total,
      ];
      $form['payments'][$id]['comment'] = [
        '#markup' => $payment
          ->getComment() ?: '-',
      ];
      $form['payments'][$id]['action'] = [
        '#type' => 'operations',
        '#links' => [
          'delete' => [
            'title' => $this
              ->t('Delete'),
            'url' => Url::fromRoute('uc_payments.delete', [
              'uc_order' => $this->order
                ->id(),
              'uc_payment_receipt' => $id,
            ]),
          ],
        ],
        '#access' => $this
          ->currentUser()
          ->hasPermission('delete payments'),
      ];
    }
    $form['balance'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Current balance'),
      '#theme' => 'uc_price',
      '#price' => $total,
    ];
    if ($this
      ->currentUser()
      ->hasPermission('manual payments')) {
      $form['new'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Add payment'),
        '#open' => TRUE,
        '#weight' => 20,
      ];
      $form['new']['amount'] = [
        '#type' => 'uc_price',
        '#title' => $this
          ->t('Amount'),
        '#required' => TRUE,
        '#size' => 6,
      ];
      $options = array_map(function ($definition) {
        return $definition['name'];
      }, array_filter($this->paymentMethodManager
        ->getDefinitions(), function ($definition) {
        return !$definition['no_ui'];
      }));
      $form['new']['method'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Payment method'),
        '#options' => $options,
      ];
      $form['new']['comment'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Comment'),
      ];
      $form['new']['received'] = [
        '#type' => 'datetime',
        '#title' => $this
          ->t('Date'),
        '#date_date_element' => 'date',
        '#date_time_element' => 'time',
        '#default_value' => DrupalDateTime::createFromTimestamp($this->time
          ->getRequestTime()),
      ];
      $form['new']['action'] = [
        '#type' => 'actions',
      ];
      $form['new']['action']['action'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Record payment'),
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $payment = $form_state
      ->getValues();
    uc_payment_enter($this->order
      ->id(), $payment['method'], $payment['amount'], $this
      ->currentUser()
      ->id(), NULL, $payment['comment'], $payment['received']
      ->getTimestamp());
    $this
      ->messenger()
      ->addMessage($this
      ->t('Payment entered.'));
  }

}

Members

Namesort descending 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.
OrderPaymentsForm::$dateFormatter protected property The date.formatter service.
OrderPaymentsForm::$order protected property The order that is being viewed.
OrderPaymentsForm::$paymentMethodManager protected property The payment method manager.
OrderPaymentsForm::$time protected property The datetime.time service.
OrderPaymentsForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
OrderPaymentsForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
OrderPaymentsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
OrderPaymentsForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
OrderPaymentsForm::__construct public function Constructs an OrderPaymentsForm object.
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.