abstract class AddressPaneBase in Ubercart 8.4

Provides a generic address pane that can be extended as required.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\uc_order\OrderPanePluginBase implements OrderPanePluginInterface
      • class \Drupal\uc_order\EditableOrderPanePluginBase implements EditableOrderPanePluginInterface
        • class \Drupal\uc_order\Plugin\Ubercart\OrderPane\AddressPaneBase

File

uc_order/src/Plugin/Ubercart/OrderPane/AddressPaneBase.php, line 12

Namespace

Drupal\uc_order\Plugin\Ubercart\OrderPane

abstract class AddressPaneBase extends EditableOrderPanePluginBase {

  /**
   * {@inheritdoc}
   */
  public function getClasses() {
    return [
      'pos-left',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function view(OrderInterface $order, $view_mode) {
    $pane = $this->pluginDefinition['id'];
    $address = $order
      ->getAddress($pane);
    return [
      '#markup' => $address . '<br />' . $address
        ->getPhone(),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(OrderInterface $order, array $form, FormStateInterface $form_state) {
    $pane = $this->pluginDefinition['id'];

    // Need to pass along uid, address pane selector, and pane id
    // for use in the JavaScript.
    $form['#attached']['drupalSettings'] = [
      'uid' => $order
        ->getOwnerId(),
      'paneId' => '#' . $pane . '-address-select',
      'addressType' => $pane,
    ];
    $form['address-book-image'] = [
      '#theme' => 'image',
      '#uri' => base_path() . drupal_get_path('module', 'uc_store') . '/images/address_book.gif',
      '#title' => $this
        ->t('Select from address book.'),
      '#alt' => $this
        ->t('Select from address book.'),
      '#attributes' => [
        'class' => 'load-address-select',
      ],
      '#prefix' => '<div class="order-pane-icons">',
    ];
    $form['copy-address-image'] = [
      '#theme' => 'image',
      '#uri' => base_path() . drupal_get_path('module', 'uc_store') . '/images/copy.gif',
      // Need to set #title, #alt, and #attributes in derived class.
      '#suffix' => '</div>',
    ];

    // An empty <div> to put our address book select into.
    // @todo This can be done with core Ajax.
    $form['icons'] = [
      '#type' => 'markup',
      '#markup' => '<div id="' . $pane . '-address-select"></div>',
    ];
    $form['address'] = [
      '#type' => 'uc_address',
      '#parents' => [
        $pane,
      ],
      '#default_value' => $order
        ->getAddress($pane),
      '#required' => FALSE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(OrderInterface $order, array &$form, FormStateInterface $form_state) {
    $pane = $this->pluginDefinition['id'];
    $address = $order
      ->getAddress($pane);
    foreach ($form_state
      ->getValue($pane) as $key => $value) {
      if (uc_address_field_enabled($key)) {
        $address->{$key} = $value;
      }
    }
    $order
      ->setAddress($pane, $address);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddressPaneBase::buildForm	public	function	Form constructor. Overrides EditableOrderPanePluginInterface::buildForm	2
AddressPaneBase::getClasses	public	function	Returns the classes used to wrap an order pane. Overrides OrderPanePluginBase::getClasses
AddressPaneBase::submitForm	public	function	Form submission handler. Overrides EditableOrderPanePluginInterface::submitForm
AddressPaneBase::view	public	function	Returns the contents of an order pane as a store administrator. Overrides OrderPanePluginInterface::view	1
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OrderPanePluginBase::calculateDependencies	public	function
OrderPanePluginBase::getTitle	public	function	Returns the title of an order pane. Overrides OrderPanePluginInterface::getTitle	2
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.