class OrderCommentsPane in Ubercart 8.4

Allows a customer to make comments on the order.

Plugin annotation

@CheckoutPane(
  id = "comments",
  title = @Translation("Order comments"),
  weight = 7,
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\uc_cart\CheckoutPanePluginBase implements CheckoutPanePluginInterface
      • class \Drupal\uc_cart\Plugin\Ubercart\CheckoutPane\OrderCommentsPane

File

uc_cart/src/Plugin/Ubercart/CheckoutPane/OrderCommentsPane.php, line 18

Namespace

Drupal\uc_cart\Plugin\Ubercart\CheckoutPane

class OrderCommentsPane extends CheckoutPanePluginBase {

  /**
   * {@inheritdoc}
   */
  public function view(OrderInterface $order, array $form, FormStateInterface $form_state) {
    $build['#description'] = $this
      ->t('Use this area for special instructions or questions regarding your order.');
    if ($order
      ->id()) {
      $default = \Drupal::database()
        ->query('SELECT message FROM {uc_order_comments} WHERE order_id = :id', [
        ':id' => $order
          ->id(),
      ])
        ->fetchField();
    }
    else {
      $default = NULL;
    }
    $build['comments'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Order comments'),
      '#default_value' => $default,
    ];
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function process(OrderInterface $order, array $form, FormStateInterface $form_state) {
    \Drupal::database()
      ->delete('uc_order_comments')
      ->condition('order_id', $order
      ->id())
      ->execute();
    if (!$form_state
      ->isValueEmpty([
      'panes',
      'comments',
      'comments',
    ])) {
      uc_order_comment_save($order
        ->id(), 0, $form_state
        ->getValue([
        'panes',
        'comments',
        'comments',
      ]), 'order', uc_order_state_default('post_checkout'), TRUE);
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function review(OrderInterface $order) {
    $review = NULL;
    $result = \Drupal::database()
      ->query('SELECT message FROM {uc_order_comments} WHERE order_id = :id', [
      ':id' => $order
        ->id(),
    ]);
    if ($comment = $result
      ->fetchObject()) {
      $review[] = [
        'title' => $this
          ->t('Comment'),
        'data' => [
          '#markup' => $comment->message,
        ],
      ];
    }
    return $review;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CheckoutPanePluginBase::$status	protected	property	Whether the pane is enabled or not.
CheckoutPanePluginBase::$weight	protected	property	The weight of the checkout pane.
CheckoutPanePluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	3
CheckoutPanePluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
CheckoutPanePluginBase::getTitle	public	function	Returns the title of the pane, to be displayed on the checkout form. Overrides CheckoutPanePluginInterface::getTitle
CheckoutPanePluginBase::getWeight	public	function	Returns the weight of the checkout pane. Overrides CheckoutPanePluginInterface::getWeight
CheckoutPanePluginBase::isEnabled	public	function	Returns whether the checkout pane is enabled. Overrides CheckoutPanePluginInterface::isEnabled
CheckoutPanePluginBase::prepare	public	function	Prepares a pane for display. Overrides CheckoutPanePluginInterface::prepare	1
CheckoutPanePluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
CheckoutPanePluginBase::settingsForm	public	function	Returns the settings form for a checkout pane. Overrides CheckoutPanePluginInterface::settingsForm	3
CheckoutPanePluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	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.
OrderCommentsPane::process	public	function	Processes a checkout pane. Overrides CheckoutPanePluginBase::process
OrderCommentsPane::review	public	function	Returns the review contents of a checkout pane. Overrides CheckoutPanePluginInterface::review
OrderCommentsPane::view	public	function	Returns the contents of a checkout pane. Overrides CheckoutPanePluginInterface::view
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.