Give_Settings_Email::get_sections() - Code Metrics - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Give_Settings_Email::get_sections() A
last analyzed 2019-03-08 02:52 UTC

↳ Parent: Give_Settings_Email

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0

<?php
/**
 * Give Settings Page/Tab
 *
 * @package     Give
 * @subpackage  Classes/Give_Settings_Email
 * @copyright   Copyright (c) 2016, GiveWP
 * @license     http://opensource.org/licenses/gpl-2.0.php GNU Public License
 * @since       1.8
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit; // Exit if accessed directly
}

if ( ! class_exists( 'Give_Settings_Email' ) ) :

	/**
	 * Give_Settings_Email.
	 *
	 * @sine 1.8
	 */
	class Give_Settings_Email extends Give_Settings_Page {

		/**
		 * Constructor.
		 */
		public function __construct() {
			$this->id    = 'emails';
			$this->label = esc_html__( 'Emails', 'give' );

			$this->default_tab = 'donor-email';

			parent::__construct();

			add_action( 'give_admin_field_email_notification', array( $this, 'email_notification_setting' ) );
		}

		/**
		 * Get settings array.
		 *
		 * @since  1.8
		 * @return array
		 */
		public function get_settings() {
			$settings        = array();
			$current_section = give_get_current_setting_section();

			switch ( $current_section ) {
				case 'email-settings' :
					$settings = array(

						// Section 1: Email Sender Setting
						array(
							'id'    => 'give_title_email_settings_1',
							'type'  => 'title',
						),
						array(
							'id'      => 'email_template',
							'name'    => esc_html__( 'Email Template', 'give' ),
							'desc'    => esc_html__( 'Choose your template from the available registered template types.', 'give' ),
							'type'    => 'select',
							'options' => give_get_email_templates(),
						),
						array(
							'id'   => 'email_logo',
							'name' => esc_html__( 'Logo', 'give' ),
							'desc' => esc_html__( 'Upload or choose a logo to be displayed at the top of the donation receipt emails. Displayed on HTML emails only.', 'give' ),
							'type' => 'file',
						),
						array(
							'id'      => 'from_name',
							'name'    => esc_html__( 'From Name', 'give' ),
							'desc'    => esc_html__( 'The name which appears in the "From" field in all Give donation emails.', 'give' ),
							'default' => get_bloginfo( 'name' ),
							'type'    => 'text',
						),
						array(
							'id'      => 'from_email',
							'name'    => esc_html__( 'From Email', 'give' ),
							'desc'    => esc_html__( 'Email address from which all Give emails are sent from. This will act as the "from" and "reply-to" email address.', 'give' ),
							'default' => get_bloginfo( 'admin_email' ),
							'type'    => 'text',
						),
						array(
							'name'  => esc_html__( 'Donation Notification Settings Docs Link', 'give' ),
							'id'    => 'donation_notification_settings_docs_link',
							'url'   => esc_url( 'http://docs.givewp.com/settings-donation-notification' ),
							'title' => __( 'Donation Notification Settings', 'give' ),
							'type'  => 'give_docs_link',
						),
						array(
							'id'   => 'give_title_email_settings_3',
							'type' => 'sectionend',
						),
					);
					break;

				case 'donor-email' :

					$settings = array(

						// Section 1: Donor Email Notification Listing.
						array(
							'desc'       => __( 'Email notifications sent from Give for donor are listed below. Click on an email to configure it.', 'give' ),
							'type'       => 'title',
							'id'         => 'give_donor_email_notification_settings',
							'table_html' => false,
						),
						array(
							'type' => 'email_notification',
						),
						array(
							'type' => 'sectionend',
							'id'   => 'give_donor_email_notification_settings',
						),

					);
					break;

				case 'admin-email' :

					$settings = array(

						// Section 1: Admin Email Notification Listing.
						array(
							'desc'       => __( 'Email notifications sent from Give for admin are listed below. Click on an email to configure it.', 'give' ),
							'type'       => 'title',
							'id'         => 'give_admin_email_notification_settings',
							'table_html' => false,
						),
						array(
							'type' => 'email_notification',
						),
						array(
							'type' => 'sectionend',
							'id'   => 'give_admin_email_notification_settings',
						),

					);
					break;

				case 'contact':
					$settings = array(

						array(
							'id'   => 'give_title_general_settings_5',
							'type' => 'title'
						),
						array(
							'name'    => __( 'Admin Email Address', 'give' ),
							'id'      => "contact_admin_email",
<?php

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

print $doubleQuoted;
							'desc'    => sprintf( '%1$s <code>{admin_email}</code> %2$s', __( 'By default, the', 'give' ), __( 'tag will use your WordPress admin email. If you would like to customize this address you can do so in the field above.', 'give' ) ),
							'type'    => 'text',
							'default' => give_email_admin_email(),

						),
						array(
							'name'    => __( 'Offline Mailing Address', 'give' ),
							'id'      => "contact_offline_mailing_address",
<?php

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

print $doubleQuoted;
							'desc'    => sprintf( '%1$s <code>{offline_mailing_address}</code> %2$s', __( 'Set the mailing address to where you would like your donors to send their offline donations. This will customize the', 'give' ), __( 'email tag for the Offline Donations payment gateway.', 'give' ) ),
							'type'    => 'wysiwyg',
							'default' => '&nbsp;&nbsp;&nbsp;&nbsp;<em>' . get_bloginfo( 'sitename' ) . '</em><br>&nbsp;&nbsp;&nbsp;&nbsp;<em>111 Not A Real St.</em><br>&nbsp;&nbsp;&nbsp;&nbsp;<em>Anytown, CA 12345 </em><br>',

						),
						array(
							'id'   => 'give_title_general_settings_4',
							'type' => 'sectionend'
						)
					);

					break;
			}// End switch().

			/**
			 * Filter the emails settings.
			 * Backward compatibility: Please do not use this filter. This filter is deprecated in 1.8
			 */
			$settings = apply_filters( 'give_settings_emails', $settings );

			/**
			 * Filter the settings.
			 *
			 * @since  1.8
			 *
			 * @param  array $settings
			 */
			$settings = apply_filters( 'give_get_settings_' . $this->id, $settings );

			// Output.
			return $settings;
		}

		/**
		 * Get sections.
		 *
		 * @since 1.8
		 * @return array
		 */
		public function get_sections() {
			$sections = array(
				'donor-email'    => esc_html__( 'Donor Emails', 'give' ),
				'admin-email'    => esc_html__( 'Admin Emails', 'give' ),
				'email-settings' => esc_html__( 'Email Settings', 'give' ),
				'contact'        => esc_html__( 'Contact Information', 'give' ),
			);

			return apply_filters( 'give_get_sections_' . $this->id, $sections );
		}

		/**
		 * Render email_notification field type
		 *
		 * @since  2.0
		 * @access public
		 */
		public function email_notification_setting() {
			// Load email notification table.
			require_once GIVE_PLUGIN_DIR . 'includes/admin/emails/class-email-notification-table.php';

			// Init table.
			$email_notifications_table = new Give_Email_Notification_Table();

			// Print table.
			$email_notifications_table->prepare_items();
			$email_notifications_table->display();
		}

		/**
		 * Output the settings.
		 *
		 * Note: if you want to overwrite this function then manage show/hide save button in your class.
		 *
		 * @since  1.8
		 * @return void
		 */
		public function output() {
			if ( $this->enable_save ) {
				$GLOBALS['give_hide_save_button'] = apply_filters( 'give_hide_save_button_on_email_admin_setting_page', false );
			}

			$settings = $this->get_settings();

			Give_Admin_Settings::output_fields( $settings, 'give_settings' );
		}
	}

