class Donation in Commerce Donate 8

Provides the donation pane.

Plugin annotation


@CommerceCheckoutPane(
  id = "donation",
  label = @Translation("Donation"),
  default_step = "order_information",
  wrapper_element = "fieldset",
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\commerce_checkout\Plugin\Commerce\CheckoutPane\CheckoutPaneBase implements CheckoutPaneInterface, ContainerFactoryPluginInterface
    class \Drupal\commerce_donate\Plugin\Commerce\CheckoutPane\Donation implements CheckoutPaneInterface

Expanded class hierarchy of Donation

File

src/Plugin/Commerce/CheckoutPane/Donation.php, line 23

Namespace

Drupal\commerce_donate\Plugin\Commerce\CheckoutPane

View source

class Donation extends CheckoutPaneBase implements CheckoutPaneInterface {

  /**
   * {@inheritdoc}
   */
  public function isVisible() {

    // Hide the pane if there's already a donation order item?
    $order_item = $this
      ->getOrderItem();
    if ($order_item) {
      return TRUE;
    }
    else {
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildPaneSummary() {
    $summary = [];
    if ($this
      ->isVisible()) {
      $order_item = $this
        ->getOrderItem();

      // Expand this to provide the appropriate output at checkout review.
      $summary = [
        '#plain_text' => $order_item
          ->label(),
      ];
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function buildPaneForm(array $pane_form, FormStateInterface $form_state, array &$complete_form) {
    $current_currency = \Drupal::service('commerce_currency_resolver.current_currency');
    $selected_currency = $current_currency
      ->getCurrency();
    $entity_type_manager = \Drupal::service('entity_type.manager');
    $currency = $entity_type_manager
      ->getStorage('commerce_currency')
      ->load($selected_currency);
    $currency_symbol = $currency
      ->getSymbol();
    $predefined_amounts = [
      '50' => $currency_symbol . '50',
      '100' => $currency_symbol . '100',
      '250' => $currency_symbol . '250',
    ];
    $predefined_amount_keys = array_keys($predefined_amounts);
    $order_item = $this
      ->getOrderItem();
    $unit_price = $order_item
      ->getUnitPrice();
    $amount = $unit_price ? Calculator::trim($unit_price
      ->getNumber()) : reset($predefined_amount_keys);
    $pane_form['donation'] = [
      '#type' => 'checkbox',
      '#title' => t('I would like to make a donation'),
      '#default_value' => $unit_price ? '1' : '0',
    ];
    $pane_form['details'] = [
      '#type' => 'fieldset',
      '#states' => [
        'visible' => [
          ':input[name="donation[donation]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $pane_form['details']['amount'] = [
      '#type' => 'select_or_other_buttons',
      '#title' => t('I would like to Donate'),
      '#options' => $predefined_amounts,
      '#default_value' => $amount,
      '#required' => TRUE,
    ];
    $pane_form['details']['in_memory'] = [
      '#type' => 'checkbox',
      '#title' => t('I wish to make this donation in memory of someone'),
      '#default_value' => $order_item->field_in_memory->value,
    ];
    $pane_form['details']['in_memory_name'] = [
      '#type' => 'textfield',
      '#title' => t('Donate in memory of'),
      '#placeholder' => t("Enter person's name"),
      '#default_value' => $order_item->field_in_memory_name->value,
      '#states' => [
        'visible' => [
          ':input[name="donation[details][in_memory]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $pane_form['details']['in_memory_memorial'] = [
      '#type' => 'checkbox',
      '#title' => t('Receive an In Memory Card.'),
      '#default_value' => $order_item->field_in_memory_memorial->value,
      '#states' => [
        'visible' => [
          ':input[name="donation[details][in_memory]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $pane_form;
  }

  /**
   * {@inheritdoc}
   */
  public function validatePaneForm(array &$pane_form, FormStateInterface $form_state, array &$complete_form) {
    $values = $form_state
      ->getValue($pane_form['#parents']);
    $amount = $values['details']['amount'][0];
    if (!is_numeric($amount)) {
      $form_state
        ->setError($pane_form['details']['amount'], t('The amount must be a valid number.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitPaneForm(array &$pane_form, FormStateInterface $form_state, array &$complete_form) {
    $order_item = $this
      ->getOrderItem();
    $values = $form_state
      ->getValue($pane_form['#parents']);
    $amount = $values['details']['amount'][0];
    $make_donation = $values['donation'];
    $current_currency = \Drupal::service('commerce_currency_resolver.current_currency');
    $selected_currency = $current_currency
      ->getCurrency();
    $entity_type_manager = \Drupal::service('entity_type.manager');
    $currency = $entity_type_manager
      ->getStorage('commerce_currency')
      ->load($selected_currency);
    $currency_symbol = $currency
      ->getSymbol();
    $currency_formatter = \Drupal::service('commerce_price.currency_formatter');
    $amount_label = $currency_formatter
      ->format($amount, $selected_currency);
    $order_item->title = t('@amount donation', [
      '@amount' => $amount_label,
    ]);
    $order_item->unit_price = [
      'number' => $amount,
      'currency_code' => $selected_currency,
    ];
    $order_item->field_in_memory = $values['details']['in_memory'];
    $order_item->field_in_memory_name = $values['details']['in_memory_name'];
    $order_item->field_in_memory_memorial = $values['details']['in_memory_memorial'];
    $order_item
      ->save();

    // Add or update Donation Line item.
    if (!$this->order
      ->hasItem($order_item) && $make_donation) {
      $this->order
        ->addItem($order_item);
    }

    // Remove Donation if required.
    if (!$make_donation && $this->order
      ->hasItem($order_item)) {
      $this->order
        ->removeItem($order_item);
    }
  }

  /**
   * Gets the donation order item.
   *
   * If one isn't found, it will be created.
   *
   * @return \Drupal\commerce_order\Entity\OrderItemInterface
   *   The donation order item.
   */
  protected function getOrderItem() {
    $donation_order_item = NULL;

    // Try to find an existing order item.
    foreach ($this->order
      ->getItems() as $order_item) {
      if ($order_item
        ->bundle() == 'donation') {
        $donation_order_item = $order_item;
        break;
      }
    }
    return $donation_order_item;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CheckoutPaneBase::$checkoutFlow	protected	property	The parent checkout flow.
CheckoutPaneBase::$entityTypeManager	protected	property	The entity type manager.
CheckoutPaneBase::$order	protected	property	The current order.
CheckoutPaneBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	6
CheckoutPaneBase::buildConfigurationSummary	public	function	Builds a summary of the pane configuration. Overrides CheckoutPaneInterface::buildConfigurationSummary	5
CheckoutPaneBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
CheckoutPaneBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	7
CheckoutPaneBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	6
CheckoutPaneBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
CheckoutPaneBase::getDisplayLabel	public	function	Gets the pane display label. Overrides CheckoutPaneInterface::getDisplayLabel
CheckoutPaneBase::getId	public	function	Gets the pane ID. Overrides CheckoutPaneInterface::getId
CheckoutPaneBase::getLabel	public	function	Gets the pane label. Overrides CheckoutPaneInterface::getLabel
CheckoutPaneBase::getStepId	public	function	Gets the pane step ID. Overrides CheckoutPaneInterface::getStepId
CheckoutPaneBase::getWeight	public	function	Gets the pane weight. Overrides CheckoutPaneInterface::getWeight
CheckoutPaneBase::getWrapperElement	public	function	Gets the pane wrapper element. Overrides CheckoutPaneInterface::getWrapperElement
CheckoutPaneBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
CheckoutPaneBase::setOrder	public	function	Sets the current order. Overrides CheckoutPaneInterface::setOrder
CheckoutPaneBase::setStepId	public	function	Sets the pane step ID. Overrides CheckoutPaneInterface::setStepId
CheckoutPaneBase::setWeight	public	function	Sets the pane weight. Overrides CheckoutPaneInterface::setWeight
CheckoutPaneBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	6
CheckoutPaneBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
CheckoutPaneBase::__construct	public	function	Constructs a new CheckoutPaneBase object. Overrides PluginBase::__construct	6
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
Donation::buildPaneForm	public	function	Builds the pane form. Overrides CheckoutPaneInterface::buildPaneForm
Donation::buildPaneSummary	public	function	Builds a summary of the pane values. Overrides CheckoutPaneBase::buildPaneSummary
Donation::getOrderItem	protected	function	Gets the donation order item.
Donation::isVisible	public	function	Determines whether the pane is visible. Overrides CheckoutPaneBase::isVisible
Donation::submitPaneForm	public	function	Handles the submission of an pane form. Overrides CheckoutPaneBase::submitPaneForm
Donation::validatePaneForm	public	function	Validates the pane form. Overrides CheckoutPaneBase::validatePaneForm
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
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.

You are here

class Donation in Commerce Donate 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation