class ReceiveCheckForm in Ubercart 8.4

Form for recording a received check and expected clearance date.

Hierarchy

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

Expanded class hierarchy of ReceiveCheckForm

1 string reference to 'ReceiveCheckForm'

uc_payment_pack.routing.yml in payment/uc_payment_pack/uc_payment_pack.routing.yml: payment/uc_payment_pack/uc_payment_pack.routing.yml

File

payment/uc_payment_pack/src/Form/ReceiveCheckForm.php, line 16

Namespace

Drupal\uc_payment_pack\Form

View source

class ReceiveCheckForm extends FormBase {

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

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

  /**
   * Form constructor.
   *
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The datetime.time service.
   * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
   *   The date.formatter service.
   */
  public function __construct(TimeInterface $time, DateFormatterInterface $date_formatter) {
    $this->time = $time;
    $this->dateFormatter = $date_formatter;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, OrderInterface $uc_order = NULL) {
    $balance = uc_payment_balance($uc_order);
    $form['balance'] = [
      '#prefix' => '<strong>' . $this
        ->t('Order balance:') . '</strong> ',
      '#markup' => uc_currency_format($balance),
    ];
    $form['order_id'] = [
      '#type' => 'hidden',
      '#value' => $uc_order
        ->id(),
    ];
    $form['amount'] = [
      '#type' => 'uc_price',
      '#title' => $this
        ->t('Check amount'),
      '#default_value' => $balance,
    ];
    $form['comment'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Comment'),
      '#description' => $this
        ->t('Any notes about the check, like type or check number.'),
      '#size' => 64,
      '#maxlength' => 256,
    ];
    $form['clear_date'] = [
      '#type' => 'datetime',
      '#title' => $this
        ->t('Expected clear date'),
      '#date_date_element' => 'date',
      '#date_time_element' => 'none',
      '#default_value' => DrupalDateTime::createFromTimestamp($this->time
        ->getRequestTime()),
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Receive check'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    uc_payment_enter($form_state
      ->getValue('order_id'), 'check', $form_state
      ->getValue('amount'), $this
      ->currentUser()
      ->id(), NULL, $form_state
      ->getValue('comment'));
    $clear_date = $form_state
      ->getValue('clear_date')
      ->getTimestamp();
    \Drupal::database()
      ->insert('uc_payment_check')
      ->fields([
      'order_id' => $form_state
        ->getValue('order_id'),
      'clear_date' => $clear_date,
    ])
      ->execute();
    $this
      ->messenger()
      ->addMessage($this
      ->t('Check received, expected clear date of @date.', [
      '@date' => $this->dateFormatter
        ->format($clear_date, 'uc_store'),
    ]));
    $form_state
      ->setRedirect('entity.uc_order.canonical', [
      'uc_order' => $form_state
        ->getValue('order_id'),
    ]);
  }

}

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.
ReceiveCheckForm::$dateFormatter	protected	property	The date.formatter service.
ReceiveCheckForm::$time	protected	property	The datetime.time service.
ReceiveCheckForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ReceiveCheckForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ReceiveCheckForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ReceiveCheckForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ReceiveCheckForm::__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 ReceiveCheckForm in Ubercart 8.4

Hierarchy

File

Namespace

Members

API Navigation