class OrderController in Ubercart 8.4

Controller routines for order routes.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\uc_order\Controller\OrderController

File

uc_order/src/Controller/OrderController.php, line 15

Namespace

Drupal\uc_order\Controller

class OrderController extends ControllerBase {

  /**
   * Creates an order for the specified user, and redirects to the edit page.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user to create the order for.
   */
  public function createForUser(UserInterface $user) {
    $order = Order::create([
      'uid' => $user
        ->id(),
      'order_status' => uc_order_state_default('post_checkout'),
    ]);
    $order
      ->save();
    uc_order_comment_save($order
      ->id(), $this
      ->currentUser()
      ->id(), $this
      ->t('Order created by the administration.'), 'admin');
    return $this
      ->redirect('entity.uc_order.edit_form', [
      'uc_order' => $order
        ->id(),
    ]);
  }

  /**
   * Displays an order invoice.
   *
   * @param \Drupal\uc_order\OrderInterface $uc_order
   *   The order entity.
   * @param bool $print
   *   Whether to generate a printable version.
   *
   * @return array|string
   *   A render array or HTML markup in a form suitable for printing.
   */
  public function invoice(OrderInterface $uc_order, $print = FALSE) {
    $invoice = [
      '#theme' => 'uc_order_invoice',
      '#order' => $uc_order,
      '#op' => $print ? 'print' : 'view',
    ];
    if ($print) {
      $build = [
        '#theme' => 'uc_order_invoice_page',
        '#content' => $invoice,
      ];
      $markup = \Drupal::service('renderer')
        ->renderPlain($build);
      $response = new Response($markup);
      $response->headers
        ->set('Content-Type', 'text/html; charset=utf-8');
      return $response;
    }
    return $invoice;
  }

  /**
   * Displays a log of changes made to an order.
   *
   * @param \Drupal\uc_order\OrderInterface $uc_order
   *   The order entity.
   *
   * @return array
   *   A render array.
   */
  public function log(OrderInterface $uc_order) {
    $result = \Drupal::database()
      ->query('SELECT order_log_id, uid, changes, created FROM {uc_order_log} WHERE order_id = :id ORDER BY order_log_id DESC', [
      ':id' => $uc_order
        ->id(),
    ]);
    $header = [
      $this
        ->t('Time'),
      $this
        ->t('User'),
      $this
        ->t('Changes'),
    ];
    $rows = [];
    foreach ($result as $change) {
      $rows[] = [
        \Drupal::service('date.formatter')
          ->format($change->created, 'short'),
        [
          'data' => [
            '#theme' => 'username',
            '#account' => User::load($change->uid),
          ],
        ],
        [
          'data' => [
            '#markup' => $change->changes,
          ],
        ],
      ];
    }
    $build['log'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#empty' => $this
        ->t('No changes have been logged for this order.'),
    ];
    return $build;
  }

  /**
   * The title callback for order view routes.
   *
   * @param \Drupal\uc_order\OrderInterface $uc_order
   *   The order that is being viewed.
   *
   * @return string
   *   The page title.
   */
  public function pageTitle(OrderInterface $uc_order) {
    return $uc_order
      ->label();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	40
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OrderController::createForUser	public	function	Creates an order for the specified user, and redirects to the edit page.
OrderController::invoice	public	function	Displays an order invoice.
OrderController::log	public	function	Displays a log of changes made to an order.
OrderController::pageTitle	public	function	The title callback for order view routes.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.