endif;

return new Give_Settings_Email();


1		<?php
2		/**
3		* Give Settings Page/Tab
4		*
5		* @package Give
6		* @subpackage Classes/Give_Settings_Email
7		* @copyright Copyright (c) 2016, GiveWP
8		* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
9		* @since 1.8
10		*/
11
12		if ( ! defined( 'ABSPATH' ) ) {
13		exit; // Exit if accessed directly
14		}
15
16		if ( ! class_exists( 'Give_Settings_Email' ) ) :
17
18		/**
19		* Give_Settings_Email.
20		*
21		* @sine 1.8
22		*/
23		class Give_Settings_Email extends Give_Settings_Page {
24
25		/**
26		* Constructor.
27		*/
28		public function __construct() {
29		$this->id = 'emails';
30		$this->label = esc_html__( 'Emails', 'give' );
31
32		$this->default_tab = 'donor-email';
33
34		parent::__construct();
35
36		add_action( 'give_admin_field_email_notification', array( $this, 'email_notification_setting' ) );
37		}
38
39		/**
40		* Get settings array.
41		*
42		* @since 1.8
43		* @return array
44		*/
45		public function get_settings() {
46		$settings = array();
47		$current_section = give_get_current_setting_section();
48
49		switch ( $current_section ) {
50		case 'email-settings' :
51		$settings = array(
52
53		// Section 1: Email Sender Setting
54		array(
55		'id' => 'give_title_email_settings_1',
56		'type' => 'title',
57		),
58		array(
59		'id' => 'email_template',
60		'name' => esc_html__( 'Email Template', 'give' ),
61		'desc' => esc_html__( 'Choose your template from the available registered template types.', 'give' ),
62		'type' => 'select',
63		'options' => give_get_email_templates(),
64		),
65		array(
66		'id' => 'email_logo',
67		'name' => esc_html__( 'Logo', 'give' ),
68		'desc' => esc_html__( 'Upload or choose a logo to be displayed at the top of the donation receipt emails. Displayed on HTML emails only.', 'give' ),
69		'type' => 'file',
70		),
71		array(
72		'id' => 'from_name',
73		'name' => esc_html__( 'From Name', 'give' ),
74		'desc' => esc_html__( 'The name which appears in the "From" field in all Give donation emails.', 'give' ),
75		'default' => get_bloginfo( 'name' ),
76		'type' => 'text',
77		),
78		array(
79		'id' => 'from_email',
80		'name' => esc_html__( 'From Email', 'give' ),
81		'desc' => esc_html__( 'Email address from which all Give emails are sent from. This will act as the "from" and "reply-to" email address.', 'give' ),
82		'default' => get_bloginfo( 'admin_email' ),
83		'type' => 'text',
84		),
85		array(
86		'name' => esc_html__( 'Donation Notification Settings Docs Link', 'give' ),
87		'id' => 'donation_notification_settings_docs_link',
88		'url' => esc_url( 'http://docs.givewp.com/settings-donation-notification' ),
89		'title' => __( 'Donation Notification Settings', 'give' ),
90		'type' => 'give_docs_link',
91		),
92		array(
93		'id' => 'give_title_email_settings_3',
94		'type' => 'sectionend',
95		),
96		);
97		break;
98
99	View Code Duplication	case 'donor-email' :
		0 ignored issues – show Duplication introduced 2018-12-24 05:46 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
100		$settings = array(
101
102		// Section 1: Donor Email Notification Listing.
103		array(
104		'desc' => __( 'Email notifications sent from Give for donor are listed below. Click on an email to configure it.', 'give' ),
105		'type' => 'title',
106		'id' => 'give_donor_email_notification_settings',
107		'table_html' => false,
108		),
109		array(
110		'type' => 'email_notification',
111		),
112		array(
113		'type' => 'sectionend',
114		'id' => 'give_donor_email_notification_settings',
115		),
116
117		);
118		break;
119
120	View Code Duplication	case 'admin-email' :
		0 ignored issues – show Duplication introduced 2018-12-24 05:46 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
121		$settings = array(
122
123		// Section 1: Admin Email Notification Listing.
124		array(
125		'desc' => __( 'Email notifications sent from Give for admin are listed below. Click on an email to configure it.', 'give' ),
126		'type' => 'title',
127		'id' => 'give_admin_email_notification_settings',
128		'table_html' => false,
129		),
130		array(
131		'type' => 'email_notification',
132		),
133		array(
134		'type' => 'sectionend',
135		'id' => 'give_admin_email_notification_settings',
136		),
137
138		);
139		break;
140
141		case 'contact':
142		$settings = array(
143
144		array(
145		'id' => 'give_title_general_settings_5',
146		'type' => 'title'
147		),
148		array(
149		'name' => __( 'Admin Email Address', 'give' ),
150		'id' => "contact_admin_email",
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-07-09 06:21 UTC by Report Bug Copy Issue Report The string literal `contact_admin_email` 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...
151		'desc' => sprintf( '%1$s <code>{admin_email}</code> %2$s', __( 'By default, the', 'give' ), __( 'tag will use your WordPress admin email. If you would like to customize this address you can do so in the field above.', 'give' ) ),
152		'type' => 'text',
153		'default' => give_email_admin_email(),
154
155		),
156		array(
157		'name' => __( 'Offline Mailing Address', 'give' ),
158		'id' => "contact_offline_mailing_address",
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-07-09 06:21 UTC by Report Bug Copy Issue Report The string literal `contact_offline_mailing_address` 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...
159		'desc' => sprintf( '%1$s <code>{offline_mailing_address}</code> %2$s', __( 'Set the mailing address to where you would like your donors to send their offline donations. This will customize the', 'give' ), __( 'email tag for the Offline Donations payment gateway.', 'give' ) ),
160		'type' => 'wysiwyg',
161		'default' => '    <em>' . get_bloginfo( 'sitename' ) . '</em><br>    <em>111 Not A Real St.</em><br>    <em>Anytown, CA 12345 </em><br>',
		0 ignored issues – show introduced 2018-07-09 06:21 UTC by Report Bug Copy Issue Report Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'get_bloginfo' Loading history...
162		),
163		array(
164		'id' => 'give_title_general_settings_4',
165		'type' => 'sectionend'
166		)
167		);
168
169		break;
170		}// End switch().
171
172		/**
173		* Filter the emails settings.
174		* Backward compatibility: Please do not use this filter. This filter is deprecated in 1.8
175		*/
176		$settings = apply_filters( 'give_settings_emails', $settings );
177
178		/**
179		* Filter the settings.
180		*
181		* @since 1.8
182		*
183		* @param array $settings
184		*/
185		$settings = apply_filters( 'give_get_settings_' . $this->id, $settings );
186
187		// Output.
188		return $settings;
189		}
190
191		/**
192		* Get sections.
193		*
194		* @since 1.8
195		* @return array
196		*/
197		public function get_sections() {
198		$sections = array(
199		'donor-email' => esc_html__( 'Donor Emails', 'give' ),
200		'admin-email' => esc_html__( 'Admin Emails', 'give' ),
201		'email-settings' => esc_html__( 'Email Settings', 'give' ),
202		'contact' => esc_html__( 'Contact Information', 'give' ),
203		);
204
205		return apply_filters( 'give_get_sections_' . $this->id, $sections );
206		}
207
208		/**
209		* Render email_notification field type
210		*
211		* @since 2.0
212		* @access public
213		*/
214		public function email_notification_setting() {
215		// Load email notification table.
216		require_once GIVE_PLUGIN_DIR . 'includes/admin/emails/class-email-notification-table.php';
217
218		// Init table.
219		$email_notifications_table = new Give_Email_Notification_Table();
220
221		// Print table.
222		$email_notifications_table->prepare_items();
223		$email_notifications_table->display();
224		}
225
226		/**
227		* Output the settings.
228		*
229		* Note: if you want to overwrite this function then manage show/hide save button in your class.
230		*
231		* @since 1.8
232		* @return void
233		*/
234		public function output() {
235		if ( $this->enable_save ) {
236		$GLOBALS['give_hide_save_button'] = apply_filters( 'give_hide_save_button_on_email_admin_setting_page', false );
237		}
238
239		$settings = $this->get_settings();
240
241		Give_Admin_Settings::output_fields( $settings, 'give_settings' );
242		}
243		}
244
245		endif;
246
247		return new Give_Settings_Email();
248

ravinderk / Give

Give_Settings_Email::get_sections() A last analyzed 2019-03-08 02:52 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Give_Settings_Email::get_sections() A
last analyzed 2019-03-08 02:52 UTC