interface/modules/zend_modules/library/Zend/Mail/Header/ContentType.php

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