You are here

Home » API reference » Ubercart 8.4 » AddressForm.php

class AddressForm in Ubercart 8.4

Helper function for addresses in forms.

Hierarchy

Expanded class hierarchy of AddressForm

File

shipping/uc_fulfillment/src/Form/AddressForm.php, line 14

Namespace

Drupal\uc_fulfillment\Form
View source 
class AddressForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, array $addresses = [], OrderInterface $uc_order = NULL) {
    $form['#attached']['library'][] = 'uc_fulfillment/uc_fulfillment.scripts';
    $form['origin'] = [
      '#type' => 'fieldset',
      '#title' => t('Origin address'),
      '#weight' => -2,
    ];
    $form['origin']['pickup_address_select'] = $this
      ->selectAddress($addresses);
    $form['origin']['pickup_address_select']['#weight'] = -2;
    $form['origin']['pickup_email'] = [
      '#type' => 'email',
      '#title' => t('E-mail'),
      '#default_value' => uc_store_email(),
      '#weight' => -1,
    ];
    $form['origin']['pickup_address'] = [
      '#type' => 'uc_address',
      '#default_value' => reset($addresses),
      '#required' => FALSE,
    ];
    $form['destination'] = [
      '#type' => 'fieldset',
      '#title' => t('Destination address'),
      '#weight' => -1,
    ];
    if ($form_state
      ->hasValue('delivery_country')) {
      $uc_order->delivery_country = $form_state
        ->getValue('delivery_country');
    }
    $form['destination']['delivery_email'] = [
      '#type' => 'email',
      '#title' => t('E-mail'),
      '#default_value' => $uc_order
        ->getEmail(),
      '#weight' => -1,
    ];
    $form['destination']['delivery_address'] = [
      '#type' => 'uc_address',
      '#default_value' => $uc_order
        ->getAddress('delivery'),
      '#required' => FALSE,
      '#key_prefix' => 'delivery',
    ];
    return $form;
  }

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

  /**
   * Chooses an address to fill out a form.
   */
  protected function selectAddress(array $addresses = []) {
    $quote_config = $this
      ->config('uc_quote.settings');
    $ship_from_address = Address::create($quote_config
      ->get('ship_from_address'));
    if (!in_array($ship_from_address, $addresses)) {
      $addresses[] = $ship_from_address;
    }
    $blank = Address::create([
      'first_name' => '',
      'last_name' => '',
      'company' => '',
      'street1' => '',
      'street2' => '',
      'city' => '',
      'postal_code' => '',
      'country' => '',
      'zone' => '',
      'phone' => '',
    ]);
    $options = [
      Json::encode($blank) => t('- Reset fields -'),
    ];
    foreach ($addresses as $address) {
      $options[Json::encode($address)] = $address
        ->getCompany() . ' ' . $address
        ->getStreet1() . ' ' . $address
        ->getCity();
    }
    $select = [
      '#type' => 'select',
      '#title' => t('Saved addresses'),
      '#options' => $options,
      '#default_value' => Json::encode($addresses[0]),
      '#attributes' => [
        'onchange' => 'apply_address(\'pickup\', this.value);',
      ],
    ];
    return $select;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddressForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AddressForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AddressForm::selectAddress protected function Chooses an address to fill out a form.
AddressForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
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.
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.