Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Component\Serialization;
Chris@0: 
Chris@0: use Drupal\Component\Serialization\Exception\InvalidDataTypeException;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides default serialization for YAML using the PECL extension.
Chris@0:  */
Chris@0: class YamlPecl implements SerializationInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function encode($data) {
Chris@0:     static $init;
Chris@0:     if (!isset($init)) {
Chris@0:       ini_set('yaml.output_indent', 2);
Chris@0:       // Do not break lines at 80 characters.
Chris@0:       ini_set('yaml.output_width', -1);
Chris@0:       $init = TRUE;
Chris@0:     }
Chris@0:     return yaml_emit($data, YAML_UTF8_ENCODING, YAML_LN_BREAK);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function decode($raw) {
Chris@0:     static $init;
Chris@0:     if (!isset($init)) {
Chris@0:       // Decode binary, since Symfony YAML parser encodes binary from 3.1
Chris@0:       // onwards.
Chris@0:       ini_set('yaml.decode_binary', 1);
Chris@0:       // We never want to unserialize !php/object.
Chris@0:       ini_set('yaml.decode_php', 0);
Chris@0:       $init = TRUE;
Chris@0:     }
Chris@0:     // yaml_parse() will error with an empty value.
Chris@0:     if (!trim($raw)) {
Chris@0:       return NULL;
Chris@0:     }
Chris@0:     // @todo Use ErrorExceptions when https://drupal.org/node/1247666 is in.
Chris@0:     // yaml_parse() will throw errors instead of raising an exception. Until
Chris@0:     // such time as Drupal supports native PHP ErrorExceptions as the error
Chris@0:     // handler, we need to temporarily set the error handler as ::errorHandler()
Chris@0:     // and then restore it after decoding has occurred. This allows us to turn
Chris@0:     // parsing errors into a throwable exception.
Chris@0:     // @see Drupal\Component\Serialization\Exception\InvalidDataTypeException
Chris@14:     // @see http://php.net/manual/class.errorexception.php
Chris@0:     set_error_handler([__CLASS__, 'errorHandler']);
Chris@0:     $ndocs = 0;
Chris@0:     $data = yaml_parse($raw, 0, $ndocs, [
Chris@0:       YAML_BOOL_TAG => '\Drupal\Component\Serialization\YamlPecl::applyBooleanCallbacks',
Chris@0:     ]);
Chris@0:     restore_error_handler();
Chris@0:     return $data;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Handles errors for \Drupal\Component\Serialization\YamlPecl::decode().
Chris@0:    *
Chris@0:    * @param int $severity
Chris@0:    *   The severity level of the error.
Chris@0:    * @param string $message
Chris@0:    *   The error message to display.
Chris@0:    *
Chris@0:    * @see \Drupal\Component\Serialization\YamlPecl::decode()
Chris@0:    */
Chris@0:   public static function errorHandler($severity, $message) {
Chris@0:     restore_error_handler();
Chris@0:     throw new InvalidDataTypeException($message, $severity);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function getFileExtension() {
Chris@0:     return 'yml';
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Applies callbacks after parsing to ignore 1.1 style booleans.
Chris@0:    *
Chris@0:    * @param mixed $value
Chris@0:    *   Value from YAML file.
Chris@0:    * @param string $tag
Chris@0:    *   Tag that triggered the callback.
Chris@0:    * @param int $flags
Chris@0:    *   Scalar entity style flags.
Chris@0:    *
Chris@0:    * @return string|bool
Chris@0:    *   FALSE, false, TRUE and true are returned as booleans, everything else is
Chris@0:    *   returned as a string.
Chris@0:    */
Chris@0:   public static function applyBooleanCallbacks($value, $tag, $flags) {
Chris@0:     // YAML 1.1 spec dictates that 'Y', 'N', 'y' and 'n' are booleans. But, we
Chris@0:     // want the 1.2 behavior, so we only consider 'false', 'FALSE', 'true' and
Chris@0:     // 'TRUE' as booleans.
Chris@0:     if (!in_array(strtolower($value), ['false', 'true'], TRUE)) {
Chris@0:       return $value;
Chris@0:     }
Chris@0:     $map = [
Chris@0:       'false' => FALSE,
Chris@0:       'true' => TRUE,
Chris@0:     ];
Chris@0:     return $map[strtolower($value)];
Chris@0:   }
Chris@0: 
Chris@0: }