vendor/zendframework/zend-mail/src/Header/ContentType.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-mail for the canonical source repository
   4  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-mail/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Mail\Header;
   9
  10 use Zend\Mail\Headers;
  11 use Zend\Mime\Mime;
  12
  13 class ContentType implements UnstructuredInterface
  14 {
  15     /**
  16      * @var string
  17      */
  18     protected $type;
  19
  20     /**
  21      * Header encoding
  22      *
  23      * @var string
  24      */
  25     protected $encoding = 'ASCII';
  26
  27     /**
  28      * @var array
  29      */
  30     protected $parameters = [];
  31
  32     public static function fromString($headerLine)
  33     {
  34         list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
  35         $value = HeaderWrap::mimeDecodeValue($value);
  36
  37         // check to ensure proper header type for this factory
  38         if (strtolower($name) !== 'content-type') {
  39             throw new Exception\InvalidArgumentException('Invalid header line for Content-Type string');
  40         }
  41
  42         $value  = str_replace(Headers::FOLDING, ' ', $value);
  43         $parts = explode(';', $value, 2);
  44
  45         $header = new static();
  46         $header->setType($parts[0]);
  47
  48         if (isset($parts[1])) {
  49             $values = ListParser::parse(trim($parts[1]), [';', '=']);
  50             $length = count($values);
  51
  52             for ($i = 0; $i < $length; $i += 2) {
  53                 $value = $values[$i + 1];
  54                 $value = trim($value, "'\" \t\n\r\0\x0B");
  55                 $header->addParameter($values[$i], $value);
  56             }
  57         }
  58
  59         return $header;
  60     }
  61
  62     public function getFieldName()
  63     {
  64         return 'Content-Type';
  65     }
  66
  67     public function getFieldValue($format = HeaderInterface::FORMAT_RAW)
  68     {
  69         $prepared = $this->type;
  70         if (empty($this->parameters)) {
  71             return $prepared;
  72         }
  73
  74         $values = [$prepared];
  75         foreach ($this->parameters as $attribute => $value) {
  76             if (HeaderInterface::FORMAT_ENCODED === $format && ! Mime::isPrintable($value)) {
  77                 $this->encoding = 'UTF-8';
  78                 $value = HeaderWrap::wrap($value, $this);
  79                 $this->encoding = 'ASCII';
  80             }
  81
  82             $values[] = sprintf('%s="%s"', $attribute, $value);
  83         }
  84
  85         return implode(';' . Headers::FOLDING, $values);
  86     }
  87
  88     public function setEncoding($encoding)
  89     {
  90         $this->encoding = $encoding;
  91         return $this;
  92     }
  93
  94     public function getEncoding()
  95     {
  96         return $this->encoding;
  97     }
  98
  99     public function toString()
 100     {
 101         return 'Content-Type: ' . $this->getFieldValue(HeaderInterface::FORMAT_ENCODED);
 102     }
 103
 104     /**
 105      * Set the content type
 106      *
 107      * @param  string $type
 108      * @throws Exception\InvalidArgumentException
 109      * @return ContentType
 110      */
 111     public function setType($type)
 112     {
 113         if (! preg_match('/^[a-z-]+\/[a-z0-9.+-]+$/i', $type)) {
 114             throw new Exception\InvalidArgumentException(sprintf(
 115                 '%s expects a value in the format "type/subtype"; received "%s"',
 116                 __METHOD__,
 117                 (string) $type
 118             ));
 119         }
 120         $this->type = $type;
 121         return $this;
 122     }
 123
 124     /**
 125      * Retrieve the content type
 126      *
 127      * @return string
 128      */
 129     public function getType()
 130     {
 131         return $this->type;
 132     }
 133
 134     /**
 135      * Add a parameter pair
 136      *
 137      * @param  string $name
 138      * @param  string $value
 139      * @return ContentType
 140      * @throws Exception\InvalidArgumentException for parameter names that do not follow RFC 2822
 141      * @throws Exception\InvalidArgumentException for parameter values that do not follow RFC 2822
 142      */
 143     public function addParameter($name, $value)
 144     {
 145         $name  = strtolower($name);
 146         $value = (string) $value;
 147
 148         if (! HeaderValue::isValid($name)) {
 149             throw new Exception\InvalidArgumentException('Invalid content-type parameter name detected');
 150         }
 151         if (! HeaderWrap::canBeEncoded($value)) {
 152             throw new Exception\InvalidArgumentException(
 153                 'Parameter value must be composed of printable US-ASCII or UTF-8 characters.'
 154             );
 155         }
 156
 157         $this->parameters[$name] = $value;
 158         return $this;
 159     }
 160
 161     /**
 162      * Get all parameters
 163      *
 164      * @return array
 165      */
 166     public function getParameters()
 167     {
 168         return $this->parameters;
 169     }
 170
 171     /**
 172      * Get a parameter by name
 173      *
 174      * @param  string $name
 175      * @return null|string
 176      */
 177     public function getParameter($name)
 178     {
 179         $name = strtolower($name);
 180         if (isset($this->parameters[$name])) {
 181             return $this->parameters[$name];
 182         }
 183         return;
 184     }
 185
 186     /**
 187      * Remove a named parameter
 188      *
 189      * @param  string $name
 190      * @return bool
 191      */
 192     public function removeParameter($name)
 193     {
 194         $name = strtolower($name);
 195         if (isset($this->parameters[$name])) {
 196             unset($this->parameters[$name]);
 197             return true;
 198         }
 199         return false;
 200     }
 201 }