' . t('Provides the ability to generate and print product labels.') . '
'; + + $label_formats = commerce_pos_label_get_label_formats(); + + // Print out our currently defined label formats. + if (!empty($label_formats)) { + $output .= '' . t('Defined label format(s):') . ''; + + foreach ($label_formats as $label_format) { + $output .= ' . ')
';
+ }
+ else {
+ // If we fail to generate the barcode, omit it.
+ $variables['barcode'] = '';
+ }
+ }
+}
diff --git a/modules/label/commerce_pos_label.permissions.yml b/modules/label/commerce_pos_label.permissions.yml
new file mode 100644
index 0000000..138c859
--- /dev/null
+++ b/modules/label/commerce_pos_label.permissions.yml
@@ -0,0 +1,2 @@
+commerce pos print labels:
+ title: 'Print labels with Commerce Point of Sale'
diff --git a/modules/label/commerce_pos_label.routing.yml b/modules/label/commerce_pos_label.routing.yml
new file mode 100644
index 0000000..5c63362
--- /dev/null
+++ b/modules/label/commerce_pos_label.routing.yml
@@ -0,0 +1,15 @@
+commerce_pos_label.print_labels:
+ path: 'admin/commerce/pos/labels'
+ defaults:
+ _title: 'Print labels'
+ _form: '\Drupal\commerce_pos_label\Form\PrintLabelsForm'
+ requirements:
+ _permission: 'commerce pos print labels'
+
+commerce_pos_label.print_label:
+ path: 'admin/commerce/pos/labels/{commerce_product_variation}'
+ defaults:
+ _title: 'Print labels'
+ _form: '\Drupal\commerce_pos_label\Form\PrintLabelsForm'
+ requirements:
+ _permission: 'commerce pos print labels'
diff --git a/modules/label/commerce_pos_label.services.yml b/modules/label/commerce_pos_label.services.yml
new file mode 100644
index 0000000..fa6ffd1
--- /dev/null
+++ b/modules/label/commerce_pos_label.services.yml
@@ -0,0 +1,6 @@
+services:
+ plugin.manager.label_format:
+ class: Drupal\commerce_pos_label\LabelFormatManager
+ arguments: ['@module_handler', '@cache.discovery']
+ commerce_pos_label.barcode_generator:
+ class: Drupal\commerce_pos_label\BarcodeGenerator
diff --git a/modules/label/composer.json b/modules/label/composer.json
new file mode 100644
index 0000000..94f2adb
--- /dev/null
+++ b/modules/label/composer.json
@@ -0,0 +1,10 @@
+{
+ "name": "drupal/commerce_pos_label",
+ "type": "drupal-module",
+ "description": "Commerce POS label printing.",
+ "license": "GPL-2.0+",
+ "require": {
+ "picqer/php-barcode-generator": "0.2.2"
+ },
+ "minimum-stability": "dev"
+}
diff --git a/modules/label/css/commerce_pos_label.css b/modules/label/css/commerce_pos_label.css
new file mode 100644
index 0000000..54b41ed
--- /dev/null
+++ b/modules/label/css/commerce_pos_label.css
@@ -0,0 +1,38 @@
+@page {
+ margin: 2mm 0 0 0;
+ padding: 0;
+ font-size: 12px; }
+body {
+ font-size: 12px; }
+
+.commerce-pos-label {
+ padding: 0;
+ font-family: Arial, sans-serif;
+ margin: 0 auto;
+ text-align: center;
+ font-size: 12px;
+ text-transform: uppercase; }
+ @media print {
+ .commerce-pos-label {
+ page-break-after: always; } }
+ .commerce-pos-label * {
+ margin: 0;
+ padding: 0; }
+ .commerce-pos-label .barcode {
+ margin: 0.4em 0; }
+ .commerce-pos-label .description {
+ font-size: 0.85em; }
+ .commerce-pos-label.no-description .barcode {
+ margin: 0.9em 0; }
+ .commerce-pos-label img {
+ display: inline-block; }
+ .commerce-pos-label div {
+ white-space: nowrap;
+ width: 100%;
+ overflow: hidden;
+ -ms-text-overflow: ellipsis;
+ text-overflow: ellipsis; }
+ .commerce-pos-label div.price {
+ font-size: 2em; }
+
+/*# sourceMappingURL=commerce_pos_label.css.map */
diff --git a/modules/label/css/commerce_pos_label.css.map b/modules/label/css/commerce_pos_label.css.map
new file mode 100644
index 0000000..1927ac8
--- /dev/null
+++ b/modules/label/css/commerce_pos_label.css.map
@@ -0,0 +1,7 @@
+{
+"version": 3,
+"mappings": "AAAA,KAIC;EAHC,MAAM,EAAE,SAAS;EACjB,OAAO,EAAE,CAAC;EACV,SAAS,EAAE,IAAI;AAGjB,IAAK;EACH,SAAS,EAAE,IAAI;;AAGjB,mBAAoB;EAClB,OAAO,EAAE,CAAC;EAWV,WAAW,EAAE,iBAAiB;EAC9B,MAAM,EAAE,MAAM;EACd,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,IAAI;EACf,cAAc,EAAE,SAAS;EAbzB,YAAa;IAHf,mBAAoB;MAIhB,gBAAgB,EAAE,MAAM;EAG1B,qBAAE;IACA,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;EASZ,4BAAS;IACP,MAAM,EAAE,OAAO;EAGjB,gCAAa;IACX,SAAS,EAAE,MAAM;EAIjB,2CAAS;IACP,MAAM,EAAE,OAAQ;EAIpB,uBAAI;IACF,OAAO,EAAE,YAAY;EAGvB,uBAAI;IACF,WAAW,EAAE,MAAM;IACnB,KAAK,EAAE,IAAI;IACX,QAAQ,EAAE,MAAM;IAChB,iBAAiB,EAAE,QAAQ;IAC3B,aAAa,EAAE,QAAQ;IAEvB,6BAAQ;MACN,SAAS,EAAE,GAAG",
+"sources": ["../sass/commerce_pos_label.scss"],
+"names": [],
+"file": "commerce_pos_label.css"
+}
\ No newline at end of file
diff --git a/modules/label/js/commerce_pos_label.js b/modules/label/js/commerce_pos_label.js
new file mode 100644
index 0000000..2496076
--- /dev/null
+++ b/modules/label/js/commerce_pos_label.js
@@ -0,0 +1,20 @@
+(function ($, Drupal, drupalSettings) {
+
+ /**
+ * Ajax command to set the toolbar subtrees.
+ *
+ * @param {Drupal.Ajax} ajax
+ * {@link Drupal.Ajax} object created by {@link Drupal.ajax}.
+ * @param {object} response
+ * JSON response from the Ajax request.
+ * @param {number} [status]
+ * XMLHttpRequest status.
+ */
+ Drupal.AjaxCommands.prototype.printLabels = function (ajax, response, status) {
+ $(response.content).print({
+ globalStyles: false,
+ stylesheet: response.cssUrl
+ });
+ };
+
+}(jQuery, Drupal, drupalSettings));
diff --git a/modules/label/sass/commerce_pos_label.scss b/modules/label/sass/commerce_pos_label.scss
new file mode 100644
index 0000000..eb931bf
--- /dev/null
+++ b/modules/label/sass/commerce_pos_label.scss
@@ -0,0 +1,58 @@
+@page {
+ margin: 2mm 0 0 0;
+ padding: 0;
+ font-size: 12px;
+}
+
+body {
+ font-size: 12px;
+}
+
+.commerce-pos-label {
+ padding: 0;
+
+ @media print {
+ page-break-after: always;
+ }
+
+ * {
+ margin: 0;
+ padding: 0;
+ }
+
+ font-family: Arial, sans-serif;
+ margin: 0 auto;
+ text-align: center;
+ font-size: 12px;
+ text-transform: uppercase;
+
+ .barcode {
+ margin: 0.4em 0;
+ }
+
+ .description {
+ font-size: 0.85em;
+ }
+
+ &.no-description {
+ .barcode {
+ margin: 0.9em 0 ;
+ }
+ }
+
+ img {
+ display: inline-block;
+ }
+
+ div {
+ white-space: nowrap;
+ width: 100%;
+ overflow: hidden;
+ -ms-text-overflow: ellipsis;
+ text-overflow: ellipsis;
+
+ &.price {
+ font-size: 2em;
+ }
+ }
+}
diff --git a/modules/label/src/Ajax/PrintLabelsCommand.php b/modules/label/src/Ajax/PrintLabelsCommand.php
new file mode 100644
index 0000000..856fac0
--- /dev/null
+++ b/modules/label/src/Ajax/PrintLabelsCommand.php
@@ -0,0 +1,59 @@
+labels = $labels;
+
+ $format = commerce_pos_label_format_load($format);
+ $css = $format['css'];
+ if ($css) {
+ $provider_path = \Drupal::service('module_handler')->getModule($format['provider'])->getPath();
+ $css = Url::fromUri('base:' . $provider_path . '/' . $css, ['absolute' => TRUE])->toString();
+ }
+ $this->cssUrl = $css;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function render() {
+ return [
+ 'command' => 'printLabels',
+ 'content' => $this->labels,
+ 'cssUrl' => $this->cssUrl,
+ ];
+ }
+
+}
diff --git a/modules/label/src/BarcodeGenerator.php b/modules/label/src/BarcodeGenerator.php
new file mode 100644
index 0000000..1b259ec
--- /dev/null
+++ b/modules/label/src/BarcodeGenerator.php
@@ -0,0 +1,67 @@
+ ExternalGenerator::TYPE_EAN_8,
+ 12 => ExternalGenerator::TYPE_UPC_A,
+ 13 => ExternalGenerator::TYPE_EAN_13,
+ ];
+
+ $length = strlen($upc);
+
+ return (isset($map[$length]))? $map[$length] : FALSE;
+ }
+
+ /**
+ * Render a UPC into a PNG barcode.
+ *
+ * @param string $upc
+ * A UPC.
+ * @param int $widthFactor
+ * Width of a single bar element in pixels.
+ * @param int $totalHeight
+ * Height of a single bar element in pixels.
+ *
+ * @return string
+ * The barcode as raw PNG data.
+ */
+ public function png($upc, $widthFactor = 2, $totalHeight = 40) {
+ $type = $this->type($upc);
+ if ($type) {
+ $generator = new BarcodeGeneratorPNG();
+ try {
+ return $generator->getBarcode($upc, $type, $widthFactor, $totalHeight);
+ }
+ catch (BarcodeException $e) {
+ return FALSE;
+ }
+ }
+
+ return FALSE;
+ }
+
+}
diff --git a/modules/label/src/BarcodeGeneratorInterface.php b/modules/label/src/BarcodeGeneratorInterface.php
new file mode 100644
index 0000000..5c9f178
--- /dev/null
+++ b/modules/label/src/BarcodeGeneratorInterface.php
@@ -0,0 +1,27 @@
+productVariationStorage = $entityTypeManager->getStorage('commerce_product_variation');
+ $this->currencyStorage = $entityTypeManager->getStorage('commerce_currency');
+ $this->renderer = $renderer;
+ $this->rounder = $rounder;
+ $this->formatter = $formatterFactory->createInstance();
+ $this->upc = $upc;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function create(ContainerInterface $container) {
+ return new static(
+ $container->get('entity_type.manager'),
+ $container->get('renderer'),
+ $container->get('commerce_price.rounder'),
+ $container->get('commerce_price.number_formatter_factory'),
+ $container->get('commerce_pos.upc')
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function buildForm(array $form, FormStateInterface $form_state, ProductVariationInterface $commerce_product_variation = NULL) {
+ $product_variation = $commerce_product_variation;
+
+ $form['#attached']['library'][] = 'commerce_pos_label/label';
+ $form['#attached']['library'][] = 'commerce_pos/jQuery.print';
+
+ $labels_to_create = $this->getLabelList($form_state);
+ if ($product_variation && !$labels_to_create) {
+ $labels_to_create[$product_variation->id()] = $this->buildInfoArray($product_variation);
+ $form_state->setValue('label_list', $labels_to_create);
+ }
+
+ $format_options = array_map(function ($format) {
+ return $format['title'];
+ }, commerce_pos_label_get_label_formats());
+
+ // We need at least 1 label format to proceed.
+ if (empty($format_options)) {
+ drupal_set_message($this->t('There are no available label formats. Please enable at least one POS label format module.'), 'error');
+ return $form;
+ }
+
+ $form_wrapper_id = 'commerce-pos-label-form-container';
+
+ $form['#attributes'] = [
+ 'id' => $form_wrapper_id,
+ 'class' => ['commerce-pos-form-container'],
+ ];
+
+ $form['label_format'] = [
+ '#type' => 'select',
+ '#title' => $this->t('Label format'),
+ '#options' => $format_options,
+ '#required' => TRUE,
+ '#default_value' => key($format_options),
+ ];
+
+ $form['product_search'] = [
+ '#type' => 'entity_autocomplete',
+ '#target_type' => 'commerce_product_variation',
+ '#title' => t('Product Search'),
+ '#title_display' => 'invisible',
+ '#size' => 60,
+ '#description' => $this->t('Search by product title.'),
+ '#attributes' => [
+ 'class' => [
+ 'commerce-pos-product-autocomplete',
+ 'commerce-pos-product-search',
+ ],
+ 'placeholder' => $this->t('Product Search'),
+ ],
+ ];
+
+ $form['product_search_add'] = [
+ '#type' => 'submit',
+ '#value' => $this->t('Add'),
+ '#validate' => ['::productAddValidate'],
+ '#submit' => ['::productAddSubmit'],
+ '#attributes' => [
+ 'class' => ['commerce-pos-label-btn-add commerce-pos-btn fixed-width btn-success'],
+ ],
+ ];
+
+ $form['label_options'] = [
+ '#type' => 'container',
+ ];
+
+ $form['label_options']['label_list'] = [
+ '#type' => 'table',
+ '#header' => [
+ $this->t('Quantity'),
+ $this->t('Title'),
+ $this->t('Description'),
+ $this->t('Price'),
+ $this->t('Remove'),
+ ],
+ '#tree' => TRUE,
+ ];
+
+ foreach ($labels_to_create as $product_variation_id => $label_info) {
+
+ $form['label_options']['label_list'][$product_variation_id]['quantity'] = [
+ '#type' => 'textfield',
+ '#title' => $this->t('Quantity'),
+ '#value' => $label_info['quantity'],
+ '#required' => TRUE,
+ '#size' => 5,
+ ];
+
+ $form['label_options']['label_list'][$product_variation_id]['title'] = [
+ '#title' => $this->t('Title'),
+ '#type' => 'textfield',
+ '#required' => TRUE,
+ '#value' => $label_info['title'],
+ ];
+
+ $form['label_options']['label_list'][$product_variation_id]['description'] = [
+ '#title' => $this->t('Description'),
+ '#type' => 'textfield',
+ '#value' => $label_info['description'],
+ ];
+
+ $form['label_options']['label_list'][$product_variation_id]['price'] = [
+ '#type' => 'textfield',
+ '#title' => $this->t('Price'),
+ '#value' => $label_info['price'],
+ '#required' => TRUE,
+ '#size' => 5,
+ ];
+
+ $form['label_options']['label_list'][$product_variation_id]['remove'] = [
+ '#type' => 'submit',
+ '#value' => $this->t('Remove'),
+ '#name' => 'remove-' . $product_variation_id,
+ '#validate' => ['::productRemoveValidate'],
+ '#submit' => ['::productRemoveSubmit'],
+ '#product_id' => $product_variation_id,
+ '#attributes' => [
+ 'class' => ['commerce-pos-btn fixed-width btn-danger'],
+ ],
+ ];
+ }
+
+ if ($labels_to_create) {
+ $form['label_options']['print_labels'] = [
+ '#type' => 'button',
+ '#value' => $this->t('Print'),
+ '#ajax' => [
+ 'callback' => '::printLabels',
+ ],
+ '#attributes' => [
+ 'class' => ['commerce-pos-btn fixed-width'],
+ ],
+ ];
+ }
+
+ return $form;
+ }
+
+ /**
+ * Generate barcode from product variation title.
+ */
+ public function printLabels($form, FormStateInterface $form_state) {
+ $labels = [
+ '#theme' => 'commerce_pos_labels',
+ '#labels' => [],
+ ];
+ $label_values = $this->getLabelList($form_state);
+ $label_format = $form_state->getValue('label_format');
+
+ // Convert form values into a render array to theme the labels.
+ foreach ($label_values as $product_id => $label) {
+ unset($label['remove']);
+ foreach ($label as $key => $value) {
+ $label['#' . $key] = $value;
+ unset($label[$key]);
+ }
+
+ $label['#product_id'] = $product_id;
+ $label['#theme'] = 'commerce_pos_label';
+ $label['#format'] = $label_format;
+ $label['#barcode'] = $this->upc->get($product_id);
+
+ for ($i = 0; $i < $label['#quantity']; $i++) {
+ $labels['#labels'][] = $label;
+ }
+ }
+
+ $labels = $this->renderer->render($labels);
+
+ $response = new AjaxResponse();
+ $response->addCommand(new PrintLabelsCommand($labels, $label_format));
+ return $response;
+ }
+
+ /**
+ * Validation for adding a product.
+ */
+ public function productAddValidate(array &$form, FormStateInterface $form_state) {
+ $product_id = $form_state->getValue('product_search');
+
+ if (empty($product_id) || !$this->productVariationStorage->load($product_id)) {
+ $form_state->setError($form['product_search'], $this->t('Invalid product.'));
+ }
+ }
+
+ /**
+ * Submit handler for adding a product.
+ */
+ public function productAddSubmit(array &$form, FormStateInterface $form_state) {
+ $product_id = $form_state->getValue('product_search');
+
+ /** @var \Drupal\commerce_product\Entity\ProductVariationInterface $product */
+ $product = $this->productVariationStorage->load($product_id);
+ $labels = $this->getLabelList($form_state);
+ if (empty($labels[$product_id])) {
+ $labels[$product_id] = $this->buildInfoArray($product);
+ $form_state->setValue('label_list', $labels);
+ }
+ $form_state->setRebuild(TRUE);
+ }
+
+ /**
+ * Validation for adding a product.
+ */
+ public function productRemoveValidate(array &$form, FormStateInterface $form_state) {
+ $trigger = $form_state->getTriggeringElement();
+ if (!empty($trigger['#product_id'])) {
+ $labels = $this->getLabelList($form_state);
+ if (!isset($labels[$trigger['#product_id']])) {
+ $form_state->setError($form['label_list'], $this->t('Can not remove a product that is was added.'));
+ }
+ }
+ }
+
+ /**
+ * Submit handler for removing a product.
+ */
+ public function productRemoveSubmit(array &$form, FormStateInterface $form_state) {
+ $trigger = $form_state->getTriggeringElement();
+ if (!empty($trigger['#product_id'])) {
+ $labels = $this->getLabelList($form_state);
+ unset($labels[$trigger['#product_id']]);
+ $form_state->setValue('label_list', $labels);
+ }
+ $form_state->setRebuild(TRUE);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function submitForm(array &$form, FormStateInterface $form_state) {
+ $form_state->setRebuild(TRUE);
+ }
+
+ /**
+ * Build an array of product info used for printing labels.
+ *
+ * @param \Drupal\commerce_product\Entity\ProductVariationInterface $product_variation
+ * The product variation to create the array for.
+ *
+ * @return array
+ * The info array.
+ */
+ protected function buildInfoArray(ProductVariationInterface $product_variation) {
+ $price = $product_variation->getPrice();
+ /** @var \Drupal\commerce_price\Entity\Currency $currency */
+ $currency = $this->currencyStorage->load($price->getCurrencyCode());
+
+ return [
+ 'title' => $product_variation->getSku(),
+ 'quantity' => 1,
+ 'price' => $this->formatter->formatCurrency($this->rounder->round($price)->getNumber(), $currency),
+ 'description' => $product_variation->getTitle(),
+ ];
+ }
+
+ /**
+ * Get the label list value.
+ *
+ * Ensures that when label_list is empty we get an empty array instead of an
+ * empty string.
+ *
+ * @return array
+ * An array of form elements for the label list.
+ */
+ protected function getLabelList(FormStateInterface $form_state) {
+ return $form_state->getValue('label_list') ?: [];
+ }
+
+}
diff --git a/modules/label/src/LabelFormatManager.php b/modules/label/src/LabelFormatManager.php
new file mode 100644
index 0000000..7a689ac
--- /dev/null
+++ b/modules/label/src/LabelFormatManager.php
@@ -0,0 +1,79 @@
+ '',
+ 'title' => '',
+ 'css' => FALSE,
+ 'dimensions' => [
+ 'width' => 0,
+ 'height' => 0,
+ ],
+ 'class' => LabelFormat::class,
+ ];
+
+ /**
+ * Constructs a new LabelFormatManager object.
+ *
+ * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
+ * The module handler.
+ * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
+ * The cache backend.
+ */
+ public function __construct(ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend) {
+ $this->moduleHandler = $module_handler;
+ $this->setCacheBackend($cache_backend, 'label_format', ['label_format']);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function getDiscovery() {
+ if (!isset($this->discovery)) {
+ $this->discovery = new YamlDiscovery('label_formats', $this->moduleHandler->getModuleDirectories());
+ $this->discovery->addTranslatableProperty('title', 'title_context');
+ $this->discovery = new ContainerDerivativeDiscoveryDecorator($this->discovery);
+ }
+ return $this->discovery;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function processDefinition(&$definition, $plugin_id) {
+ parent::processDefinition($definition, $plugin_id);
+ $definition['id'] = $plugin_id;
+ if (empty($definition['title'])) {
+ throw new PluginException(sprintf('The label format %s must define the title property.', $plugin_id));
+ }
+ if (empty($definition['dimensions']['width'])) {
+ throw new PluginException(sprintf('The label format %s must define the dimension width property.', $plugin_id));
+ }
+ if (empty($definition['dimensions']['height'])) {
+ throw new PluginException(sprintf('The label format %s must define the dimension height property.', $plugin_id));
+ }
+ }
+
+}
diff --git a/modules/label/src/Plugin/LabelFormat/LabelFormat.php b/modules/label/src/Plugin/LabelFormat/LabelFormat.php
new file mode 100644
index 0000000..3f9381e
--- /dev/null
+++ b/modules/label/src/Plugin/LabelFormat/LabelFormat.php
@@ -0,0 +1,40 @@
+pluginDefinition['id'];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getTitle() {
+ return $this->pluginDefinition['title'];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getCss() {
+ return $this->pluginDefinition['css'];
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getDimensions() {
+ return $this->pluginDefinition['dimensions'];
+ }
+
+}
diff --git a/modules/label/src/Plugin/LabelFormat/LabelFormatInterface.php b/modules/label/src/Plugin/LabelFormat/LabelFormatInterface.php
new file mode 100644
index 0000000..6728fb9
--- /dev/null
+++ b/modules/label/src/Plugin/LabelFormat/LabelFormatInterface.php
@@ -0,0 +1,44 @@
+
+