Swift_Mime_Headers_AbstractHeader::createPhrase() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/5.x' into 5.x" - voku/swiftmailer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 5.x ( 075674...25eba8 )

by Lars

created 2016-09-18 23:20 UTC

Swift_Mime_Headers_AbstractHeader::createPhrase() B

↳ Parent: Swift_Mime_Headers_AbstractHeader

Complexity

Conditions	4
Paths	4

Size

Total Lines	25
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	4.0058

Importance

Changes

Metric	Value
cc	4
eloc	13
nc	4
nop	5
dl	0
loc	25
ccs	13
cts	14
cp	0.9286
crap	4.0058
rs	8.5806
c	0
b	0
f	0

<?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.
 */

/**
 * An abstract base MIME Header.
 *
 * @author Chris Corbyn
 */
abstract class Swift_Mime_Headers_AbstractHeader implements Swift_Mime_Header
namespace YourVendor;

class YourClass { }
{
    const PHRASE_PATTERN = '(?:(?:(?:(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?[a-zA-Z0-9!#\$%&\'\*\+\-\/=\?\^_`\{\}\|~]+(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?)|(?:(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?"((?:(?:[ \t]*(?:\r\n))?[ \t])?(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21\x23-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])))*(?:(?:[ \t]*(?:\r\n))?[ \t])?"(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?(\((?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?\)))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?))+?)';

    /**
     * The name of this Header.
     *
     * @var string
     */
    private $_name;

    /**
     * The Encoder used to encode this Header.
     *
     * @var Swift_Mime_HeaderEncoder
     */
    private $_encoder;

    /**
     * The maximum length of a line in the header.
     *
     * @var int
     */
    private $_lineLength = 78;

    /**
     * The language used in this Header.
     *
     * @var string|null
     */
    private $_lang;

    /**
     * The character set of the text in this Header.
     *
     * @var string
     */
    private $_charset = 'utf-8';

    /**
     * The value of this Header, cached.
     *
     * @var string|null
     */
    private $_cachedValue;

    /**
     * Creates a new Header.
     */
    public function __construct()
    {
    }

    /**
     * Set the character set used in this Header.
     *
     * @param string $charset
     */
    public function setCharset($charset)
    {
        if ($charset && $charset !== $this->_charset) {
            $this->clearCachedValue();

            $this->_charset = $charset;

            if ($this->_encoder) {
                $this->_encoder->charsetChanged($charset);
            }
        }
    }

    /**
     * Get the character set used in this Header.
     *
     * @return string
     */
    public function getCharset()
    {
        return $this->_charset;
    }

    /**
     * Set the language used in this Header.
     *
     * For example, for US English, 'en-us'.
     * This can be unspecified.
     *
     * @param string $lang
     */
    public function setLanguage($lang)
    {
        if ($lang && $this->_lang !== $lang) {
            $this->clearCachedValue();
            $this->_lang = (string)$lang;
        }
    }

    /**
     * Get the language used in this Header.
     *
     * @return string
     */
    public function getLanguage()
    {
        return $this->_lang;
    }

    /**
     * Set the encoder used for encoding the header.
     *
     * @param Swift_Mime_HeaderEncoder $encoder
     */
    public function setEncoder(Swift_Mime_HeaderEncoder $encoder)
    {
        $this->_encoder = $encoder;
        $this->_encoder->charsetChanged($this->_charset);

        $this->setCachedValue(null);
    }

    /**
     * Get the encoder used for encoding this Header.
     *
     * @return Swift_Mime_HeaderEncoder
     */
    public function getEncoder()
    {
        return $this->_encoder;
    }

    /**
     * Get the name of this header (e.g. charset).
     *
     * @return string
     */
    public function getFieldName()
    {
        return $this->_name;
    }

    /**
     * Set the maximum length of lines in the header (excluding EOL).
     *
     * @param int $lineLength
     *
     * @return bool
     */
    public function setMaxLineLength($lineLength)
    {
        if ($lineLength && $this->_lineLength !== $lineLength) {
            $this->clearCachedValue();

            $this->_lineLength = (int)$lineLength;

            return true;
        }

        return false;
    }

    /**
     * Get the maximum permitted length of lines in this Header.
     *
     * @return int
     */
    public function getMaxLineLength()
    {
        return $this->_lineLength;
    }

    /**
     * Get this Header rendered as a RFC 2822 compliant string.
     *
     * @return string
     */
    public function toString()
    {
        return $this->_tokensToString($this->toTokens());
    }

    /**
     * Returns a string representation of this object.
     *
     * @return string
     *
     * @see toString()
     */
    public function __toString()
    {
        return $this->toString();
    }

    /**
     * Set the name of this Header field.
     *
     * @param string $name
     */
    protected function setFieldName($name)
    {
        $this->_name = $name;
    }

    /**
     * Produces a compliant, formatted RFC 2822 'phrase' based on the string given.
     *
     * @param Swift_Mime_Header        $header
     * @param string                   $string  as displayed
     * @param string                   $charset of the text
     * @param Swift_Mime_HeaderEncoder $encoder
     * @param bool                     $shorten the first line to make remove for header name
     *
     * @return string
     */
    protected function createPhrase(Swift_Mime_Header $header, $string, $charset, Swift_Mime_HeaderEncoder $encoder = null, $shorten = false)

    {
        // Treat token as exactly what was given
        $phraseStr = $string;
        // If it's not valid
        if (!preg_match('/^' . self::PHRASE_PATTERN . '$/D', $phraseStr)) {
            // .. but it is just ascii text, try escaping some characters
            // and make it a quoted-string
            if (preg_match('/^[\x00-\x08\x0B\x0C\x0E-\x7F]*$/D', $phraseStr)) {
                $phraseStr = $this->escapeSpecials($phraseStr, array('"'));
                $phraseStr = '"' . $phraseStr . '"';
            } else {
                // ... otherwise it needs encoding
                // Determine space remaining on line if first line
                if ($shorten) {
                    $usedLength = strlen($header->getFieldName() . ': ');
                } else {
                    $usedLength = 0;
                }
                $phraseStr = $this->encodeWords($header, $string, $usedLength);
            }
        }

        return $phraseStr;
    }

    /**
     * Escape special characters in a string (convert to quoted-pairs).
     *
     * @param string   $token
     * @param string[] $include additional chars to escape
     *
     * @return string
     */
    protected function escapeSpecials($token, array $include = array())
    {
        foreach (array_merge(array('\\'), $include) as $char) {
            $token = str_replace($char, '\\' . $char, $token);
        }

        return $token;
    }

    /**
     * Encode needed word tokens within a string of input.
     *
     * @param Swift_Mime_Header|Swift_Mime_Headers_AbstractHeader $header
     * @param string            $input
     * @param int               $usedLength optional
     *
     * @return string
     */
    protected function encodeWords(Swift_Mime_Header $header, $input, $usedLength = -1)
    {
        $value = '';
        $tokens = $this->getEncodableWordTokens($input);
        foreach ($tokens as $token) {
            // See RFC 2822, Sect 2.2 (really 2.2 ??)

            if ($this->tokenNeedsEncoding($token)) {
                // Don't encode starting WSP
                $firstChar = substr($token, 0, 1);
                switch ($firstChar) {
                    case ' ':
                    case "\t":
                        $value .= $firstChar;
                        $token = substr($token, 1);
                }
                if (-1 == $usedLength) {
                    $usedLength = strlen($header->getFieldName().': ') + strlen($value);
                }
                $value .= $this->getTokenAsEncodedWord($token, $usedLength);
                $header->setMaxLineLength(76); // Forcefully override
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            } else {
                $value .= $token;
            }
        }
        return $value;
    }

    /**
     * Test if a token needs to be encoded or not.
     *
     * @param string $token
     *
     * @return integer
     */
    protected function tokenNeedsEncoding($token)
    {
        if (preg_match('~[\x00-\x08\x10-\x19\x7F-\xFF\r\n]~', $token)) {
            return 1;
        } else {
            return 0;
        }
    }

    /**
     * Splits a string into tokens in blocks of words which can be encoded quickly.
     *
     * @param string $string
     *
     * @return string[]
     */
    protected function getEncodableWordTokens($string)
    {
        $tokens = array();

        $encodedToken = '';
        // Split at all whitespace boundaries
        foreach (preg_split('~(?=[\t ])~', $string) as $token) {
            if ($this->tokenNeedsEncoding($token)) {
                $encodedToken .= $token;
            } else {
                if ($encodedToken !== '') {
                    $tokens[] = $encodedToken;
                    $encodedToken = '';
                }
                $tokens[] = $token;
            }
        }

        if ($encodedToken !== '') {
            $tokens[] = $encodedToken;
        }

        return $tokens;
    }

    /**
     * Get a token as an encoded word for safe insertion into headers.
     *
     * @param string $token           token to encode
     * @param int    $firstLineOffset optional
     *
     * @return string
     */
    protected function getTokenAsEncodedWord($token, $firstLineOffset = 0)
    {
        // Adjust $firstLineOffset to account for space needed for syntax.

        $charsetDecl = $this->_charset;

        if ($this->_lang) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $charsetDecl .= '*' . $this->_lang;
        }

        $encodingWrapperLength = strlen('=?' . $charsetDecl . '?' . $this->_encoder->getName() . '??=');

        if ($firstLineOffset >= 75) {
            // Does this logic need to be here?
            $firstLineOffset = 0;
        }

        /** @noinspection PhpMethodParametersCountMismatchInspection */
        $encodedTextLines = explode(
            "\r\n",
            $this->_encoder->encodeString($token, $firstLineOffset, 75 - $encodingWrapperLength, $this->_charset)

        );

        if (Swift::strtolowerWithStaticCache($this->_charset) !== 'iso-2022-jp') {
            // special encoding for iso-2022-jp using mb_encode_mimeheader
            foreach ($encodedTextLines as $lineNum => $line) {
                $encodedTextLines[$lineNum] = '=?' . $charsetDecl . '?' . $this->_encoder->getName() . '?' . $line . '?=';
            }
        }

        return implode("\r\n ", $encodedTextLines);
    }

    /**
     * Generates tokens from the given string which include CRLF as individual tokens.
     *
     * @param string $token
     *
     * @return string[]
     */
    protected function generateTokenLines($token)
    {
        return preg_split('~(\r\n)~', $token, -1, PREG_SPLIT_DELIM_CAPTURE);
    }

    /**
     * Set a value into the cache.
     *
     * @param string $value
     */
    protected function setCachedValue($value)
    {
        $this->_cachedValue = $value;
    }

    /**
     * Get the value in the cache.
     *
     * @return string
     */
    protected function getCachedValue()
    {
        return $this->_cachedValue;
    }

    private function clearCachedValue()
    {
        $this->setCachedValue(null);
    }

    /**
     * Clear the cached value if $condition is met.
     *
     * @param bool $condition
     */
    protected function clearCachedValueIf($condition)
    {
        if (true === $condition) {
            $this->clearCachedValue();
        }
    }

    /**
     * Generate a list of all tokens in the final header.
     *
     * @param string $string The string to tokenize
     *
     * @return array An array of tokens as strings
     */
    protected function toTokens($string = null)
    {
        if (null === $string) {
            $string = $this->getFieldBody();
        }

        $tokens = array();

        // Generate atoms; split at all invisible boundaries followed by WSP
        foreach (preg_split('~(?=[ \t])~', $string) as $token) {
            $newTokens = $this->generateTokenLines($token);
            foreach ($newTokens as $newToken) {
                $tokens[] = $newToken;
            }
        }

        return $tokens;
    }

    /**
     * Takes an array of tokens which appear in the header and turns them into
     * an RFC 2822 compliant string, adding FWSP where needed.
     *
     * @param string[] $tokens
     *
     * @return string
     */
    private function _tokensToString(array $tokens)
    {
        $lineCount = 0;
        $headerLines = array();
        $headerLines[] = $this->_name . ': ';
        $currentLine = &$headerLines[$lineCount++];

        // Build all tokens back into compliant header
        foreach ($tokens as $i => $token) {
            // Line longer than specified maximum or token was just a new line
            if (
                ("\r\n" === $token)
                ||
                (
                    strlen($currentLine) > 0
                    &&
                    (
                        $i > 0
                        &&
                        strlen($currentLine . $token) > $this->_lineLength
                    )
                )
            ) {
                $headerLines[] = '';
                $currentLine = &$headerLines[$lineCount++];
            }

            // Append token to the line
            if ("\r\n" !== $token) {
                $currentLine .= $token;
            }
        }

        // Implode with FWS (RFC 2822, 2.2.3)

        return implode("\r\n", $headerLines) . "\r\n";
    }

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


