You are here

Home » API reference » Ubercart 8.4 » PrintInvoiceAction.php

class PrintInvoiceAction in Ubercart 8.4

Sets the response to a page that triggres the print dialog.

Plugin annotation


@Action(
  id = "uc_order_print_action",
  label = @Translation("Print invoice"),
  type = "uc_order"
)

Hierarchy

Expanded class hierarchy of PrintInvoiceAction

File

uc_order/src/Plugin/Action/PrintInvoiceAction.php, line 22

Namespace

Drupal\uc_order\Plugin\Action
View source 
class PrintInvoiceAction extends ActionBase implements ContainerFactoryPluginInterface {

  /**
   * The event dispatcher service.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $dispatcher;

  /**
   * Constructs a new DeleteNode object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher
   *   The event dispatcher service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EventDispatcherInterface $dispatcher) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->dispatcher = $dispatcher;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('event_dispatcher'));
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {

    /** @var \Drupal\uc_order\OrderInterface $object */
    return $object
      ->access('view', $account, $return_as_object);
  }

  /**
   * {@inheritdoc}
   */
  public function execute($order = NULL) {
    $build = [
      '#theme' => 'uc_order_invoice',
      '#order' => $order,
      '#op' => 'print',
      '#prefix' => '<div style="page-break-after: always;">',
      '#suffix' => '</div>',
    ];
    $output = '<html><head><title>Invoice</title></head>';
    $output .= '<body onload="print();">';
    $output .= drupal_render($build);
    $output .= '</body></html>';
    $response = new Response($output);
    $listener = function ($event) use ($response) {
      $event
        ->setResponse($response);
    };

    // Add the listener to the event dispatcher.
    $this->dispatcher
      ->addListener(KernelEvents::RESPONSE, $listener);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 3
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.
PrintInvoiceAction::$dispatcher protected property The event dispatcher service.
PrintInvoiceAction::access public function Checks object access. Overrides ActionInterface::access
PrintInvoiceAction::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PrintInvoiceAction::execute public function Executes the plugin. Overrides ExecutableInterface::execute
PrintInvoiceAction::__construct public function Constructs a new DeleteNode object. Overrides PluginBase::__construct
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.