class WebformYaml in Webform 8.5

Provides YAML tidy function.

Hierarchy

• class \Drupal\webform\Utility\WebformYaml implements SerializationInterface

28 files declare their use of WebformYaml

DebugWebformHandler.php in src/Plugin/WebformHandler/DebugWebformHandler.php

OverrideWebformVariant.php in src/Plugin/WebformVariant/OverrideWebformVariant.php

webform.install.update.inc in includes/webform.install.update.inc

Archived Webform update hooks.

Webform.php in src/Entity/Webform.php

webform.translation.inc in includes/webform.translation.inc

Webform module translation hooks.

... See full list

File

src/Utility/WebformYaml.php, line 13

Namespace

Drupal\webform\Utility

class WebformYaml implements SerializationInterface {

  /**
   * {@inheritdoc}
   */
  public static function encode($data) {

    // Convert \r\n to \n so that multiline strings are properly formatted.
    // @see \Symfony\Component\Yaml\Dumper::dump
    if (is_array($data)) {
      static::normalize($data);
    }

    // If empty array then return an empty string instead of '{ }'.
    if (is_array($data) && empty($data)) {
      return '';
    }
    $dumper = new Dumper(2);
    $yaml = $dumper
      ->dump($data, PHP_INT_MAX, 0, SymfonyYaml::DUMP_EXCEPTION_ON_INVALID_TYPE | SymfonyYaml::DUMP_MULTI_LINE_LITERAL_BLOCK);

    // Remove return after array delimiter.
    $yaml = preg_replace('#((?:\\n|^)[ ]*-)\\n[ ]+(\\w|[\'"])#', '\\1 \\2', $yaml);
    return trim($yaml);
  }

  /**
   * {@inheritdoc}
   */
  public static function decode($raw) {
    return $raw ? Yaml::decode($raw) : [];
  }

  /**
   * {@inheritdoc}
   */
  public static function getFileExtension() {
    return 'yml';
  }

  /**
   * Determine if string is valid YAML.
   *
   * @param string $yaml
   *   A YAML string.
   *
   * @return bool
   *   TRUE if string is valid YAML.
   */
  public static function isValid($yaml) {
    return self::validate($yaml) ? FALSE : TRUE;
  }

  /**
   * Validate YAML string.
   *
   * @param string $yaml
   *   A YAML string.
   *
   * @return null|string
   *   NULL if the YAML string contains no errors, else the parsing exception
   *   message is returned.
   */
  public static function validate($yaml) {
    try {
      Yaml::decode($yaml);
      return NULL;
    } catch (\Exception $exception) {
      return $exception
        ->getMessage();
    }
  }

  /**
   * Tidy export YAML includes tweaking array layout and multiline strings.
   *
   * @param string $yaml
   *   The output generated from \Drupal\Core\Serialization\Yaml::encode.
   *
   * @return string
   *   The encoded data.
   */
  public static function tidy($yaml) {
    return self::encode(self::decode($yaml));
  }

  /****************************************************************************/

  // Helper methods.

  /****************************************************************************/

  /**
   * Convert \r\n to \n inside data.
   *
   * @param array $data
   *   Data with all converted \r\n to \n.
   */
  protected static function normalize(array &$data) {
    foreach ($data as $key => &$value) {
      if (is_string($value)) {
        $data[$key] = preg_replace('/\\r\\n?/', "\n", $value);
      }
      elseif (is_array($value)) {
        static::normalize($value);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
WebformYaml::decode	public static	function	Decodes data from the serialization format. Overrides SerializationInterface::decode
WebformYaml::encode	public static	function	Encodes data into the serialization format. Overrides SerializationInterface::encode
WebformYaml::getFileExtension	public static	function	Gets the file extension for this serialization format. Overrides SerializationInterface::getFileExtension
WebformYaml::isValid	public static	function	Determine if string is valid YAML.
WebformYaml::normalize	protected static	function	Convert \r\n to \n inside data.
WebformYaml::tidy	public static	function	Tidy export YAML includes tweaking array layout and multiline strings.
WebformYaml::validate	public static	function	Validate YAML string.