zbateson / mail-mime-parser

src/Header/Consumer/ParameterConsumerService.php

<?php
/**
 * This file is part of the ZBateson\MailMimeParser project.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD
 */

namespace ZBateson\MailMimeParser\Header\Consumer;

use Iterator;
use Psr\Log\LoggerInterface;
use ZBateson\MailMimeParser\Header\IHeaderPart;
use ZBateson\MailMimeParser\Header\Part\HeaderPartFactory;
use ZBateson\MailMimeParser\Header\Part\ParameterPart;

/**
 * Reads headers separated into parameters consisting of an optional main value,
 * and subsequent name/value pairs - for example text/html; charset=utf-8.
 *
 * A ParameterConsumerService's parts are separated by a semi-colon.  Its
 * name/value pairs are separated with an '=' character.
 *
 * Parts may be mime-encoded entities, or RFC-2231 split/encoded parts.
 * Additionally, a value can be quoted and comments may exist.
 *
 * Actual processing of parameters is done in ParameterNameValueConsumerService,
 * with ParameterConsumerService processing all collected parts into split
 * parameter parts as necessary.
 *
 * @author Zaahid Bateson
 */
class ParameterConsumerService extends AbstractGenericConsumerService
{
    use QuotedStringMimeLiteralPartTokenSplitPatternTrait;

    public function __construct(
        LoggerInterface $logger,
        HeaderPartFactory $partFactory,
        ParameterNameValueConsumerService $parameterNameValueConsumerService,
        CommentConsumerService $commentConsumerService,
        QuotedStringConsumerService $quotedStringConsumerService
    ) {
        parent::__construct(
            $logger,
            $partFactory,
            [$parameterNameValueConsumerService, $commentConsumerService, $quotedStringConsumerService]
        );
    }

    /**
     * Disables advancing for start tokens.
     */
    protected function advanceToNextToken(Iterator $tokens, bool $isStartToken) : static
    {
        if ($isStartToken) {
            return $this;
        }
        parent::advanceToNextToken($tokens, $isStartToken);
        return $this;
    }

    /**
     * Post processing involves looking for split parameter parts with matching
     * names and combining them into a SplitParameterPart, and otherwise
     * returning ParameterParts from ParameterNameValueConsumer as-is.
     *
     * @param IHeaderPart[] $parts The parsed parts.
     * @return IHeaderPart[] Array of resulting final parts.
     */
    protected function processParts(array $parts) : array
    {
        $factory = $this->partFactory;
        return \array_values(\array_map(
            function($partsArray) use ($factory) {

Expected 1 space after FUNCTION keyword; 0 found

                if (\count($partsArray) > 1) {
                    return $factory->newSplitParameterPart($partsArray);
                }
                return $partsArray[0];
            },
            \array_merge_recursive(...\array_map(
                function($p) {

Expected 1 space after FUNCTION keyword; 0 found

                    // if $p->getIndex is non-null, it's a split-parameter part
                    // and an array of one element consisting of name => ParameterPart
                    // is returned, which is then merged into name => array-of-parameter-parts
                    // or ';' object_id . ';' for non-split parts with a value of a single
                    // element array of [ParameterPart]
                    if ($p instanceof ParameterPart && $p->getIndex() !== null) {
                        return [\strtolower($p->getName()) => [$p]];
                    }
                    return [';' . \spl_object_id($p) . ';' => [$p]];
                },
                $parts
            ))
        ));
    }
}