class OrderComments in Ubercart 8.4

View the order comments, used for communicating with customers.

Plugin annotation

@UbercartOrderPane(
  id = "order_comments",
  title = @Translation("Order comments"),
  weight = 8,
)

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\Plugin\Ubercart\OrderPane\OrderComments

File

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

Namespace

Drupal\uc_order\Plugin\Ubercart\OrderPane

class OrderComments extends OrderPanePluginBase {

  /**
   * {@inheritdoc}
   */
  public function view(OrderInterface $order, $view_mode) {

    // @todo Simplify this or replace with Views
    if ($view_mode == 'customer') {
      $comments = uc_order_comments_load($order
        ->id());
      $statuses = OrderStatus::loadMultiple();
      $header = [
        [
          'data' => $this
            ->t('Date'),
          'class' => [
            'date',
          ],
        ],
        [
          'data' => $this
            ->t('Status'),
          'class' => [
            'status',
          ],
        ],
        [
          'data' => $this
            ->t('Message'),
          'class' => [
            'message',
          ],
        ],
      ];
      $rows[] = [
        [
          'data' => \Drupal::service('date.formatter')
            ->format($order->created->value, 'short'),
          'class' => [
            'date',
          ],
        ],
        [
          'data' => '-',
          'class' => [
            'status',
          ],
        ],
        [
          'data' => $this
            ->t('Order created.'),
          'class' => [
            'message',
          ],
        ],
      ];
      if (count($comments) > 0) {
        foreach ($comments as $comment) {
          $rows[] = [
            [
              'data' => \Drupal::service('date.formatter')
                ->format($comment->created, 'short'),
              'class' => [
                'date',
              ],
            ],
            [
              'data' => [
                '#plain_text' => $statuses[$comment->order_status]
                  ->getName(),
              ],
              'class' => [
                'status',
              ],
            ],
            [
              'data' => [
                '#markup' => $comment->message,
              ],
              'class' => [
                'message',
              ],
            ],
          ];
        }
      }
      $build = [
        '#theme' => 'table',
        '#header' => $header,
        '#rows' => $rows,
        '#attributes' => [
          'class' => [
            'uc-order-comments',
          ],
        ],
      ];
    }
    else {
      $build = [
        '#theme' => 'table',
        '#header' => [
          [
            'data' => $this
              ->t('Date'),
            'class' => [
              'date',
            ],
          ],
          [
            'data' => $this
              ->t('User'),
            'class' => [
              'user',
              RESPONSIVE_PRIORITY_LOW,
            ],
          ],
          [
            'data' => $this
              ->t('Notified'),
            'class' => [
              'notified',
            ],
          ],
          [
            'data' => $this
              ->t('Status'),
            'class' => [
              'status',
              RESPONSIVE_PRIORITY_LOW,
            ],
          ],
          [
            'data' => $this
              ->t('Comment'),
            'class' => [
              'message',
            ],
          ],
        ],
        '#rows' => [],
        '#attributes' => [
          'class' => [
            'order-pane-table uc-order-comments',
          ],
        ],
        '#empty' => $this
          ->t('This order has no comments associated with it.'),
      ];
      $comments = uc_order_comments_load($order
        ->id());
      $statuses = OrderStatus::loadMultiple();
      foreach ($comments as $comment) {
        $icon = $comment->notified ? 'true-icon.gif' : 'false-icon.gif';
        $build['#rows'][] = [
          [
            'data' => \Drupal::service('date.formatter')
              ->format($comment->created, 'short'),
            'class' => [
              'date',
            ],
          ],
          [
            'data' => [
              '#theme' => 'username',
              '#account' => User::load($comment->uid),
            ],
            'class' => [
              'user',
            ],
          ],
          [
            'data' => [
              '#theme' => 'image',
              '#uri' => drupal_get_path('module', 'uc_order') . '/images/' . $icon,
            ],
            'class' => [
              'notified',
            ],
          ],
          [
            'data' => [
              '#plain_text' => $statuses[$comment->order_status]
                ->getName(),
            ],
            'class' => [
              'status',
            ],
          ],
          [
            'data' => [
              '#markup' => $comment->message,
            ],
            'class' => [
              'message',
            ],
          ],
        ];
      }
    }
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
OrderComments::view	public	function	Returns the contents of an order pane as a store administrator. Overrides OrderPanePluginInterface::view
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.