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

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-mail for the canonical source repository
   4  * @copyright Copyright (c) 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 function in_array;
  11
  12 /**
  13  * @internal
  14  */
  15 class ListParser
  16 {
  17     const CHAR_QUOTES = ['\'', '"'];
  18     const CHAR_DELIMS = [',', ';'];
  19     const CHAR_ESCAPE = '\\';
  20
  21     /**
  22      * @param string $value
  23      * @param array $delims Delimiters allowed between values; parser will
  24      *     split on these, as long as they are not within quotes. Defaults
  25      *     to ListParser::CHAR_DELIMS.
  26      * @return array
  27      */
  28     public static function parse($value, array $delims = self::CHAR_DELIMS)
  29     {
  30         $values            = [];
  31         $length            = strlen($value);
  32         $currentValue      = '';
  33         $inEscape          = false;
  34         $inQuote           = false;
  35         $currentQuoteDelim = null;
  36
  37         for ($i = 0; $i < $length; $i += 1) {
  38             $char = $value[$i];
  39
  40             // If we are in an escape sequence, append the character and continue.
  41             if ($inEscape) {
  42                 $currentValue .= $char;
  43                 $inEscape = false;
  44                 continue;
  45             }
  46
  47             // If we are not in a quoted string, and have a delimiter, append
  48             // the current value to the list, and reset the current value.
  49             if (in_array($char, $delims, true) && ! $inQuote) {
  50                 $values [] = $currentValue;
  51                 $currentValue = '';
  52                 continue;
  53             }
  54
  55             // Append the character to the current value
  56             $currentValue .= $char;
  57
  58             // Escape sequence discovered.
  59             if (self::CHAR_ESCAPE === $char) {
  60                 $inEscape = true;
  61                 continue;
  62             }
  63
  64             // If the character is not a quote character, we are done
  65             // processing it.
  66             if (! in_array($char, self::CHAR_QUOTES)) {
  67                 continue;
  68             }
  69
  70             // If the character matches a previously matched quote delimiter,
  71             // we reset our quote status and the currently opened quote
  72             // delimiter.
  73             if ($char === $currentQuoteDelim) {
  74                 $inQuote = false;
  75                 $currentQuoteDelim = null;
  76                 continue;
  77             }
  78
  79             // Otherwise, we're starting a quoted string.
  80             $inQuote = true;
  81             $currentQuoteDelim = $char;
  82         }
  83
  84         // If we reached the end of the string and still have a current value,
  85         // append it to the list (no delimiter was reached).
  86         if ('' !== $currentValue) {
  87             $values [] = $currentValue;
  88         }
  89
  90         return $values;
  91     }
  92 }