Give_Settings_General

Complexity

Total Complexity

20

Size/Duplication

Total Lines	511
Duplicated Lines	5.48 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	2
C	get_settings()	0	384	9
A	get_sections()	0	10	1
A	__give_change_donation_stating_number()	0	21	4
A	__render_give_sequential_donation_code_preview()	14	14	2
A	__render_give_unlock_all_settings()	14	14	2

<?php
/**
 * Give Settings Page/Tab
 *
 * @package     Give
 * @subpackage  Classes/Give_Settings_General
 * @copyright   Copyright (c) 2016, WordImpress
 * @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_General' ) ) :

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

		/**
		 * Constructor.
		 */
		public function __construct() {
			$this->id    = 'general';
			$this->label = __( 'General', 'give' );

			$this->default_tab = 'general-settings';

			if ( $this->id === give_get_current_setting_tab() ) {
				add_action( 'give_save_settings_give_settings', array( $this, '__give_change_donation_stating_number' ), 10, 3 );
				add_action( 'give_admin_field_give_sequential_donation_code_preview', array( $this, '__render_give_sequential_donation_code_preview' ), 10, 3 );
				add_action( 'give_admin_field_give_unlock_all_settings', array( $this, '__render_give_unlock_all_settings' ), 10, 3 );
			}

			parent::__construct();
		}

		/**
		 * 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 'access-control':
					$settings = array(
						// Section 3: Access control.
						array(
							'id'   => 'give_title_session_control_1',
							'type' => 'title',
						),
						array(
							'id'      => 'session_lifetime',
							'name'    => __( 'Session Lifetime', 'give' ),
							'desc'    => __( 'The length of time a user\'s session is kept alive. Give starts a new session per user upon donation. Sessions allow donors to view their donation receipts without being logged in.', 'give' ),
							'type'    => 'select',
							'options' => array(
								'86400'  => __( '24 Hours', 'give' ),
								'172800' => __( '48 Hours', 'give' ),
								'259200' => __( '72 Hours', 'give' ),
								'604800' => __( '1 Week', 'give' ),
							),
						),
						array(
							'id'         => 'limit_display_donations',
							'name'       => __( 'Limit Donations Displayed', 'give' ),
							'desc'       => __( 'Adjusts the number of donations displayed to a non logged-in user when they attempt to access the Donation History page without an active session. For security reasons, it\'s best to leave this at 1-3 donations.', 'give' ),
							'default'    => '1',
							'type'       => 'number',
							'css'        => 'width:50px;',
							'attributes' => array(
								'min' => '1',
								'max' => '10',
							),
						),
						array(
							'name'    => __( 'Email Access', 'give' ),
							'desc'    => __( 'Would you like your donors to be able to access their donation history using only email? Donors whose sessions have expired and do not have an account may still access their donation history via a temporary email access link.', 'give' ),
							'id'      => 'email_access',
							'type'    => 'radio_inline',
							'default' => 'disabled',
							'options' => array(
								'enabled'  => __( 'Enabled', 'give' ),
								'disabled' => __( 'Disabled', 'give' ),
							),
						),
						array(
							'name'    => __( 'Enable reCAPTCHA', 'give' ),
							'desc'    => __( 'Would you like to enable the reCAPTCHA feature?', 'give' ),
							'id'      => 'enable_recaptcha',
							'type'    => 'radio_inline',
							'default' => 'disabled',
							'options' => array(
								'enabled'  => __( 'Enabled', 'give' ),
								'disabled' => __( 'Disabled', 'give' ),
							),
						),
						array(
							'id'      => 'recaptcha_key',
							'name'    => __( 'reCAPTCHA Site Key', 'give' ),
							/* translators: %s: https://www.google.com/recaptcha/ */
							'desc'    => sprintf( __( 'If you would like to prevent spam on the email access form navigate to <a href="%s" target="_blank">the reCAPTCHA website</a> and sign up for an API key and paste your reCAPTCHA site key here. The reCAPTCHA uses Google\'s user-friendly single click verification method.', 'give' ), esc_url( 'http://docs.givewp.com/recaptcha' ) ),
							'default' => '',
							'type'    => 'text',
						),
						array(
							'id'      => 'recaptcha_secret',
							'name'    => __( 'reCAPTCHA Secret Key', 'give' ),
							'desc'    => __( 'Please paste the reCAPTCHA secret key here from your  reCAPTCHA API Keys panel.', 'give' ),
							'default' => '',
							'type'    => 'text',
						),
						array(
							'name'  => __( 'Access Control Docs Link', 'give' ),
							'id'    => 'access_control_docs_link',
							'url'   => esc_url( 'http://docs.givewp.com/settings-access-control' ),
							'title' => __( 'Access Control', 'give' ),
							'type'  => 'give_docs_link',
						),
						array(
							'id'   => 'give_title_session_control_1',
							'type' => 'sectionend',
						),
					);
					break;

				case 'currency-settings' :
					$currency_position_before = __( 'Before - %s&#x200e;10', 'give' );
					$currency_position_after  = __( 'After - 10%s&#x200f;', 'give' );

					$settings = array(
						// Section 2: Currency
						array(
							'type' => 'title',
							'id'   => 'give_title_general_settings_2',
						),
						array(
							'name' => __( 'Currency Settings', 'give' ),
							'desc' => '',
							'type' => 'give_title',
							'id'   => 'give_title_general_settings_2',
						),
						array(
							'name'    => __( 'Currency', 'give' ),
							'desc'    => __( 'The donation currency. Note that some payment gateways have currency restrictions.', 'give' ),
							'id'      => 'currency',
							'class'   => 'give-select-chosen',
							'type'    => 'select',
							'options' => give_get_currencies(),
							'default' => 'USD',
						),
						array(
							'name'       => __( 'Currency Position', 'give' ),
							'desc'       => __( 'The position of the currency symbol.', 'give' ),
							'id'         => 'currency_position',
							'type'       => 'select',
							'options'    => array(
								/* translators: %s: currency symbol */
								'before' => sprintf( $currency_position_before, give_currency_symbol( give_get_currency() ) ),
								/* translators: %s: currency symbol */
								'after'  => sprintf( $currency_position_after, give_currency_symbol( give_get_currency() ) ),
							),
							'default'    => 'before',
							'attributes' => array(
								'data-before-template' => sprintf( $currency_position_before, '{currency_pos}' ),
								'data-after-template'  => sprintf( $currency_position_after, '{currency_pos}' ),
							),
						),
						array(
							'name'    => __( 'Thousands Separator', 'give' ),
							'desc'    => __( 'The symbol (typically , or .) to separate thousands.', 'give' ),
							'id'      => 'thousands_separator',
							'type'    => 'text',
							'default' => ',',
							'css'     => 'width:12em;',
						),
						array(
							'name'    => __( 'Decimal Separator', 'give' ),
							'desc'    => __( 'The symbol (usually , or .) to separate decimal points.', 'give' ),
							'id'      => 'decimal_separator',
							'type'    => 'text',
							'default' => '.',
							'css'     => 'width:12em;',
						),
						array(
							'name'    => __( 'Number of Decimals', 'give' ),
							'desc'    => __( 'The number of decimal points displayed in amounts.', 'give' ),
							'id'      => 'number_decimals',
							'type'    => 'text',
							'default' => 2,
							'css'     => 'width:12em;',
						),
						array(
							'name'  => __( 'Currency Options Docs Link', 'give' ),
							'id'    => 'currency_settings_docs_link',
							'url'   => esc_url( 'http://docs.givewp.com/settings-currency' ),
							'title' => __( 'Currency Settings', 'give' ),
							'type'  => 'give_docs_link',
						),
						array(
							'type' => 'sectionend',
							'id'   => 'give_title_general_settings_2',
						),
					);

					break;

				case 'general-settings':
					// Get default country code.
					$countries = give_get_country();

					// get the list of the states of which default country is selected.
					$states = give_get_states( $countries );

					// Get the country list that does not have any states init.
					$no_states_country = give_no_states_country_list();

					$states_label = give_get_states_label();
					$country      = give_get_country();
					$label        = __( 'State', 'give' );
					// Check if $country code exists in the array key for states label.
					if ( array_key_exists( $country, $states_label ) ) {
						$label = $states_label[ $country ];
					}

