Token.php in Commerce AutoSKU 8.2

Namespace

Drupal\commerce_autosku\Plugin\CommerceAutoSkuGenerator

File

src/Plugin/CommerceAutoSkuGenerator/Token.php

<?php

/**
 * Created by PhpStorm.
 * User: oleg
 * Date: 22.07.17
 * Time: 14:56
 */
namespace Drupal\commerce_autosku\Plugin\CommerceAutoSkuGenerator;

use Drupal\commerce_product\Entity\ProductVariationInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormStateInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Render\BubbleableMetadata;

/**
 * Provides the token commerce_autosku generator.
 *
 * @CommerceAutoSkuGenerator(
 *   id = "token",
 *   label = @Translation("Token"),
 * )
 */
class Token extends CommerceAutoSkuGeneratorBase {

  /**
   * Token service.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * Constructs a new Token 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 \Drupal\Core\Utility\Token $token
   *   The token manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, \Drupal\Core\Utility\Token $token) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager);
    $this->token = $token;
    $this
      ->setConfiguration($configuration);
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'pattern' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['pattern'] = [
      '#type' => 'textarea',
      '#title' => t('Pattern for the SKU'),
      '#description' => t('Leave blank for using the per default generated SKU. Otherwise this string will be used as SKU. Use the syntax [token] if you want to insert a replacement pattern.'),
      '#default_value' => $this
        ->getConfiguration()['pattern'],
    ];
    $form['token_help'] = [
      '#theme' => 'token_tree_link',
      '#token_types' => [
        'user',
        'site',
        'commerce_product_variation',
      ],
      '#dialog' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getSku(ProductVariationInterface $entity) {
    $entity_type = $entity
      ->getEntityTypeId();
    $configuration = $this
      ->getConfiguration();

    // Pass empty BubbleableMetadata object to explicitly ignore cacheablity,
    // as the result is never rendered.
    $sku = $this->token
      ->replace($configuration['pattern'], [
      $entity_type => $entity,
    ], [
      'sanitize' => FALSE,
      'clear' => TRUE,
    ], new BubbleableMetadata());
    return $sku;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValue($form['#parents']);
    $tokens = $this->token
      ->scan($values['pattern']);
    if (empty($tokens) && !empty($values['pattern'])) {
      $form_state
        ->setError($form['pattern'], 'At least one token from available tokens list required');
    }
  }

}

Classes

Name	Description
Token	Provides the token commerce_autosku generator.