class StreamEncoder in Replication 8

Hierarchy

• class \Drupal\replication\Encoder\StreamEncoder implements \Symfony\Component\Serializer\Encoder\EncoderInterface, \Symfony\Component\Serializer\Encoder\DecoderInterface

1 file declares its use of StreamEncoder

StreamEncoderTest.php in tests/src/Kernel/Encoder/StreamEncoderTest.php

1 string reference to 'StreamEncoder'

replication.services.yml in ./replication.services.yml

replication.services.yml

2 services use StreamEncoder

replication.encoder.base64_stream in ./replication.services.yml

Drupal\replication\Encoder\StreamEncoder

replication.encoder.stream in ./replication.services.yml

Drupal\replication\Encoder\StreamEncoder

File

src/Encoder/StreamEncoder.php, line 9

Namespace

Drupal\replication\Encoder

class StreamEncoder implements EncoderInterface, DecoderInterface {

  /**
   * @var array
   */
  protected $formats = [
    'stream',
    'base64_stream',
  ];

  /**
   * @param \Drupal\Component\Utility\Random $random
   */
  protected $random;
  public function __construct(Random $random = NULL) {
    $this->random = $random ?: new Random();
  }

  /**
   * {@inheritdoc}
   */
  public function encode($data, $format, array $context = []) {
    if (!is_resource($data)) {
      throw new \InvalidArgumentException(sprintf('Data argument is not a resource.'));
    }
    $contents = stream_get_contents($data);
    return $format == 'base64_stream' ? base64_encode($contents) : $contents;
  }

  /**
   * {@inheritdoc}
   */
  public function decode($data, $format, array $context = []) {
    if (!is_scalar($data)) {
      throw new \InvalidArgumentException(sprintf('Data argument is not a scalar.'));
    }
    $uri = !empty($context['uri']) ? $context['uri'] : 'temporary://' . $this->random
      ->name();
    $mode = !empty($context['mode']) ? $context['mode'] : 'w+b';
    $stream = fopen($uri, $mode);
    $data = $format == 'base64_stream' ? base64_decode($data) : $data;
    fwrite($stream, $data);

    // Put the file pointer back to the beginning.
    rewind($stream);
    return $stream;
  }

  /**
   * {@inheritdoc}
   */
  public function supportsEncoding($format) {
    return in_array($format, $this->formats);
  }

  /**
   * {@inheritdoc}
   */
  public function supportsDecoding($format) {
    return in_array($format, $this->formats);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
StreamEncoder::$formats	protected	property
StreamEncoder::$random	protected	property
StreamEncoder::decode	public	function	Decodes a string into PHP data.
StreamEncoder::encode	public	function	Encodes data into the given format.
StreamEncoder::supportsDecoding	public	function	Checks whether the deserializer can decode from given format.
StreamEncoder::supportsEncoding	public	function	Checks whether the serializer can encode to given format.
StreamEncoder::__construct	public	function