EmailHelper::arrayToList() - Code Metrics - symphonycms/symphony-2 - Measure and Improve Code Quality continuously with Scrutinizer

EmailHelper::arrayToList() A
last analyzed 2019-04-08 19:56 UTC

↳ Parent: EmailHelper

Complexity

Conditions	4
Paths	5

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	6
c	0
b	0
f	0
nc	5
nop	1
dl	0
loc	10
rs	10

<?php

/**
 * @package toolkit
 */

/**
 * A helper class for various email functions.
 */
abstract class EmailHelper
{
    /**
     * Folding an email header field body as required by RFC2822.
     *
     * @param string $input
     *  header field body string
     * @param integer $max_length
     *  defaults to 75
     * @return string
     *  folded output string
     */
    public static function fold($input, $max_length = 75)

    {
        return @wordwrap($input, $max_length, "\r\n ");
    }

    /**
     * Q-encoding of a header field 'text' token or 'word' entity
     * within a 'phrase', according to RFC2047. The output is called
     * an 'encoded-word'; it must not be longer than 75 characters.
     *
     * This might be achieved with PHP's `mbstring` functions, but
     * `mbstring` is a non-default extension.
     *
     * For simplicity reasons this function encodes every character
     * except upper and lower case letters and decimal digits.
     *
     * RFC: 'While there is no limit to the length of a multiple-line
     * header field, each line of a header field that contains one or
     * more 'encoded-word's is limited to 76 characters.'
     * The required 'folding' will not be done here, but in another
     * helper function.
     *
     * This function must be 'multi-byte-sensitive' in a way that it
     * must never scatter a multi-byte character representation across
     * multiple encoded-words. So a 'lookahead' has been implemented,
     * based on the fact that for UTF-8 encoded characters any byte
     * except the first byte will have a leading '10' bit pattern,
     * which means an ASCII value >=128 and <=191.
     *
     * @author Elmar Bartel
     * @author Michael Eichelsdoerfer
     * @param string $input
     *  string to encode
     * @param integer $max_length
     *  maximum line length (default: 75 chars)
     * @return string $output
     *  encoded string
     */
    public static function qEncode($input, $max_length = 75)

    {
        // Don't encode empty strings
        if (empty($input)) {
            return $input;
        }

        // Don't encode if all code points are in ASCII range 0-127
        if (!preg_match('/[\\x80-\\xff]+/', $input)) {
            return $input;
        }

        $qpHexDigits  = '0123456789ABCDEF';
        $input_length = strlen($input);
        // Substract delimiters, character set and encoding
        $line_limit   = $max_length - 12;
        $line_length  = 0;

        $output = '=?UTF-8?Q?';

        for ($i=0; $i < $input_length; $i++) {
            $char = $input[$i];
            $ascii = ord($char);

            // No encoding for all 62 alphanumeric characters
            if (48 <= $ascii && $ascii <= 57 || 65 <= $ascii && $ascii <= 90 || 97 <= $ascii && $ascii <= 122) {
                $replace_length = 1;
                $replace_char = $char;

                // Encode space as underscore (means better readability for humans)
            } elseif ($ascii == 32) {
                $replace_length = 1;
                $replace_char = '_';

                // Encode
            } else {
                $replace_length = 3;
                // Bit operation is around 10 percent faster
                // than 'strtoupper(dechex($ascii))'
                $replace_char = '='
                              . $qpHexDigits[$ascii >> 4]
                              . $qpHexDigits[$ascii & 0x0f];

                // Account for following bytes of UTF8-multi-byte
                // sequence (max. length is 4 octets, RFC3629)
                $lookahead_limit = min($i+4, $input_length);

                for ($lookahead = $i+1; $lookahead < $lookahead_limit; $lookahead++) {
                    $ascii_ff = ord($input[$lookahead]);
                    if (128 <= $ascii_ff && $ascii_ff <= 191) {
                        $replace_char .= '='
                                       . $qpHexDigits[$ascii_ff >> 4]
                                       . $qpHexDigits[$ascii_ff & 0x0f];
                        $replace_length += 3;
                        $i++;
                    } else {
                        break;
                    }
                }
            }

            // Would the line become too long?
            if ($line_length + $replace_length > $line_limit) {
                $output .= "?= =?UTF-8?Q?";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
                $line_length = 0;
            }

            $output .= $replace_char;
            $line_length += $replace_length;
        }

        $output .= '?=';
        return $output;
    }

