class AdminComments in Ubercart 8.4

View the admin comments, used for administrative notes and instructions.

Plugin annotation

@UbercartOrderPane(
  id = "admin_comments",
  title = @Translation("Admin comments"),
  weight = 9,
)

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\AdminComments

File

uc_order/src/Plugin/Ubercart/OrderPane/AdminComments.php, line 19

Namespace

Drupal\uc_order\Plugin\Ubercart\OrderPane

class AdminComments extends EditableOrderPanePluginBase {

  /**
   * {@inheritdoc}
   */
  public function view(OrderInterface $order, $view_mode) {
    if ($view_mode != 'customer') {
      $build = [
        '#theme' => 'table',
        '#header' => [
          [
            'data' => $this
              ->t('Date'),
            'class' => [
              'date',
            ],
          ],
          [
            'data' => $this
              ->t('User'),
            'class' => [
              'user',
            ],
          ],
          [
            'data' => $this
              ->t('Comment'),
            'class' => [
              'message',
            ],
          ],
        ],
        '#rows' => [],
        '#attributes' => [
          'class' => [
            'order-pane-table uc-order-comments',
          ],
        ],
        '#empty' => $this
          ->t('This order has no admin comments associated with it.'),
      ];
      $comments = uc_order_comments_load($order
        ->id(), TRUE);
      foreach ($comments as $comment) {
        $build['#rows'][] = [
          [
            'data' => \Drupal::service('date.formatter')
              ->format($comment->created, 'short'),
            'class' => [
              'date',
            ],
          ],
          [
            'data' => [
              '#theme' => 'username',
              '#account' => User::load($comment->uid),
            ],
            'class' => [
              'user',
            ],
          ],
          [
            'data' => [
              '#markup' => $comment->message,
            ],
            'class' => [
              'message',
            ],
          ],
        ];
      }
      return $build;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(OrderInterface $order, array $form, FormStateInterface $form_state) {
    $items = [];
    $comments = uc_order_comments_load($order
      ->id(), TRUE);
    foreach ($comments as $comment) {
      $items[] = [
        'username' => [
          '#theme' => 'username',
          '#account' => User::load($comment->uid),
          '#prefix' => '[',
          '#suffix' => '] ',
        ],
        'message' => [
          '#markup' => $comment->message,
        ],
      ];
    }
    $form['comments'] = [
      '#theme' => 'item_list',
      '#items' => $items,
      '#empty' => $this
        ->t('No admin comments have been entered for this order.'),
    ];
    $form['admin_comment_field'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Add an admin comment'),
    ];
    $form['admin_comment_field']['admin_comment'] = [
      '#type' => 'textarea',
      '#description' => $this
        ->t('Admin comments are only seen by store administrators.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(OrderInterface $order, array &$form, FormStateInterface $form_state) {
    if (!$form_state
      ->isValueEmpty('admin_comment')) {
      $uid = \Drupal::currentUser()
        ->id();
      uc_order_comment_save($order
        ->id(), $uid, $form_state
        ->getValue('admin_comment'));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdminComments::buildForm	public	function	Form constructor. Overrides EditableOrderPanePluginInterface::buildForm
AdminComments::submitForm	public	function	Form submission handler. Overrides EditableOrderPanePluginInterface::submitForm
AdminComments::view	public	function	Returns the contents of an order pane as a store administrator. Overrides OrderPanePluginInterface::view
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::getClasses	public	function	Returns the classes used to wrap an order pane. Overrides OrderPanePluginInterface::getClasses	6
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.