Functions must not contain multiple empty lines in a row; found 2 empty lines

					$settings = array(
						// Section 1: General.
						array(
							'type' => 'title',
							'id'   => 'give_title_general_settings_1',
						),
						array(
							'name' => __( 'General Settings', 'give' ),
							'desc' => '',
							'type' => 'give_title',
							'id'   => 'give_title_general_settings_1',
						),
						array(
							'name'       => __( 'Success Page', 'give' ),
							/* translators: %s: [give_receipt] */
							'desc'       => sprintf( __( 'The page donors are sent to after completing their donations. The %s shortcode should be on this page.', 'give' ), '<code>[give_receipt]</code>' ),
							'id'         => 'success_page',
							'class'      => 'give-select give-select-chosen',
							'type'       => 'select',
							'options'    => give_cmb2_get_post_options( array(
								'post_type'   => 'page',
								'numberposts' => 30,
							) ),
							'attributes' => array(
								'data-search-type' => 'pages'

Each line in an array declaration must end in a comma

							)
						),
						array(
							'name'       => __( 'Failed Donation Page', 'give' ),
							'desc'       => __( 'The page donors are sent to if their donation is cancelled or fails.', 'give' ),
							'class'      => 'give-select give-select-chosen',
							'id'         => 'failure_page',
							'type'       => 'select',
							'options'    => give_cmb2_get_post_options( array(
								'post_type'   => 'page',
								'numberposts' => 30,
							) ),
							'attributes' => array(
								'data-search-type' => 'pages'

Each line in an array declaration must end in a comma

							)
						),
						array(
							'name'       => __( 'Donation History Page', 'give' ),
							/* translators: %s: [donation_history] */
							'desc'       => sprintf( __( 'The page showing a complete donation history for the current user. The %s shortcode should be on this page.', 'give' ), '<code>[donation_history]</code>' ),
							'id'         => 'history_page',
							'class'      => 'give-select give-select-chosen',
							'type'       => 'select',
							'options'    => give_cmb2_get_post_options( array(
								'post_type'   => 'page',
								'numberposts' => 30,
							) ),
							'attributes' => array(
								'data-search-type' => 'pages'

Each line in an array declaration must end in a comma

							)
						),
						array(
							'name'       => __( 'Base Country', 'give' ),
							'desc'       => __( 'The country your site operates from.', 'give' ),
							'id'         => 'base_country',
							'type'       => 'select',
							'options'    => give_get_country_list(),
							'class'      => 'give-select give-select-chosen',
							'attributes' => array(
								'data-search-type' => 'no_ajax'

Each line in an array declaration must end in a comma

							),
							'default'    => $country,
						),
						/**
						 * Add base state to give setting
						 *
						 * @since 1.8.14
						 */
						array(
							'wrapper_class' => ( array_key_exists( $countries, $no_states_country ) ? 'give-hidden' : '' ),
							'name'          => __( 'Base State/Province', 'give' ),
							'desc'          => __( 'The state/province your site operates from.', 'give' ),
							'id'            => 'base_state',
							'type'          => ( empty( $states ) ? 'text' : 'select' ),
							'class'         => ( empty( $states ) ? '' : 'give-select give-select-chosen' ),
							'options'       => $states,
							'attributes'    => array(
								'data-search-type' => 'no_ajax',
								'data-placeholder' => $label,
							),
						),
						array(
							'name'  => __( 'General Options Docs Link', 'give' ),
							'id'    => 'general_options_docs_link',
							'url'   => esc_url( 'http://docs.givewp.com/settings-general' ),
							'title' => __( 'General Options', 'give' ),
							'type'  => 'give_docs_link',
						),
						array(
							'type' => 'sectionend',
							'id'   => 'give_title_general_settings_1',
						),
					);
					break;

				case 'sequential-ordering':
					$settings = array(

						// Section 4: Sequential Ordering

						array(
							'id'   => 'give_title_general_settings_4',
							'type' => 'title'

Each line in an array declaration must end in a comma

						),
						array(
							'name'    => __( 'Sequential Ordering', 'give' ),
							'id'      => "{$current_section}_status",
							'desc'    => __( 'Custom donation numbering that increases sequentially to prevent gaps between donation IDs. If disabled, then donation numbers are generated from WordPress post IDs, which will result in gaps between numbers.', 'give' ),
							'type'    => 'radio_inline',
							'default' => 'disabled',
							'options' => array(
								'enabled'  => __( 'Enabled', 'give' ),
								'disabled' => __( 'Disabled', 'give' )
							)
						),
						array(
							'name' => __( 'Next Donation Number', 'give' ),
							'id'   => "{$current_section}_number",
							'desc' => sprintf(
								__( 'The number used to generate the next donation ID. This value must be greater than or equal to %s to avoid conflicts with existing donation IDs.', 'give' ),
								'<code>' . Give()->seq_donation_number->get_next_number() . '</code>'

Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'Give'

							),
							'type' => 'number',
						),
						array(
							'name' => __( 'Number Prefix', 'give' ),
							'id'   => "{$current_section}_number_prefix",
							'desc' => sprintf(
								__( 'The prefix appended to all sequential donation numbers. Spaces are replaced by %s.', 'give' ),
								'<code>-</code>'
							),
							'type' => 'text',
						),
						array(
							'name' => __( 'Number Suffix', 'give' ),
							'id'   => "{$current_section}_number_suffix",
							'desc' => sprintf(
								__( 'The suffix appended to all sequential donation numbers. Spaces are replaced by %s.', 'give' ),
								'<code>-</code>'
							),
							'type' => 'text',
						),
						array(
							'name'    => __( 'Number Padding', 'give' ),
							'id'      => "{$current_section}_number_padding",
							'desc'    => sprintf(
								__( 'The minimum number of digits in the sequential donation number. Enter %s to display %s as %s.', 'give' ),
								'<code>4</code>',
								'<code>1</code>',
								'<code>0001</code>'
							),
							'type'    => 'number',
							'default' => '0',
						),
						array(
							'name' => __( 'Donation ID Preview', 'give' ),
							'id'   => "{$current_section}_preview",
							'type' => 'give_sequential_donation_code_preview',
							'desc' => __( 'A preview of the next sequential donation ID. This preview cannot be edited directly as it is generated from the settings above.', 'give' ),
						),
						array(
							'name'  => __( 'Sequential Ordering Docs Link', 'give' ),
							'id'    => "{$current_section}_doc link",
							'url'   => esc_url( 'http://docs.givewp.com/settings-sequential-ordering' ),
							'title' => __( 'Sequential Ordering', 'give' ),
							'type'  => 'give_docs_link',
						),
						array(
							'id'   => 'give_title_general_settings_4',
							'type' => 'sectionend'

Each line in an array declaration must end in a comma

						)

Comma required after last value in array declaration

					);
			}

			/**
			 * Filter the general settings.
			 * Backward compatibility: Please do not use this filter. This filter is deprecated in 1.8
			 */
			$settings = apply_filters( 'give_settings_general', $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(
				'general-settings'    => __( 'General', 'give' ),
				'currency-settings'   => __( 'Currency', 'give' ),
				'access-control'      => __( 'Access Control', 'give' ),
				'sequential-ordering' => __( 'Sequential Ordering', 'give' ),
			);

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


		/**
		 * Set flag to reset sequestion donation number starting point when "Sequential Starting Number" value changes
		 *
		 * @since  2.1
		 * @access public
		 *
		 * @param $update_options
		 * @param $option_name
		 * @param $old_options
		 *
		 * @return bool
		 */
		public function __give_change_donation_stating_number( $update_options, $option_name, $old_options ) {

Method name "Give_Settings_General::__give_change_donation_stating_number" is invalid; only PHP magic methods should be prefixed with a double underscore

			if ( ! isset( $_POST['sequential-ordering_number'] ) ) {

Detected access of super global var $_POST, probably need manual inspection.

				return false;
			}

			if ( ( $next_number = Give()->seq_donation_number->get_next_number() ) > $update_options['sequential-ordering_number'] ) {
				give_update_option( 'sequential-ordering_number', $next_number );

				Give_Admin_Settings::add_error(
					'give-invalid-sequential-starting-number',
					sprintf(
						__( 'Next Donation Number must be equal to or larger than %s to avoid conflicts with existing donation IDs.', 'give' ),
						$next_number
					)
				);
			} elseif ( $update_options['sequential-ordering_number'] !== $old_options['sequential-ordering_number'] ) {
				update_option( '_give_reset_sequential_number', 1, false );
			}

			return true;
		}


		/**
		 * Render give_sequential_donation_code_preview field type
		 *
		 * @since  2.1.0
		 * @access public
		 *
		 * @param $field
		 */
		public function __render_give_sequential_donation_code_preview( $field ) {

This method seems to be duplicated in your project.

Method name "Give_Settings_General::__render_give_sequential_donation_code_preview" is invalid; only PHP magic methods should be prefixed with a double underscore

			?>
			<tr valign="top" <?php echo ! empty( $field['wrapper_class'] ) ? 'class="' . $field['wrapper_class'] . '"' : '' ?>>

Expected next thing to be a escaping function, not '!'

Expected next thing to be a escaping function, not '$field'

				<th scope="row" class="titledesc">
					<label
						for="<?php echo esc_attr( $field['id'] ); ?>"><?php echo esc_html( $field['name'] ) ?></label>
				</th>
				<td class="give-forminp">
					<input id="<?php echo esc_attr( $field['id'] ); ?>" class="give-input-field" type="text" disabled>
					<?php echo Give_Admin_Settings::get_field_description( $field ); ?>

Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'Give_Admin_Settings'

				</td>
			</tr>
			<?php
		}


		/**
		 * Render give_unlock_all_settings field type
		 *
		 * @since  2.1.0
		 * @access public
		 *
		 * @param $field
		 */
		public function __render_give_unlock_all_settings( $field ) {

This method seems to be duplicated in your project.

Method name "Give_Settings_General::__render_give_unlock_all_settings" is invalid; only PHP magic methods should be prefixed with a double underscore

			?>
			<tr valign="top" <?php echo ! empty( $field['wrapper_class'] ) ? 'class="' . $field['wrapper_class'] . '"' : '' ?>>

Expected next thing to be a escaping function, not '!'

Expected next thing to be a escaping function, not '$field'

				<th scope="row" class="titledesc">
					<label
						for="<?php echo esc_attr( $field['id'] ); ?>"><?php echo esc_html( $field['name'] ) ?></label>
				</th>
				<td class="give-forminp">
					<?php echo Give_Admin_Settings::get_field_description( $field ); ?>

Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw 'Give_Admin_Settings'

					<a href="" id="<?php echo $field['id']; ?>" data-message="<?php echo $field['confirmation_msg'] ?>"><?php echo __( 'Unlock all settings', 'give' ); ?></a>

Expected next thing to be a escaping function, not '$field'

Expected a sanitizing function (see Codex for 'Data Validation'), but instead saw '__'

				</td>
			</tr>
			<?php
		}
	}

endif;

return new Give_Settings_General();