MessageTrait.php in Zircon Profile 8

Namespace

GuzzleHttp\Psr7

File

vendor/guzzlehttp/psr7/src/MessageTrait.php

<?php

namespace GuzzleHttp\Psr7;

use Psr\Http\Message\StreamInterface;

/**
 * Trait implementing functionality common to requests and responses.
 */
trait MessageTrait {

  /** @var array Cached HTTP header collection with lowercase key to values */
  private $headers = [];

  /** @var array Actual key to list of values per header. */
  private $headerLines = [];

  /** @var string */
  private $protocol = '1.1';

  /** @var StreamInterface */
  private $stream;
  public function getProtocolVersion() {
    return $this->protocol;
  }
  public function withProtocolVersion($version) {
    if ($this->protocol === $version) {
      return $this;
    }
    $new = clone $this;
    $new->protocol = $version;
    return $new;
  }
  public function getHeaders() {
    return $this->headerLines;
  }
  public function hasHeader($header) {
    return isset($this->headers[strtolower($header)]);
  }
  public function getHeader($header) {
    $name = strtolower($header);
    return isset($this->headers[$name]) ? $this->headers[$name] : [];
  }
  public function getHeaderLine($header) {
    return implode(', ', $this
      ->getHeader($header));
  }
  public function withHeader($header, $value) {
    $new = clone $this;
    $header = trim($header);
    $name = strtolower($header);
    if (!is_array($value)) {
      $new->headers[$name] = [
        trim($value),
      ];
    }
    else {
      $new->headers[$name] = $value;
      foreach ($new->headers[$name] as &$v) {
        $v = trim($v);
      }
    }

    // Remove the header lines.
    foreach (array_keys($new->headerLines) as $key) {
      if (strtolower($key) === $name) {
        unset($new->headerLines[$key]);
      }
    }

    // Add the header line.
    $new->headerLines[$header] = $new->headers[$name];
    return $new;
  }
  public function withAddedHeader($header, $value) {
    if (!$this
      ->hasHeader($header)) {
      return $this
        ->withHeader($header, $value);
    }
    $new = clone $this;
    $new->headers[strtolower($header)][] = $value;
    $new->headerLines[$header][] = $value;
    return $new;
  }
  public function withoutHeader($header) {
    if (!$this
      ->hasHeader($header)) {
      return $this;
    }
    $new = clone $this;
    $name = strtolower($header);
    unset($new->headers[$name]);
    foreach (array_keys($new->headerLines) as $key) {
      if (strtolower($key) === $name) {
        unset($new->headerLines[$key]);
      }
    }
    return $new;
  }
  public function getBody() {
    if (!$this->stream) {
      $this->stream = stream_for('');
    }
    return $this->stream;
  }
  public function withBody(StreamInterface $body) {
    if ($body === $this->stream) {
      return $this;
    }
    $new = clone $this;
    $new->stream = $body;
    return $new;
  }
  private function setHeaders(array $headers) {
    $this->headerLines = $this->headers = [];
    foreach ($headers as $header => $value) {
      $header = trim($header);
      $name = strtolower($header);
      if (!is_array($value)) {
        $value = trim($value);
        $this->headers[$name][] = $value;
        $this->headerLines[$header][] = $value;
      }
      else {
        foreach ($value as $v) {
          $v = trim($v);
          $this->headers[$name][] = $v;
          $this->headerLines[$header][] = $v;
        }
      }
    }
  }

}

Traits

Name	Description
MessageTrait	Trait implementing functionality common to requests and responses.