Swift_Mime_SimpleHeaderFactory

Complexity

Total Complexity

19

Size/Duplication

Total Lines	208
Duplicated Lines	9.62 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

100%

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	createMailboxHeader()	0	10	2
A	createDateHeader()	0	10	2
A	createTextHeader()	0	10	2
B	createParameterizedHeader()	0	22	4
A	createIdHeader()	10	12	2
A	createPathHeader()	10	10	2
A	charsetChanged()	0	6	1
A	__clone()	0	5	1
A	_setHeaderCharset()	0	6	2

<?php

/*
 * This file is part of SwiftMailer.
 * (c) 2004-2009 Chris Corbyn
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * Creates MIME headers.
 *
 * @author Chris Corbyn
 */
class Swift_Mime_SimpleHeaderFactory implements Swift_Mime_HeaderFactory

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * The HeaderEncoder used by these headers
     *
     * @var Swift_Mime_HeaderEncoder
     */
    private $_encoder;

    /**
     * The Encoder used by parameters
     *
     * @var Swift_Encoder
     */
    private $_paramEncoder;

    /**
     * The Email Validator
     *
     * @var Swift_EmailValidatorBridge
     */
    private $_emailValidator;

    /**
     * The charset of created Headers
     *
     * @var null|string
     */
    private $_charset;

    /**
     * Creates a new SimpleHeaderFactory using $encoder and $paramEncoder.
     *
     * @param Swift_Mime_HeaderEncoder   $encoder
     * @param Swift_Encoder              $paramEncoder
     * @param Swift_EmailValidatorBridge $emailValidator
     * @param string|null                $charset
     */
    public function __construct(Swift_Mime_HeaderEncoder $encoder, Swift_Encoder $paramEncoder, Swift_EmailValidatorBridge $emailValidator, $charset = null)
    {
        $this->_encoder = $encoder;
        $this->_paramEncoder = $paramEncoder;
        $this->_emailValidator = $emailValidator;
        $this->_charset = $charset;
    }

    /**
     * Create a new Mailbox Header with a list of $addresses.
     *
     * @param string            $name
     * @param array|string|null $addresses
     *
     * @return Swift_Mime_Header
     */
    public function createMailboxHeader($name, $addresses = null)
    {
        $header = new Swift_Mime_Headers_MailboxHeader($name, $this->_encoder, $this->_emailValidator);
        if (isset($addresses)) {
            $header->setFieldBodyModel($addresses);
        }
        $this->_setHeaderCharset($header);

        return $header;
    }

    /**
     * Create a new Date header using $timestamp (UNIX time).
     *
     * @param string   $name
     * @param int|null $timestamp
     *
     * @return Swift_Mime_Header
     */
    public function createDateHeader($name, $timestamp = null)
    {
        $header = new Swift_Mime_Headers_DateHeader($name);
        if (isset($timestamp)) {
            $header->setFieldBodyModel($timestamp);
        }
        $this->_setHeaderCharset($header);

        return $header;
    }

    /**
     * Create a new basic text header with $name and $value.
     *
     * @param string $name
     * @param string $value
     *
     * @return Swift_Mime_Header
     */
    public function createTextHeader($name, $value = null)
    {
        $header = new Swift_Mime_Headers_UnstructuredHeader($name, $this->_encoder);
        if (isset($value)) {
            $header->setFieldBodyModel($value);
        }
        $this->_setHeaderCharset($header);

        return $header;
    }

    /**
     * Create a new ParameterizedHeader with $name, $value and $params.
     *
     * @param string $name
     * @param string $value
     * @param array  $params
     *
     * @return Swift_Mime_ParameterizedHeader
     */
    public function createParameterizedHeader($name, $value = null, $params = array())
    {
        if (strtolower($name) == 'content-disposition') {
            $parameterEncoding = $this->_paramEncoder;
        } else {
            $parameterEncoding = null;
        }

        $header = new Swift_Mime_Headers_ParameterizedHeader($name, $this->_encoder, $parameterEncoding);

        if (isset($value)) {
            $header->setFieldBodyModel($value);
        }

        foreach ($params as $k => $v) {
            $header->setParameter($k, $v);
        }

        $this->_setHeaderCharset($header);

        return $header;
    }

    /**
     * Create a new ID header for Message-ID or Content-ID.
     *
     * @param string       $name
     * @param string|array $ids
     *
     * @return Swift_Mime_Header
     */
    public function createIdHeader($name, $ids = null)

This method seems to be duplicated in your project.

    {
        $header = new Swift_Mime_Headers_IdentificationHeader($name, $this->_emailValidator);

        if (isset($ids)) {
            $header->setFieldBodyModel($ids);
        }

        $this->_setHeaderCharset($header);

        return $header;
    }

    /**
     * Create a new Path header with an address (path) in it.
     *
     * @param string $name
     * @param string $path
     *
     * @return Swift_Mime_Header
     */
    public function createPathHeader($name, $path = null)

This method seems to be duplicated in your project.

    {
        $header = new Swift_Mime_Headers_PathHeader($name, $this->_emailValidator);
        if (isset($path)) {
            $header->setFieldBodyModel($path);
        }
        $this->_setHeaderCharset($header);

        return $header;
    }

    /**
     * Notify this observer that the entity's charset has changed.
     *
     * @param string $charset
     */
    public function charsetChanged($charset)
    {
        $this->_charset = $charset;
        $this->_encoder->charsetChanged($charset);
        $this->_paramEncoder->charsetChanged($charset);
    }

    /**
     * Make a deep copy of object.
     */
    public function __clone()
    {
        $this->_encoder = clone $this->_encoder;
        $this->_paramEncoder = clone $this->_paramEncoder;
    }

    /**
     * Apply the charset to the Header
     *
     * @param Swift_Mime_Header $header
     */
    private function _setHeaderCharset(Swift_Mime_Header $header)
    {
        if (isset($this->_charset)) {
            $header->setCharset($this->_charset);
        }
    }
}