class WebformSubmissionGenerate in Webform 8.5

Same name and namespace in other branches

6.x src/WebformSubmissionGenerate.php \Drupal\webform\WebformSubmissionGenerate

Webform submission generator.

View source

class WebformSubmissionGenerate implements WebformSubmissionGenerateInterface {

  /**
   * The configuration object factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The webform token manager.
   *
   * @var \Drupal\webform\WebformTokenManagerInterface
   */
  protected $tokenManager;

  /**
   * The webform element manager.
   *
   * @var \Drupal\webform\Plugin\WebformElementManagerInterface
   */
  protected $elementManager;

  /**
   * An associative array containing test values for elements by type.
   *
   * @var array
   */
  protected $types;

  /**
   * An associative array containing test values for elements by name.
   *
   * @var array
   */
  protected $names;

  /**
   * Constructs a WebformSubmissionGenerate object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration object factory.
   * @param \Drupal\webform\WebformTokenManagerInterface $token_manager
   *   The webform token manager.
   * @param \Drupal\webform\Plugin\WebformElementManagerInterface $element_manager
   *   The webform element manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, WebformTokenManagerInterface $token_manager, WebformElementManagerInterface $element_manager) {
    $this->configFactory = $config_factory;
    $this->tokenManager = $token_manager;
    $this->elementManager = $element_manager;
    $this->types = Yaml::decode($this->configFactory
      ->get('webform.settings')
      ->get('test.types') ?: '') ?: [];
    $this->names = Yaml::decode($this->configFactory
      ->get('webform.settings')
      ->get('test.names') ?: '') ?: [];
  }

  /**
   * {@inheritdoc}
   */
  public function getData(WebformInterface $webform) {
    $elements = $webform
      ->getElementsInitializedAndFlattened();
    $data = [];
    foreach ($elements as $key => $element) {
      $value = $this
        ->getTestValue($webform, $key, $element);
      if ($value !== NULL) {
        $data[$key] = $value;
      }
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function getTestValue(WebformInterface $webform, $name, array $element, array $options = []) {

    // Set default options.
    $options += [
      // Return random test value(s).
      'random' => TRUE,
    ];

    /** @var \Drupal\webform\Plugin\WebformElementInterface $element_plugin */
    $plugin_id = $this->elementManager
      ->getElementPluginId($element);
    $element_plugin = $this->elementManager
      ->createInstance($plugin_id);

    // Exit if element does not have a value.
    if (!$element_plugin
      ->isInput($element)) {
      return NULL;
    }

    // Exit if test values are null or an empty array.
    $values = $this
      ->getTestValues($webform, $name, $element, $options);
    if ($values === NULL || is_array($values) && empty($values)) {
      return NULL;
    }

    // Make sure value is an array.
    if (!is_array($values)) {
      $values = [
        $values,
      ];
    }

    // Apply #maxlength to values.
    // @see \Drupal\webform\Plugin\WebformElement\TextBase
    if (!empty($element['#maxlength'])) {
      $maxlength = $element['#maxlength'];
    }
    elseif (!empty($element['#counter_type']) && !empty($element['#counter_maximum']) && $element['#counter_type'] === 'character') {
      $maxlength = $element['#counter_maximum'];
    }
    else {
      $maxlength = NULL;
    }
    if ($maxlength) {
      foreach ($values as $index => $value) {
        $values[$index] = mb_substr($value, 0, $maxlength);
      }
    }

    // $values = $this->tokenManager->replace($values, $webform);.
    // Elements that use multiple values require an array as the
    // default value.
    if ($element_plugin
      ->hasMultipleValues($element)) {
      if ($options['random']) {
        shuffle($values);
      }
      $limit = 3;
      if (isset($element['#multiple'])) {

        // #multiple: FALSE is only applicable to webform_custom_composite element.
        // @see \Drupal\webform\Plugin\WebformElement\WebformComposite
        if ($element['#multiple'] === FALSE) {
          $limit = 1;
        }
        elseif ($element['#multiple'] > 1 && $element['#multiple'] < 3) {
          $limit = $element['#multiple'];
        }
      }
      return array_slice($values, 0, $limit);
    }
    else {
      return $options['random'] ? $values[array_rand($values)] : reset($values);
    }
  }

  /**
   * Get test values from a webform element.
   *
   * @param \Drupal\webform\WebformInterface $webform
   *   A webform.
   * @param string $name
   *   The name of the element.
   * @param array $element
   *   The FAPI element.
   * @param array $options
   *   (options) Options for generated value.
   *
   * @return array|int|null
   *   An array containing multiple test values or a single test value.
   */
  protected function getTestValues(WebformInterface $webform, $name, array $element, array $options = []) {

    // Get test value from the actual element.
    if (isset($element['#test'])) {
      return $element['#test'];
    }

    // Invoke WebformElement::test and get a test value.
    // If test value is NULL this element should never be populated with
    // test data.
    // @see \Drupal\webform\Plugin\WebformElement\ContainerBase::getTestValues().
    $test_values = $this->elementManager
      ->invokeMethod('getTestValues', $element, $webform, $options);
    if ($test_values) {
      return $test_values;
    }
    elseif ($test_values === NULL) {
      return NULL;
    }

    // Get test values from options.
    if (isset($element['#options'])) {
      return array_keys(OptGroup::flattenOptions($element['#options']));
    }

    // Get test values using #type.
    if (isset($this->types[$element['#type']])) {
      return $this->types[$element['#type']];
    }

    // Get test values using on exact name matches.
    if (isset($this->types[$name])) {
      return $this->types[$name];
    }

    // Get test values using partial name matches.
    foreach ($this->names as $key => $values) {
      if (preg_match('/(^|_)' . $key . '(_|$)/i', $name)) {
        return $values;
      }
    }

    // Get test #unique value.
    if (!empty($element['#unique'])) {
      return uniqid();
    }

    // Return default values.
    return isset($this->names['default']) ? $this->names['default'] : NULL;
  }

}

Members

Name	Modifiers	Type	Description
WebformSubmissionGenerate::$configFactory	protected	property	The configuration object factory.
WebformSubmissionGenerate::$elementManager	protected	property	The webform element manager.
WebformSubmissionGenerate::$names	protected	property	An associative array containing test values for elements by name.
WebformSubmissionGenerate::$tokenManager	protected	property	The webform token manager.
WebformSubmissionGenerate::$types	protected	property	An associative array containing test values for elements by type.
WebformSubmissionGenerate::getData	public	function	Generate webform submission data. Overrides WebformSubmissionGenerateInterface::getData
WebformSubmissionGenerate::getTestValue	public	function	Get test value for a webform element. Overrides WebformSubmissionGenerateInterface::getTestValue
WebformSubmissionGenerate::getTestValues	protected	function	Get test values from a webform element.
WebformSubmissionGenerate::__construct	public	function	Constructs a WebformSubmissionGenerate object.

You are here

class WebformSubmissionGenerate in Webform 8.5

Hierarchy

See also

File

Namespace

Members

API Navigation