interface/modules/zend_modules/library/Zend/Mail/Header/Received.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 /**
  15  * @todo       Allow setting date from DateTime, Zend\Date, or string
  16  */
  17 class Received implements HeaderInterface, MultipleHeadersInterface
  18 {
  19     /**
  20      * @var string
  21      */
  22     protected $value;
  23
  24     public static function fromString($headerLine)
  25     {
  26         list($name, $value) = GenericHeader::splitHeaderLine($headerLine);
  27
  28         // check to ensure proper header type for this factory
  29         if (strtolower($name) !== 'received') {
  30             throw new Exception\InvalidArgumentException('Invalid header line for Received string');
  31         }
  32
  33         $header = new static($value);
  34
  35         return $header;
  36     }
  37
  38     public function __construct($value = '')
  39     {
  40         $this->value = $value;
  41     }
  42
  43     public function getFieldName()
  44     {
  45         return 'Received';
  46     }
  47
  48     public function getFieldValue($format = HeaderInterface::FORMAT_RAW)
  49     {
  50         return $this->value;
  51     }
  52
  53     public function setEncoding($encoding)
  54     {
  55         // This header must be always in US-ASCII
  56         return $this;
  57     }
  58
  59     public function getEncoding()
  60     {
  61         return 'ASCII';
  62     }
  63
  64     public function toString()
  65     {
  66         return 'Received: ' . $this->getFieldValue();
  67     }
  68
  69     /**
  70      * Serialize collection of Received headers to string
  71      *
  72      * @param  array $headers
  73      * @throws Exception\RuntimeException
  74      * @return string
  75      */
  76     public function toStringMultipleHeaders(array $headers)
  77     {
  78         $strings = array($this->toString());
  79         foreach ($headers as $header) {
  80             if (!$header instanceof Received) {
  81                 throw new Exception\RuntimeException(
  82                     'The Received multiple header implementation can only accept an array of Received headers'
  83                 );
  84             }
  85             $strings[] = $header->toString();
  86         }
  87         return implode(Headers::EOL, $strings);
  88     }
  89 }