interface/modules/zend_modules/library/Zend/Mail/Header/AbstractAddressList.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\AddressList;
  13 use Zend\Mail\Headers;
  14
  15 /**
  16  * Base class for headers composing address lists (to, from, cc, bcc, reply-to)
  17  */
  18 abstract class AbstractAddressList implements HeaderInterface
  19 {
  20     /**
  21      * @var AddressList
  22      */
  23     protected $addressList;
  24
  25     /**
  26      * @var string Normalized field name
  27      */
  28     protected $fieldName;
  29
  30     /**
  31      * Header encoding
  32      *
  33      * @var string
  34      */
  35     protected $encoding = 'ASCII';
  36
  37     /**
  38      * @var string lower case field name
  39      */
  40     protected static $type;
  41
  42     public static function fromString($headerLine)
  43     {
  44         $decodedLine = iconv_mime_decode($headerLine, ICONV_MIME_DECODE_CONTINUE_ON_ERROR, 'UTF-8');
  45         // split into name/value
  46         list($fieldName, $fieldValue) = GenericHeader::splitHeaderLine($decodedLine);
  47
  48         if (strtolower($fieldName) !== static::$type) {
  49             throw new Exception\InvalidArgumentException(sprintf(
  50                 'Invalid header line for "%s" string',
  51                 __CLASS__
  52             ));
  53         }
  54         $header = new static();
  55         if ($decodedLine != $headerLine) {
  56             $header->setEncoding('UTF-8');
  57         }
  58         // split value on ","
  59         $fieldValue = str_replace(Headers::FOLDING, ' ', $fieldValue);
  60         $values     = explode(',', $fieldValue);
  61         array_walk($values, 'trim');
  62
  63         $addressList = $header->getAddressList();
  64         foreach ($values as $address) {
  65             // split values into name/email
  66             if (!preg_match('/^((?P<name>.*?)<(?P<namedEmail>[^>]+)>|(?P<email>.+))$/', $address, $matches)) {
  67                 // Should we raise an exception here?
  68                 continue;
  69             }
  70             $name = null;
  71             if (isset($matches['name'])) {
  72                 $name  = trim($matches['name']);
  73             }
  74             if (empty($name)) {
  75                 $name = null;
  76             }
  77
  78             if (isset($matches['namedEmail'])) {
  79                 $email = $matches['namedEmail'];
  80             }
  81             if (isset($matches['email'])) {
  82                 $email = $matches['email'];
  83             }
  84             $email = trim($email); // we may have leading whitespace
  85
  86             // populate address list
  87             $addressList->add($email, $name);
  88         }
  89         return $header;
  90     }
  91
  92     public function getFieldName()
  93     {
  94         return $this->fieldName;
  95     }
  96
  97     public function getFieldValue($format = HeaderInterface::FORMAT_RAW)
  98     {
  99         $emails   = array();
 100         $encoding = $this->getEncoding();
 101         foreach ($this->getAddressList() as $address) {
 102             $email = $address->getEmail();
 103             $name  = $address->getName();
 104             if (empty($name)) {
 105                 $emails[] = $email;
 106             } else {
 107                 if (false !== strstr($name, ',')) {
 108                     $name = sprintf('"%s"', $name);
 109                 }
 110
 111                 if ($format == HeaderInterface::FORMAT_ENCODED
 112                     && 'ASCII' !== $encoding
 113                 ) {
 114                     $name = HeaderWrap::mimeEncodeValue($name, $encoding);
 115                 }
 116                 $emails[] = sprintf('%s <%s>', $name, $email);
 117             }
 118         }
 119
 120         return implode(',' . Headers::FOLDING, $emails);
 121     }
 122
 123     public function setEncoding($encoding)
 124     {
 125         $this->encoding = $encoding;
 126         return $this;
 127     }
 128
 129     public function getEncoding()
 130     {
 131         return $this->encoding;
 132     }
 133
 134     /**
 135      * Set address list for this header
 136      *
 137      * @param  AddressList $addressList
 138      */
 139     public function setAddressList(AddressList $addressList)
 140     {
 141         $this->addressList = $addressList;
 142     }
 143
 144     /**
 145      * Get address list managed by this header
 146      *
 147      * @return AddressList
 148      */
 149     public function getAddressList()
 150     {
 151         if (null === $this->addressList) {
 152             $this->setAddressList(new AddressList());
 153         }
 154         return $this->addressList;
 155     }
 156
 157     public function toString()
 158     {
 159         $name  = $this->getFieldName();
 160         $value = $this->getFieldValue(HeaderInterface::FORMAT_ENCODED);
 161         return (empty($value)) ? '' : sprintf('%s: %s', $name, $value);
 162     }
 163 }