    /**
     * Quoted-printable encoding of a message body (part),
     * according to RFC2045.
     *
     * This function handles <CR>, <LF>, <CR><LF> and <LF><CR> sequences
     * as 'user relevant' line breaks and encodes them as RFC822 line
     * breaks as required by RFC2045.
     *
     * @author Elmar Bartel
     * @author Michael Eichelsdoerfer
     * @param string $input
     *  string to encode
     * @param integer $max_length
     *  maximum line length (default: 76 chars)
     * @return string $output
     *  encoded string
     */
    public static function qpContentTransferEncode($input, $max_length = 76)

    {
        $qpHexDigits  = '0123456789ABCDEF';
        $input_length = strlen($input);
        $line_limit   = $max_length;
        $line_length  = 0;
        $output       = '';
        $blank        = false;

        for ($i=0; $i < $input_length; $i++) {
            $char = $input[$i];
            $ascii = ord($char);

            // No encoding for spaces and tabs
            if ($ascii == 9 || $ascii == 32) {
                $blank = true;
                $replace_length = 1;
                $replace_char = $char;

                // CR and LF
            } elseif ($ascii == 13 || $ascii == 10) {
                // Use existing offset only.
                if ($i+1 < $input_length) {
                    if (($ascii == 13 && ord($input[$i+1]) == 10) || ($ascii == 10 && ord($input[$i+1]) == 13)) {
                        $i++;
                    }
                }

                if ($blank) {
                    /**
                     * Any tab or space characters on an encoded line MUST
                     * be followed on that line by a printable character.
                     * This character may as well be the soft line break
                     * indicator.
                     *
                     * So if the preceding character is a space or a
                     * tab, we may simply insert a soft line break
                     * here, followed by a literal line break.
                     * Basically this means that we are appending
                     * an empty line (nada).
                     */
                    $output .= "=\r\n\r\n";
                } else {
                    $output .= "\r\n";
                }

                $blank = false;
                $line_length = 0;
                continue;

                // No encoding within ascii range 33 to 126 (exception: 61)
            } elseif (32 < $ascii && $ascii < 127 && $char !== '=') {
                $replace_length = 1;
                $replace_char = $char;
                $blank = false;

                // Encode
            } else {
                $replace_length = 3;
                // bit operation is around 10 percent faster
                // than 'strtoupper(dechex($ascii))'
                $replace_char = '='
                              . $qpHexDigits[$ascii >> 4]
                              . $qpHexDigits[$ascii & 0x0f];
                $blank = false;
            }

            // Would the line become too long?
            if ($line_length + $replace_length > $line_limit - 1) {
                $output .= "=\r\n";
                $line_length = 0;
            }

            $output .= $replace_char;
            $line_length += $replace_length;
        }

        return $output;
    }

    /**
     * Content-Transfer-Encoding for attachments
     *
     * This function will encode attachments according to RFC2045.
     * Line length must not exceed the default (76 characters).
     *
     * @author Michael Eichelsdoerfer
     * @param string $data
     * @param integer $length
     * @return string
     */
    public static function base64ContentTransferEncode($data, $length = 76)

    {
        return chunk_split(base64_encode($data), $length);
    }

    /**
     * Implodes an associative array or straight array to a
     * comma-separated string
     *
     * @param array $array
     * @return string
     */
    public static function arrayToList(array $array = array())

    {
        $return = array();
        foreach ($array as $name => $email) {
            $return[] = empty($name) || General::intval($name) > -1
                        ? $email

                        : $name . ' <' . $email . '>';
        }

        return implode(', ', $return);
    }
}


