helper.php ➔ get_log_columns_to_export() - Code Metrics - Inspection of "Modify TableManager class to get logs to export as..." - sudar/email-log - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#68)

by Maria Daniel Deepak

created 2017-03-02 19:01 UTC

helper.php ➔ get_log_columns_to_export() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	8
ccs	0
cts	0
cp	0
crap	6
rs	9.4285
c	0
b	0
f	0

<?php namespace EmailLog\Util;

/**
 * Email Log Helper functions.
 * Some of these functions would be used the addons.
 */

/**
 * Perform additional sanitation of emails.
 *
 * @since 1.9
 *
 * @param string $email    Email string to be sanitized.
 * @param bool   $multiple (Optional) Should multiple emails be allowed. True by default.
 *
 * @return string Sanitized email.
 */
function sanitize_email( $email, $multiple = true ) {
	$emails = explode( ',', $email );
	if ( ! $multiple ) {
		$emails = array_slice( $emails, 0, 1 );
	}

	$cleaned_emails = array_map( __NAMESPACE__ . '\\sanitize_email_with_name', $emails );

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

/**
 * Sanitize email with name.
 *
 * @since 1.9
 *
 * @param $string $email Email string to be sanitized.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
 *
 * @return string Sanitized email.
 */
function sanitize_email_with_name( $string ) {
	$string = trim( $string );

	$bracket_pos = strpos( $string, '<' );
	if ( false !== $bracket_pos ) {
		// Text before the bracketed email is the name.
		if ( $bracket_pos > 0 ) {
			$name = substr( $string, 0, $bracket_pos );
			$name = str_replace( '"', '', $name );
			$name = trim( $name );

			$email = substr( $string, $bracket_pos + 1 );
			$email = str_replace( '>', '', $email );

			return sanitize_text_field( $name ) . ' <' . \sanitize_email( $email ) . '>';
		}
	}

	return \sanitize_email( $string );
}

/**
 * Gets the columns to export logs.
 *
 * If the More Fields add-on is active, additional columns are returned.
 *
 * @since 2.0.0
 *
 * @return array List of Columns to export.
 */
function get_log_columns_to_export() {

	if ( is_plugin_active( 'email-log-more-fields/email-log-more-fields.php' ) ) {
		return array( 'id', 'sent_date', 'to_email', 'subject', 'from', 'cc', 'bcc', 'reply-to', 'attachment' );
	}

	return array( 'id', 'sent_date', 'to_email', 'subject' );
}

1		<?php namespace EmailLog\Util;
2
3		/**
4		* Email Log Helper functions.
5		* Some of these functions would be used the addons.
6		*/
7
8		/**
9		* Perform additional sanitation of emails.
10		*
11		* @since 1.9
12		*
13		* @param string $email Email string to be sanitized.
14		* @param bool $multiple (Optional) Should multiple emails be allowed. True by default.
15		*
16		* @return string Sanitized email.
17		*/
18		function sanitize_email( $email, $multiple = true ) {
19	16	$emails = explode( ',', $email );
20	16	if ( ! $multiple ) {
21	4	$emails = array_slice( $emails, 0, 1 );
22	4	}
23
24	16	$cleaned_emails = array_map( __NAMESPACE__ . '\\sanitize_email_with_name', $emails );
25
26	16	return implode( ', ', $cleaned_emails );
27		}
28
29		/**
30		* Sanitize email with name.
31		*
32		* @since 1.9
33		*
34		* @param $string $email Email string to be sanitized.
		0 ignored issues – show Documentation introduced 2016-06-19 06:13 UTC by Report Bug Copy Issue Report The doc-type `$string` could not be parsed: Unknown type name "$string" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history... Bug introduced 2016-06-19 06:13 UTC by Report Bug Copy Issue Report There is no parameter named `$email`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
35		*
36		* @return string Sanitized email.
37		*/
38		function sanitize_email_with_name( $string ) {
39	16	$string = trim( $string );
40
41	16	$bracket_pos = strpos( $string, '<' );
42	16	if ( false !== $bracket_pos ) {
43		// Text before the bracketed email is the name.
44	8	if ( $bracket_pos > 0 ) {
45	8	$name = substr( $string, 0, $bracket_pos );
46	8	$name = str_replace( '"', '', $name );
47	8	$name = trim( $name );
48
49	8	$email = substr( $string, $bracket_pos + 1 );
50	8	$email = str_replace( '>', '', $email );
51
52	8	return sanitize_text_field( $name ) . ' <' . \sanitize_email( $email ) . '>';
53		}
54		}
55
56	8	return \sanitize_email( $string );
57		}
58
59		/**
60		* Gets the columns to export logs.
61		*
62		* If the More Fields add-on is active, additional columns are returned.
63		*
64		* @since 2.0.0
65		*
66		* @return array List of Columns to export.
67		*/
68		function get_log_columns_to_export() {
69
70		if ( is_plugin_active( 'email-log-more-fields/email-log-more-fields.php' ) ) {
71		return array( 'id', 'sent_date', 'to_email', 'subject', 'from', 'cc', 'bcc', 'reply-to', 'attachment' );
72		}
73
74		return array( 'id', 'sent_date', 'to_email', 'subject' );
75		}

sudar / email-log

Pull Request — master (#68)

helper.php ➔ get_log_columns_to_export() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like