1		<?php
2
3		/*
4		* This file is part of SwiftMailer.
5		* (c) 2004-2009 Chris Corbyn
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		/**
12		* An abstract base MIME Header.
13		*
14		* @author Chris Corbyn
15		*/
16		abstract class Swift_Mime_Headers_AbstractHeader implements Swift_Mime_Header
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
17		{
18		const PHRASE_PATTERN = '(?:(?:(?:(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?(\((?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?\)))(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?(\((?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?\)))\|(?:(?:[ \t](?:\r\n))?[ \t])))?[a-zA-Z0-9!#\$%&\'\\+\-\/=\?\^_`\{\}\\|~]+(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?(\((?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?\)))(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?(\((?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?\)))\|(?:(?:[ \t](?:\r\n))?[ \t])))?)\|(?:(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?(\((?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?\)))(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?(\((?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?\)))\|(?:(?:[ \t](?:\r\n))?[ \t])))?"((?:(?:[ \t](?:\r\n))?[ \t])?(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21\x23-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])))(?:(?:[ \t](?:\r\n))?[ \t])?"(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?(\((?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?\)))(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?(\((?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?\)))\|(?:(?:[ \t](?:\r\n))?[ \t])))?))+?)';
19
20		/**
21		* The name of this Header.
22		*
23		* @var string
24		*/
25		private $_name;
26
27		/**
28		* The Encoder used to encode this Header.
29		*
30		* @var Swift_Mime_HeaderEncoder
31		*/
32		private $_encoder;
33
34		/**
35		* The maximum length of a line in the header.
36		*
37		* @var int
38		*/
39		private $_lineLength = 78;
40
41		/**
42		* The language used in this Header.
43		*
44		* @var string\|null
45		*/
46		private $_lang;
47
48		/**
49		* The character set of the text in this Header.
50		*
51		* @var string
52		*/
53		private $_charset = 'utf-8';
54
55		/**
56		* The value of this Header, cached.
57		*
58		* @var string\|null
59		*/
60		private $_cachedValue;
61
62		/**
63		* Creates a new Header.
64		*/
65	258	public function __construct()
66		{
67	258	}
68
69		/**
70		* Set the character set used in this Header.
71		*
72		* @param string $charset
73		*/
74	133	public function setCharset($charset)
75		{
76	133	if ($charset && $charset !== $this->_charset) {
77	19	$this->clearCachedValue();
78
79	19	$this->_charset = $charset;
80
81	19	if ($this->_encoder) {
82	19	$this->_encoder->charsetChanged($charset);
83	19	}
84	19	}
85	133	}
86
87		/**
88		* Get the character set used in this Header.
89		*
90		* @return string
91		*/
92	89	public function getCharset()
93		{
94	89	return $this->_charset;
95		}
96
97		/**
98		* Set the language used in this Header.
99		*
100		* For example, for US English, 'en-us'.
101		* This can be unspecified.
102		*
103		* @param string $lang
104		*/
105	4	public function setLanguage($lang)
106		{
107	4	if ($lang && $this->_lang !== $lang) {
108	4	$this->clearCachedValue();
109	4	$this->_lang = (string)$lang;
110	4	}
111	4	}
112
113		/**
114		* Get the language used in this Header.
115		*
116		* @return string
117		*/
118	7	public function getLanguage()
119		{
120	7	return $this->_lang;
121		}
122
123		/**
124		* Set the encoder used for encoding the header.
125		*
126		* @param Swift_Mime_HeaderEncoder $encoder
127		*/
128	218	public function setEncoder(Swift_Mime_HeaderEncoder $encoder)
129		{
130	218	$this->_encoder = $encoder;
131	218	$this->_encoder->charsetChanged($this->_charset);
132
133	218	$this->setCachedValue(null);
134	218	}
135
136		/**
137		* Get the encoder used for encoding this Header.
138		*
139		* @return Swift_Mime_HeaderEncoder
140		*/
141	83	public function getEncoder()
142		{
143	83	return $this->_encoder;
144		}
145
146		/**
147		* Get the name of this header (e.g. charset).
148		*
149		* @return string
150		*/
151	158	public function getFieldName()
152		{
153	158	return $this->_name;
154		}
155
156		/**
157		* Set the maximum length of lines in the header (excluding EOL).
158		*
159		* @param int $lineLength
160		*
161		* @return bool
162		*/
163	26	public function setMaxLineLength($lineLength)
164		{
165	26	if ($lineLength && $this->_lineLength !== $lineLength) {
166	22	$this->clearCachedValue();
167
168	22	$this->_lineLength = (int)$lineLength;
169
170	22	return true;
171		}
172
173	11	return false;
174		}
175
176		/**
177		* Get the maximum permitted length of lines in this Header.
178		*
179		* @return int
180		*/
181	82	public function getMaxLineLength()
182		{
183	82	return $this->_lineLength;
184		}
185
186		/**
187		* Get this Header rendered as a RFC 2822 compliant string.
188		*
189		* @return string
190		*/
191	157	public function toString()
192		{
193	157	return $this->_tokensToString($this->toTokens());
194		}
195
196		/**
197		* Returns a string representation of this object.
198		*
199		* @return string
200		*
201		* @see toString()
202		*/
203		public function __toString()
204		{
205		return $this->toString();
206		}
207
208		/**
209		* Set the name of this Header field.
210		*
211		* @param string $name
212		*/
213	258	protected function setFieldName($name)
214		{
215	258	$this->_name = $name;
216	258	}
217
218		/**
219		* Produces a compliant, formatted RFC 2822 'phrase' based on the string given.
220		*
221		* @param Swift_Mime_Header $header
222		* @param string $string as displayed
223		* @param string $charset of the text
224		* @param Swift_Mime_HeaderEncoder $encoder
225		* @param bool $shorten the first line to make remove for header name
226		*
227		* @return string
228		*/
229	83	protected function createPhrase(Swift_Mime_Header $header, $string, $charset, Swift_Mime_HeaderEncoder $encoder = null, $shorten = false)
		0 ignored issues – show Unused Code introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report The parameter `$charset` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report The parameter `$encoder` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
230		{
231		// Treat token as exactly what was given
232	83	$phraseStr = $string;
233		// If it's not valid
234	83	if (!preg_match('/^' . self::PHRASE_PATTERN . '$/D', $phraseStr)) {
235		// .. but it is just ascii text, try escaping some characters
236		// and make it a quoted-string
237	12	if (preg_match('/^[\x00-\x08\x0B\x0C\x0E-\x7F]*$/D', $phraseStr)) {
238	3	$phraseStr = $this->escapeSpecials($phraseStr, array('"'));
239	3	$phraseStr = '"' . $phraseStr . '"';
240	3	} else {
241		// ... otherwise it needs encoding
242		// Determine space remaining on line if first line
243	10	if ($shorten) {
244	10	$usedLength = strlen($header->getFieldName() . ': ');
245	10	} else {
246		$usedLength = 0;
247		}
248	10	$phraseStr = $this->encodeWords($header, $string, $usedLength);
249		}
250	12	}
251
252	83	return $phraseStr;
253		}
254
255		/**
256		* Escape special characters in a string (convert to quoted-pairs).
257		*
258		* @param string $token
259		* @param string[] $include additional chars to escape
260		*
261		* @return string
262		*/
263	3	protected function escapeSpecials($token, array $include = array())
264		{
265	3	foreach (array_merge(array('\\'), $include) as $char) {
266	3	$token = str_replace($char, '\\' . $char, $token);
267	3	}
268
269	3	return $token;
270		}
271
272		/**
273		* Encode needed word tokens within a string of input.
274		*
275		* @param Swift_Mime_Header\|Swift_Mime_Headers_AbstractHeader $header
276		* @param string $input
277		* @param int $usedLength optional
278		*
279		* @return string
280		*/
281	161	protected function encodeWords(Swift_Mime_Header $header, $input, $usedLength = -1)
282		{
283	161	$value = '';
284	161	$tokens = $this->getEncodableWordTokens($input);
285	161	foreach ($tokens as $token) {
286		// See RFC 2822, Sect 2.2 (really 2.2 ??)
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-10 17:04 UTC by Report Bug Copy Issue Report `40%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
287	161	if ($this->tokenNeedsEncoding($token)) {
288		// Don't encode starting WSP
289	22	$firstChar = substr($token, 0, 1);
290		switch ($firstChar) {
291	22	case ' ':
292	22	case "\t":
293	11	$value .= $firstChar;
294	11	$token = substr($token, 1);
295	11	}
296	22	if (-1 == $usedLength) {
297	13	$usedLength = strlen($header->getFieldName().': ') + strlen($value);
298	13	}
299	22	$value .= $this->getTokenAsEncodedWord($token, $usedLength);
300	22	$header->setMaxLineLength(76); // Forcefully override
		0 ignored issues – show Bug introduced 2015-11-22 11:38 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Swift_Mime_Header` as the method `setMaxLineLength()` does only exist in the following implementations of said interface: `Swift_Mime_Headers_AbstractHeader`, `Swift_Mime_Headers_DateHeader`, `Swift_Mime_Headers_IdentificationHeader`, `Swift_Mime_Headers_MailboxHeader`, `Swift_Mime_Headers_ParameterizedHeader`, `Swift_Mime_Headers_PathHeader`, `Swift_Mime_Headers_UnstructuredHeader`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
301	22	} else {
302	150	$value .= $token;
303		}
304	161	}
305	161	return $value;
306		}
307
308		/**
309		* Test if a token needs to be encoded or not.
310		*
311		* @param string $token
312		*
313		* @return integer
314		*/
315	161	protected function tokenNeedsEncoding($token)
316		{
317	161	if (preg_match('~[\x00-\x08\x10-\x19\x7F-\xFF\r\n]~', $token)) {
318	21	return 1;
319		} else {
320	150	return 0;
321		}
322		}
323
324		/**
325		* Splits a string into tokens in blocks of words which can be encoded quickly.
326		*
327		* @param string $string
328		*
329		* @return string[]
330		*/
331	161	protected function getEncodableWordTokens($string)
332		{
333	161	$tokens = array();
334
335	161	$encodedToken = '';
336		// Split at all whitespace boundaries
337	161	foreach (preg_split('~(?=[\t ])~', $string) as $token) {
338	161	if ($this->tokenNeedsEncoding($token)) {
339	22	$encodedToken .= $token;
340	22	} else {
341	150	if ($encodedToken !== '') {
342	8	$tokens[] = $encodedToken;
343	8	$encodedToken = '';
344	8	}
345	150	$tokens[] = $token;
346		}
347	161	}
348
349	161	if ($encodedToken !== '') {
350	21	$tokens[] = $encodedToken;
351	21	}
352
353	161	return $tokens;
354		}
355
356		/**
357		* Get a token as an encoded word for safe insertion into headers.
358		*
359		* @param string $token token to encode
360		* @param int $firstLineOffset optional
361		*
362		* @return string
363		*/
364	23	protected function getTokenAsEncodedWord($token, $firstLineOffset = 0)
365		{
366		// Adjust $firstLineOffset to account for space needed for syntax.
367
368	23	$charsetDecl = $this->_charset;
369
370	23	if ($this->_lang) {
		0 ignored issues – show Bug Best Practice introduced 2016-05-28 10:25 UTC by Report Bug Copy Issue Report The expression `$this->_lang` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
371	2	$charsetDecl .= '*' . $this->_lang;
372	2	}
373
374	23	$encodingWrapperLength = strlen('=?' . $charsetDecl . '?' . $this->_encoder->getName() . '??=');
375
376	23	if ($firstLineOffset >= 75) {
377		// Does this logic need to be here?
378		$firstLineOffset = 0;
379		}
380
381		/** @noinspection PhpMethodParametersCountMismatchInspection */
382	23	$encodedTextLines = explode(
383	23	"\r\n",
384	23	$this->_encoder->encodeString($token, $firstLineOffset, 75 - $encodingWrapperLength, $this->_charset)
		0 ignored issues – show Unused Code introduced 2016-07-09 01:57 UTC by Report Bug Copy Issue Report The call to `Swift_Mime_HeaderEncoder::encodeString()` has too many arguments starting with `$this->_charset`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
385	23	);
386
387	23	if (Swift::strtolowerWithStaticCache($this->_charset) !== 'iso-2022-jp') {
388		// special encoding for iso-2022-jp using mb_encode_mimeheader
389	23	foreach ($encodedTextLines as $lineNum => $line) {
390	23	$encodedTextLines[$lineNum] = '=?' . $charsetDecl . '?' . $this->_encoder->getName() . '?' . $line . '?=';
391	23	}
392	23	}
393
394	23	return implode("\r\n ", $encodedTextLines);
395		}
396
397		/**
398		* Generates tokens from the given string which include CRLF as individual tokens.
399		*
400		* @param string $token
401		*
402		* @return string[]
403		*/
404	157	protected function generateTokenLines($token)
405		{
406	157	return preg_split('~(\r\n)~', $token, -1, PREG_SPLIT_DELIM_CAPTURE);
407		}
408
409		/**
410		* Set a value into the cache.
411		*
412		* @param string $value
413		*/
414	247	protected function setCachedValue($value)
415		{
416	247	$this->_cachedValue = $value;
417	247	}
418
419		/**
420		* Get the value in the cache.
421		*
422		* @return string
423		*/
424	176	protected function getCachedValue()
425		{
426	176	return $this->_cachedValue;
427		}
428
429	206	private function clearCachedValue()
430		{
431	206	$this->setCachedValue(null);
432	206	}
433
434		/**
435		* Clear the cached value if $condition is met.
436		*
437		* @param bool $condition
438		*/
439	197	protected function clearCachedValueIf($condition)
440		{
441	197	if (true === $condition) {
442	197	$this->clearCachedValue();
443	197	}
444	197	}
445
446		/**
447		* Generate a list of all tokens in the final header.
448		*
449		* @param string $string The string to tokenize
450		*
451		* @return array An array of tokens as strings
452		*/
453	157	protected function toTokens($string = null)
454		{
455	157	if (null === $string) {
456	152	$string = $this->getFieldBody();
457	152	}
458
459	157	$tokens = array();
460
461		// Generate atoms; split at all invisible boundaries followed by WSP
462	157	foreach (preg_split('~(?=[ \t])~', $string) as $token) {
463	157	$newTokens = $this->generateTokenLines($token);
464	157	foreach ($newTokens as $newToken) {
465	157	$tokens[] = $newToken;
466	157	}
467	157	}
468
469	157	return $tokens;
470		}
471
472		/**
473		* Takes an array of tokens which appear in the header and turns them into
474		* an RFC 2822 compliant string, adding FWSP where needed.
475		*
476		* @param string[] $tokens
477		*
478		* @return string
479		*/
480	157	private function _tokensToString(array $tokens)
481		{
482	157	$lineCount = 0;
483	157	$headerLines = array();
484	157	$headerLines[] = $this->_name . ': ';
485	157	$currentLine = &$headerLines[$lineCount++];
486
487		// Build all tokens back into compliant header
488	157	foreach ($tokens as $i => $token) {
489		// Line longer than specified maximum or token was just a new line
490		if (
491	157	("\r\n" === $token)
492		\|\|
493		(
494	157	strlen($currentLine) > 0
495	157	&&
496		(
497		$i > 0
498	157	&&
499	139	strlen($currentLine . $token) > $this->_lineLength
500	139	)
501	157	)
502	157	) {
503	43	$headerLines[] = '';
504	43	$currentLine = &$headerLines[$lineCount++];
505	43	}
506
507		// Append token to the line
508	157	if ("\r\n" !== $token) {
509	157	$currentLine .= $token;
510	157	}
511	157	}
512
513		// Implode with FWS (RFC 2822, 2.2.3)
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-10 17:04 UTC by Report Bug Copy Issue Report `38%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
514	157	return implode("\r\n", $headerLines) . "\r\n";
515		}
516
517		/**
518		* Make a deep copy of object
519		*/
520	5	public function __clone()
521		{
522	5	if ($this->_encoder !== null) {
523	5	$this->_encoder = clone $this->_encoder;
524	5	}
525	5	}
526		}
527

voku / swiftmailer

Push — 5.x ( 075674...25eba8 )

Swift_Mime_Headers_AbstractHeader::createPhrase() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like