interface/modules/zend_modules/library/Zend/Mail/Header/ContentTransferEncoding.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 ContentTransferEncoding implements HeaderInterface
  15 {
  16     /**
  17      * Allowed Content-Transfer-Encoding parameters specified by RFC 1521
  18      * (reduced set)
  19      * @var array
  20      */
  21     protected static $allowedTransferEncodings = array(
  22         '7bit',
  23         '8bit',
  24         'quoted-printable',
  25         'base64',
  26         /*
  27          * not implemented:
  28          * 'binary',
  29          * x-token: 'X-'
  30          */
  31     );
  32
  33
  34     /**
  35      * @var string
  36      */
  37     protected $transferEncoding;
  38
  39     /**
  40      * @var array
  41      */
  42     protected $parameters = array();
  43
  44     public static function fromString($headerLine)
  45     {
  46         $headerLine = iconv_mime_decode($headerLine, ICONV_MIME_DECODE_CONTINUE_ON_ERROR, 'UTF-8');
  47         list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
  48
  49         // check to ensure proper header type for this factory
  50         if (strtolower($name) !== 'content-transfer-encoding') {
  51             throw new Exception\InvalidArgumentException('Invalid header line for Content-Transfer-Encoding string');
  52         }
  53
  54         $header = new static();
  55         $header->setTransferEncoding($value);
  56
  57         return $header;
  58     }
  59
  60     public function getFieldName()
  61     {
  62         return 'Content-Transfer-Encoding';
  63     }
  64
  65     public function getFieldValue($format = HeaderInterface::FORMAT_RAW)
  66     {
  67         return $this->transferEncoding;
  68     }
  69
  70     public function setEncoding($encoding)
  71     {
  72         // Header must be always in US-ASCII
  73         return $this;
  74     }
  75
  76     public function getEncoding()
  77     {
  78         return 'ASCII';
  79     }
  80
  81     public function toString()
  82     {
  83         return 'Content-Transfer-Encoding: ' . $this->getFieldValue();
  84     }
  85
  86     /**
  87      * Set the content transfer encoding
  88      *
  89      * @param  string $transferEncoding
  90      * @throws Exception\InvalidArgumentException
  91      * @return self
  92      */
  93     public function setTransferEncoding($transferEncoding)
  94     {
  95         if (!in_array($transferEncoding, self::$allowedTransferEncodings)) {
  96             throw new Exception\InvalidArgumentException(sprintf(
  97                 '%s expects one of "'. implode(', ', self::$allowedTransferEncodings) . '"; received "%s"',
  98                 __METHOD__,
  99                 (string) $transferEncoding
 100             ));
 101         }
 102         $this->transferEncoding = $transferEncoding;
 103         return $this;
 104     }
 105
 106     /**
 107      * Retrieve the content transfer encoding
 108      *
 109      * @return string
 110      */
 111     public function getTransferEncoding()
 112     {
 113         return $this->transferEncoding;
 114     }
 115 }