1			<?php
2
3			/**
4			* @package toolkit
5			*/
6
7			/**
8			* A helper class for various email functions.
9			*/
10			abstract class EmailHelper
11			{
12			/**
13			* Folding an email header field body as required by RFC2822.
14			*
15			* @param string $input
16			* header field body string
17			* @param integer $max_length
18			* defaults to 75
19			* @return string
20			* folded output string
21			*/
22			public static function fold($input, $max_length = 75)
			0 ignored issues – show Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between argument "$max_length" and equals sign; expected 0 but found 1 Loading history... Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between default value and equals sign for argument "$max_length"; expected 0 but found 1 Loading history...
23			{
24			return @wordwrap($input, $max_length, "\r\n ");
25			}
26
27			/**
28			* Q-encoding of a header field 'text' token or 'word' entity
29			* within a 'phrase', according to RFC2047. The output is called
30			* an 'encoded-word'; it must not be longer than 75 characters.
31			*
32			* This might be achieved with PHP's `mbstring` functions, but
33			* `mbstring` is a non-default extension.
34			*
35			* For simplicity reasons this function encodes every character
36			* except upper and lower case letters and decimal digits.
37			*
38			* RFC: 'While there is no limit to the length of a multiple-line
39			* header field, each line of a header field that contains one or
40			* more 'encoded-word's is limited to 76 characters.'
41			* The required 'folding' will not be done here, but in another
42			* helper function.
43			*
44			* This function must be 'multi-byte-sensitive' in a way that it
45			* must never scatter a multi-byte character representation across
46			* multiple encoded-words. So a 'lookahead' has been implemented,
47			* based on the fact that for UTF-8 encoded characters any byte
48			* except the first byte will have a leading '10' bit pattern,
49			* which means an ASCII value >=128 and <=191.
50			*
51			* @author Elmar Bartel
52			* @author Michael Eichelsdoerfer
53			* @param string $input
54			* string to encode
55			* @param integer $max_length
56			* maximum line length (default: 75 chars)
57			* @return string $output
58			* encoded string
59			*/
60			public static function qEncode($input, $max_length = 75)
			0 ignored issues – show Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between argument "$max_length" and equals sign; expected 0 but found 1 Loading history... Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between default value and equals sign for argument "$max_length"; expected 0 but found 1 Loading history...
61			{
62			// Don't encode empty strings
63			if (empty($input)) {
64			return $input;
65			}
66
67			// Don't encode if all code points are in ASCII range 0-127
68			if (!preg_match('/[\\x80-\\xff]+/', $input)) {
69			return $input;
70			}
71
72			$qpHexDigits = '0123456789ABCDEF';
73			$input_length = strlen($input);
74			// Substract delimiters, character set and encoding
75			$line_limit = $max_length - 12;
76			$line_length = 0;
77
78			$output = '=?UTF-8?Q?';
79
80			for ($i=0; $i < $input_length; $i++) {
81			$char = $input[$i];
82			$ascii = ord($char);
83
84			// No encoding for all 62 alphanumeric characters
85			if (48 <= $ascii && $ascii <= 57 \|\| 65 <= $ascii && $ascii <= 90 \|\| 97 <= $ascii && $ascii <= 122) {
86			$replace_length = 1;
87			$replace_char = $char;
88
89			// Encode space as underscore (means better readability for humans)
90			} elseif ($ascii == 32) {
91			$replace_length = 1;
92			$replace_char = '_';
93
94			// Encode
95			} else {
96			$replace_length = 3;
97			// Bit operation is around 10 percent faster
98			// than 'strtoupper(dechex($ascii))'
99			$replace_char = '='
100			. $qpHexDigits[$ascii >> 4]
101			. $qpHexDigits[$ascii & 0x0f];
102
103			// Account for following bytes of UTF8-multi-byte
104			// sequence (max. length is 4 octets, RFC3629)
105			$lookahead_limit = min($i+4, $input_length);
106
107			for ($lookahead = $i+1; $lookahead < $lookahead_limit; $lookahead++) {
108			$ascii_ff = ord($input[$lookahead]);
109			if (128 <= $ascii_ff && $ascii_ff <= 191) {
110			$replace_char .= '='
111			. $qpHexDigits[$ascii_ff >> 4]
112			. $qpHexDigits[$ascii_ff & 0x0f];
113			$replace_length += 3;
114			$i++;
115			} else {
116			break;
117			}
118			}
119			}
120
121			// Would the line become too long?
122			if ($line_length + $replace_length > $line_limit) {
123			$output .= "?= =?UTF-8?Q?";
			0 ignored issues – show Coding Style Comprehensibility introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report The string literal `?= =?UTF-8?Q?` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
124			$line_length = 0;
125			}
126
127			$output .= $replace_char;
128			$line_length += $replace_length;
129			}
130
131			$output .= '?=';
132			return $output;
133			}
134
135			/**
136			* Quoted-printable encoding of a message body (part),
137			* according to RFC2045.
138			*
139			* This function handles <CR>, <LF>, <CR><LF> and <LF><CR> sequences
140			* as 'user relevant' line breaks and encodes them as RFC822 line
141			* breaks as required by RFC2045.
142			*
143			* @author Elmar Bartel
144			* @author Michael Eichelsdoerfer
145			* @param string $input
146			* string to encode
147			* @param integer $max_length
148			* maximum line length (default: 76 chars)
149			* @return string $output
150			* encoded string
151			*/
152			public static function qpContentTransferEncode($input, $max_length = 76)
			0 ignored issues – show Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between argument "$max_length" and equals sign; expected 0 but found 1 Loading history... Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between default value and equals sign for argument "$max_length"; expected 0 but found 1 Loading history...
153			{
154			$qpHexDigits = '0123456789ABCDEF';
155			$input_length = strlen($input);
156			$line_limit = $max_length;
157			$line_length = 0;
158			$output = '';
159			$blank = false;
160
161			for ($i=0; $i < $input_length; $i++) {
162			$char = $input[$i];
163			$ascii = ord($char);
164
165			// No encoding for spaces and tabs
166			if ($ascii == 9 \|\| $ascii == 32) {
167			$blank = true;
168			$replace_length = 1;
169			$replace_char = $char;
170
171			// CR and LF
172			} elseif ($ascii == 13 \|\| $ascii == 10) {
173			// Use existing offset only.
174			if ($i+1 < $input_length) {
175			if (($ascii == 13 && ord($input[$i+1]) == 10) \|\| ($ascii == 10 && ord($input[$i+1]) == 13)) {
176			$i++;
177			}
178			}
179
180			if ($blank) {
181			/**
182			* Any tab or space characters on an encoded line MUST
183			* be followed on that line by a printable character.
184			* This character may as well be the soft line break
185			* indicator.
186			*
187			* So if the preceding character is a space or a
188			* tab, we may simply insert a soft line break
189			* here, followed by a literal line break.
190			* Basically this means that we are appending
191			* an empty line (nada).
192			*/
193			$output .= "=\r\n\r\n";
194			} else {
195			$output .= "\r\n";
196			}
197
198			$blank = false;
199			$line_length = 0;
200			continue;
201
202			// No encoding within ascii range 33 to 126 (exception: 61)
203			} elseif (32 < $ascii && $ascii < 127 && $char !== '=') {
204			$replace_length = 1;
205			$replace_char = $char;
206			$blank = false;
207
208			// Encode
209			} else {
210			$replace_length = 3;
211			// bit operation is around 10 percent faster
212			// than 'strtoupper(dechex($ascii))'
213			$replace_char = '='
214			. $qpHexDigits[$ascii >> 4]
215			. $qpHexDigits[$ascii & 0x0f];
216			$blank = false;
217			}
			0 ignored issues – show Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report No blank line found after control structure Loading history...
218			// Would the line become too long?
219			if ($line_length + $replace_length > $line_limit - 1) {
220			$output .= "=\r\n";
221			$line_length = 0;
222			}
223
224			$output .= $replace_char;
225			$line_length += $replace_length;
226			}
227
228			return $output;
229			}
230
231			/**
232			* Content-Transfer-Encoding for attachments
233			*
234			* This function will encode attachments according to RFC2045.
235			* Line length must not exceed the default (76 characters).
236			*
237			* @author Michael Eichelsdoerfer
238			* @param string $data
239			* @param integer $length
240			* @return string
241			*/
242			public static function base64ContentTransferEncode($data, $length = 76)
			0 ignored issues – show Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between argument "$length" and equals sign; expected 0 but found 1 Loading history... Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between default value and equals sign for argument "$length"; expected 0 but found 1 Loading history...
243			{
244			return chunk_split(base64_encode($data), $length);
245			}
246
247			/**
248			* Implodes an associative array or straight array to a
249			* comma-separated string
250			*
251			* @param array $array
252			* @return string
253			*/
254			public static function arrayToList(array $array = array())
			0 ignored issues – show Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between argument "$array" and equals sign; expected 0 but found 1 Loading history... Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Incorrect spacing between default value and equals sign for argument "$array"; expected 0 but found 1 Loading history...
255			{
256			$return = array();
257			foreach ($array as $name => $email) {
258			$return[] = empty($name) \|\| General::intval($name) > -1
259			? $email
			0 ignored issues – show Coding Style introduced 2019-03-19 18:18 UTC by Report Bug Copy Issue Report Inline shorthand IF statement must be declared on a single line Loading history...
260			: $name . ' <' . $email . '>';
261			}
262
263			return implode(', ', $return);
264			}
265			}
266

symphonycms / symphony-2

GitHub Access Token became invalid

EmailHelper::arrayToList() A last analyzed 2019-04-08 19:56 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

EmailHelper::arrayToList() A
last analyzed 2019-04-08 19:56 UTC