class CompletionMessage in Commerce Core 8.2

Provides the completion message pane.

Plugin annotation


@CommerceCheckoutPane(
  id = "completion_message",
  label = @Translation("Completion message"),
  default_step = "complete",
)

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_checkout\Plugin\Commerce\CheckoutPane\CompletionMessage

Expanded class hierarchy of CompletionMessage

File

modules/checkout/src/Plugin/Commerce/CheckoutPane/CompletionMessage.php, line 19

Namespace

Drupal\commerce_checkout\Plugin\Commerce\CheckoutPane

View source

class CompletionMessage extends CheckoutPaneBase {

  /**
   * The token service.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, CheckoutFlowInterface $checkout_flow = NULL) {
    $instance = new static($configuration, $plugin_id, $plugin_definition, $checkout_flow, $container
      ->get('entity_type.manager'));
    $instance
      ->setToken($container
      ->get('token'));
    return $instance;
  }

  /**
   * Sets the token service.
   *
   * @param \Drupal\Core\Utility\Token $token
   *   The token service.
   */
  public function setToken(Token $token) {
    $this->token = $token;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'message' => [
        'value' => "Your order number is [commerce_order:order_number].\r\nYou can view your order on your account page when logged in.",
        'format' => 'plain_text',
      ],
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['message'] = [
      '#type' => 'text_format',
      '#title' => $this
        ->t('Message'),
      '#description' => $this
        ->t('Shown the end of checkout, after the customer has placed their order.'),
      '#default_value' => $this->configuration['message']['value'],
      '#format' => $this->configuration['message']['format'],
      '#element_validate' => [
        'token_element_validate',
      ],
      '#token_types' => [
        'commerce_order',
      ],
      '#required' => TRUE,
    ];
    $form['token_help'] = [
      '#theme' => 'token_tree_link',
      '#token_types' => [
        'commerce_order',
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    if (!$form_state
      ->getErrors()) {
      $values = $form_state
        ->getValue($form['#parents']);
      $this->configuration['message'] = $values['message'];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildPaneForm(array $pane_form, FormStateInterface $form_state, array &$complete_form) {
    $message = $this->token
      ->replace($this->configuration['message']['value'], [
      'commerce_order' => $this->order,
    ]);
    $pane_form['message'] = [
      '#theme' => 'commerce_checkout_completion_message',
      '#order_entity' => $this->order,
      '#message' => [
        '#type' => 'processed_text',
        '#text' => $message,
        '#format' => $this->configuration['message']['format'],
      ],
    ];
    return $pane_form;
  }

}

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::buildConfigurationSummary	public	function	Builds a summary of the pane configuration. Overrides CheckoutPaneInterface::buildConfigurationSummary	5
CheckoutPaneBase::buildPaneSummary	public	function	Builds a summary of the pane values. Overrides CheckoutPaneInterface::buildPaneSummary	3
CheckoutPaneBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
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::isVisible	public	function	Determines whether the pane is visible. Overrides CheckoutPaneInterface::isVisible	4
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::submitPaneForm	public	function	Handles the submission of an pane form. Overrides CheckoutPaneInterface::submitPaneForm	7
CheckoutPaneBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
CheckoutPaneBase::validatePaneForm	public	function	Validates the pane form. Overrides CheckoutPaneInterface::validatePaneForm	4
CheckoutPaneBase::__construct	public	function	Constructs a new CheckoutPaneBase object. Overrides PluginBase::__construct	6
CompletionMessage::$token	protected	property	The token service.
CompletionMessage::buildConfigurationForm	public	function	Form constructor. Overrides CheckoutPaneBase::buildConfigurationForm
CompletionMessage::buildPaneForm	public	function	Builds the pane form. Overrides CheckoutPaneInterface::buildPaneForm
CompletionMessage::create	public static	function	Creates an instance of the plugin. Overrides CheckoutPaneBase::create
CompletionMessage::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides CheckoutPaneBase::defaultConfiguration
CompletionMessage::setToken	public	function	Sets the token service.
CompletionMessage::submitConfigurationForm	public	function	Form submission handler. Overrides CheckoutPaneBase::submitConfigurationForm
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.
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 CompletionMessage in Commerce Core 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation