lightspeeddevelopment / lsx-currencies

classes/class-admin.php

<?php
/**
 * LSX Currency Admin Class
 *
 * @package   LSX Currencies
 * @author    LightSpeed
 * @license   GPL3
 * @link
 * @copyright 2019 LightSpeed
 */

namespace lsx\currencies\classes;

/**
 * Administration Class
 */
class Admin {

	/**
	 * Holds instance of the class
	 *
	 * @var object \lsx\currencies\classes\Admin()
	 */
	private static $instance;

	/**
	 * Constructor
	 */
	public function __construct() {

Expected 2 blank lines before function; 1 found

		add_action( 'admin_enqueue_scripts', array( $this, 'assets' ) );
		add_action( 'init', array( $this, 'create_settings_page' ), 100 );
		add_filter( 'lsx_framework_settings_tabs', array( $this, 'register_tabs' ), 100, 1 );
		add_filter( 'lsx_to_tour_custom_fields', array( $this, 'fields' ), 80, 1 );
		add_action( 'customize_register', array( $this, 'customize_register' ), 20 );
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Return an instance of this class.
	 *
	 * @return  object
	 */
	public static function init() {
		// If the single instance hasn't been set, set it now.
		if ( ! isset( self::$instance ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			self::$instance = new self();
		}

No blank line found after control structure

		return self::$instance;
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Enques the assets
	 */
	public function assets() {
		//wp_enqueue_script( 'lsx-currencies-admin', LSX_CURRENCIES_URL . 'assets/js/lsx-currencies-admin.min.js', array( 'jquery' ), LSX_CURRENCIES_VER, true );

No space found before comment text; expected "// wp_enqueue_script( 'lsx-currencies-admin', LSX_CURRENCIES_URL . 'assets/js/lsx-currencies-admin.min.js', array( 'jquery' ), LSX_CURRENCIES_VER, true );" but found "//wp_enqueue_script( 'lsx-currencies-admin', LSX_CURRENCIES_URL . 'assets/js/lsx-currencies-admin.min.js', array( 'jquery' ), LSX_CURRENCIES_VER, true );"

Inline comments must end in full-stops, exclamation marks, or question marks

		wp_enqueue_style( 'lsx-currencies-admin', LSX_CURRENCIES_URL . 'assets/css/lsx-currencies-admin.css', array(), LSX_CURRENCIES_VER );
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Returns the array of settings to the UIX Class
	 */
	public function create_settings_page() {
		if ( is_admin() ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			if ( ! class_exists( '\lsx\ui\uix' ) && ! function_exists( 'tour_operator' ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

				include_once LSX_CURRENCIES_PATH . 'vendor/uix/uix.php';
				$pages = $this->settings_page_array();
				$uix = \lsx\ui\uix::get_instance( 'lsx' );

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

				$uix->register_pages( $pages );
			}

No blank line found after control structure

			add_action( 'lsx_to_framework_dashboard_tab_content', array( $this, 'general_settings' ), 11, 1 );
			add_action( 'lsx_to_framework_api_tab_content', array( $this, 'api_settings' ), 11, 1 );

			add_action( 'lsx_framework_display_tab_content', array( $this, 'general_settings' ), 11, 1 );
			add_action( 'lsx_framework_api_tab_content', array( $this, 'api_settings' ), 11, 1 );
		}
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Returns the array of settings to the UIX Class
	 */
	public function settings_page_array() {
		$tabs = apply_filters( 'lsx_framework_settings_tabs', array() );

		return array(
			'settings'  => array(
				'page_title'  => esc_html__( 'Theme Options', 'lsx-currencies' ),
				'menu_title'  => esc_html__( 'Theme Options', 'lsx-currencies' ),
				'capability'  => 'manage_options',
				'icon'        => 'dashicons-book-alt',
				'parent'      => 'themes.php',
				'save_button' => esc_html__( 'Save Changes', 'lsx-currencies' ),
				'tabs'        => $tabs,
			),
		);
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**

Doc comment for parameter "$tabs" missing

	 * Register tabs
	 */
	public function register_tabs( $tabs ) {
		$default = true;

		if ( false !== $tabs && is_array( $tabs ) && count( $tabs ) > 0 ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$default = false;
		}

		if ( ! function_exists( 'tour_operator' ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			/*if ( ! array_key_exists( 'general', $tabs ) ) {

Block comment text must start on a new line

				$tabs['general'] = array(
					'page_title'        => '',
					'page_description'  => '',
					'menu_title'        => esc_html__( 'General', 'lsx-currencies' ),
					'template'          => LSX_CURRENCIES_PATH . 'includes/settings/general.php',
					'default'           => $default,
				);

				$default = false;
			}*/

			if ( ! array_key_exists( 'display', $tabs ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

				$tabs['display'] = array(
					'page_title'        => '',
					'page_description'  => '',
					'menu_title'        => esc_html__( 'Display', 'lsx-currencies' ),
					'template'          => LSX_CURRENCIES_PATH . 'includes/settings/display.php',
					'default'           => $default,
				);

				$default = false;
			}

			if ( ! array_key_exists( 'api', $tabs ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

				$tabs['api'] = array(
					'page_title'        => '',
					'page_description'  => '',
					'menu_title'        => esc_html__( 'API', 'lsx-currencies' ),
					'template'          => LSX_CURRENCIES_PATH . 'includes/settings/api.php',
					'default'           => $default,
				);

				$default = false;
			}
		}

		return $tabs;
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**

Doc comment for parameter "$tab" missing

	 * Outputs the dashboard tabs settings
	 *
	 * @param $tab string

Missing parameter name

	 * @return null

Function return type is not void, but function has no return statement

	 */
	public function general_settings( $tab = 'general' ) {
		if ( 'currency_switcher' === $tab ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$this->base_currency_field();
			$this->additional_currencies_field();
			$this->remove_decimals_field();
			if ( function_exists( 'tour_operator' ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

				$this->enable_multiple_prices_field();
				$this->enable_convert_to_single_currency_field();
			}
		}
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**

Doc comment for parameter "$tab" missing

	 * Outputs the dashboard tabs settings
	 *
	 * @param $tab string

Missing parameter name

	 * @return null

Function return type is not void, but function has no return statement

	 */
	public function api_settings( $tab = 'general' ) {
		if ( 'settings' === $tab ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$this->currency_api_heading();
			$this->api_key_field();
		}
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Outputs the base currency drop down
	 */
	public function base_currency_field() {
		?>
		<tr data-trigger="additional_currencies" class="lsx-select-trigger form-field-wrap">
			<th scope="row">
				<label for="currency">
				<?php
				esc_html_e( 'Base Currency', 'lsx-currencies' );
				?>
				</label>
			</th>
			<td>
				<?php
				if ( ! function_exists( 'WC' ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

					?>
					<select value="{{currency}}" name="currency">
						<?php
						foreach ( lsx_currencies()->available_currencies as $currency_id => $currency_label ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

							$selected = '';

							if ( lsx_currencies()->base_currency === $currency_id ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

								$selected = 'selected="selected"';
							}

No blank line found after control structure

							$allowed_html = array(
								'option' => array(
									'value' => array(),
									'selected' => array(),
								),
							);
							echo wp_kses( '<option value="' . $currency_id . '" ' . $selected . '>' . $currency_label . '</option>', $allowed_html );
						}
						?>
					</select>
					<?php
				} else {
					$currency_label = '';
					if ( isset( lsx_currencies()->available_currencies[ lsx_currencies()->base_currency ] ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

						$currency_label = lsx_currencies()->available_currencies[ lsx_currencies()->base_currency ];
					}
					?>
					<p><?php echo wp_kses_post( lsx_currencies()->get_currency_flag( lsx_currencies()->base_currency ) ); ?> <?php echo esc_attr( $currency_label ); ?></p>
					<p><small><?php esc_html_e( 'When WooCommerce is active, that currency is used as the base currency.', 'lsx-currencies' ); ?></small></p>
					<?php
				}
				?>
			</td>
		</tr>
		<?php
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Outputs the additional currencies checkboxes
	 */
	public function additional_currencies_field() {
		?>
		<tr data-trigger="currency" class="lsx-checkbox-action form-field-wrap">
			<th scope="row">
				<label for="modules">
				<?php
				esc_html_e( 'Additional Currencies', 'lsx-currencies' );
				?>
				</label>
			</th>
			<td>
				<ul>
					<?php
					foreach ( lsx_currencies()->available_currencies as $slug => $label ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

						$checked = '';
						$hidden  = $checked;
						if ( array_key_exists( $slug, lsx_currencies()->additional_currencies ) || lsx_currencies()->base_currency === $slug ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

								$checked = 'checked="checked"';
						}

						if ( lsx_currencies()->base_currency === $slug ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

								$hidden = 'style="display:none;" class="hidden"';
						}
						?>
							<li <?php echo wp_kses_post( $hidden ); ?>>
								<input type="checkbox" <?php echo esc_attr( $checked ); ?> data-name="additional_currencies" data-value="<?php echo esc_attr( $slug ); ?>" name="additional_currencies[<?php echo esc_attr( $slug ); ?>]" /> <label for="additional_currencies"><?php echo wp_kses_post( lsx_currencies()->get_currency_flag( $slug ) . $label ); ?></label>
							</li>
							<?php
					}
					?>
				</ul>
			</td>
		</tr>
		<?php
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Outputs the multiple prices checkbox
	 */
	public function remove_decimals_field() {
		?>
		<tr class="form-field">
			<th scope="row">
				<label for="remove_decimals"><?php esc_html_e( 'Remove Decimals', 'lsx-currencies' ); ?></label>
			</th>
			<td>
				<input type="checkbox" {{#if remove_decimals}} checked="checked" {{/if}} name="remove_decimals" />
				<small><?php esc_html_e( 'Round down the amount to the nearest full value.', 'lsx-currencies' ); ?></small>
			</td>
		</tr>
		<?php
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Outputs the multiple prices checkbox
	 */
	public function enable_multiple_prices_field() {
		?>
		<tr class="form-field">
			<th scope="row">
				<label for="multi_price"><?php esc_html_e( 'Enable Multiple Prices', 'lsx-currencies' ); ?></label>
			</th>
			<td>
				<input type="checkbox" {{#if multi_price}} checked="checked" {{/if}} name="multi_price" />
				<small><?php esc_html_e( 'Allowing you to add specific prices per active currency.', 'lsx-currencies' ); ?></small>
			</td>
		</tr>
		<?php
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Outputs the multiple prices checkbox
	 */
	public function enable_convert_to_single_currency_field() {
		?>
		<tr class="form-field">
			<th scope="row">
				<label for="convert_to_single_currency"><?php esc_html_e( 'Enable Convert to Single Currency', 'lsx-currencies' ); ?></label>
			</th>
			<td>
				<input type="checkbox" {{#if convert_to_single_currency}} checked="checked" {{/if}} name="convert_to_single_currency" />
				<small><?php esc_html_e( 'This will convert all prices added to the base currency, the currency switcher will not work.', 'lsx-currencies' ); ?></small>
			</td>
		</tr>
		<?php
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Outputs the currency heading
	 */
	public function currency_api_heading() {
		?>
		<tr class="form-field banner-wrap">
			<th class="table_heading" style="padding-bottom:0px;" scope="row" colspan="2">
				<h4 style="margin-bottom:0px;"><?php esc_html_e( 'Openexchange API', 'lsx-currencies' ); ?></h4>
			</th>
		</tr>
		<?php
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Outputs the api key text field
	 */
	public function api_key_field() {
		?>
		<tr class="form-field">
			<th scope="row">
				<i class="dashicons-before dashicons-admin-network"></i><label for="openexchange_api"> <?php esc_html_e( 'Key', 'to-maps' ); ?></label>
			</th>
			<td>
				<input type="text" {{#if openexchange_api}} value="{{openexchange_api}}" {{/if}} name="openexchange_api" />
				<br /><small><?php esc_html_e( 'Get your API key here', 'lsx-currencies' ); ?> - <a target="_blank" rel="noopener noreferrer" href="https://openexchangerates.org/signup/free">openexchangerates.org</a></small>
			</td>
		</tr>
		<?php
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**

Doc comment for parameter "$meta_boxes" missing

	 *  adds in our multiple prices field

Doc comment short description must start with a capital letter

	 */
	public function fields( $meta_boxes ) {
		if ( true === lsx_currencies()->multi_prices && ! empty( lsx_currencies()->additional_currencies ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$currency_options = array();

			foreach ( lsx_currencies()->additional_currencies as $key => $values ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

				if ( lsx_currencies()->base_currency === $key ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

					continue;
				}

				$currency_options[ $key ] = lsx_currencies()->available_currencies[ $key ];
			}

			$new_boxes = array();
			$injected = false;

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

			if ( ! empty( $meta_boxes ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

				foreach ( $meta_boxes as $meta_box ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

					if ( 'price' === $meta_box['id'] ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

						$new_boxes[] = array(
							'id' => 'price',
							'name' => 'Base Price (' . lsx_currencies()->base_currency . ')',
							'type' => 'text',
						);
						$new_boxes[] = array(
							'id' => 'additional_prices',
							'name' => '',
							'single_name' => 'Price',
							'type' => 'group',
							'repeatable' => true,
							'sortable' => true,
							'fields' => array(
								array(
									'id' => 'amount',
									'name' => 'Amount',
									'type' => 'text',
								),
								array(
									'id' => 'currency',
									'name' => 'Currency',
									'type' => 'select',
									'options' => $currency_options,
								),
							),
						);
						$injected = true;

Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

						continue;
					}

No blank line found after control structure

					$new_boxes[] = $meta_box;
				}
			}

No blank line found after control structure

			if ( true === $injected ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

				$meta_boxes = $new_boxes;
			}
		}

No blank line found after control structure

		return $meta_boxes;
	}

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

	/**

Doc comment for parameter "$wp_customize" missing

	 * Customizer Controls and Settings.
	 *
	 * @since 1.1.1
	 */
	public function customize_register( $wp_customize ) {
		/**
		 * Panel.
		 */
		$wp_customize->add_panel( 'lsx_currencies', array(

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			'priority'          => 62,
			'capability'        => 'edit_theme_options',
			'theme_supports'    => '',
			'title'             => esc_html__( 'Currencies', 'lsx-currencies' ),
			'description'       => esc_html__( 'LSX Currencies extension settings.', 'lsx-currencies' ),
		) );

For multi-line function calls, the closing parenthesis should be on a new line.

		/**
		 * Section.
		 */

		$wp_customize->add_section( 'lsx_currencies_display', array(

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			'title'       => esc_html__( 'Display', 'lsx-currencies' ),
			'description' => esc_html__( 'LSX Currencies extension display settings.', 'lsx-currencies' ),
			'panel'       => 'lsx_currencies',
			'priority'    => 1,
		) );

For multi-line function calls, the closing parenthesis should be on a new line.

		/**
		 * Fields.
		 */

		$wp_customize->add_setting( 'lsx_currencies_currency_menu_position', array(

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			'default' => '',
			'sanitize_callback' => array( '\lsx\currencies\classes\Currencies', 'sanitize_select' ),
		) );

For multi-line function calls, the closing parenthesis should be on a new line.

		$choices = array(
			'' => esc_html__( 'None', 'lsx-currencies' ),
		);

		$menus = get_registered_nav_menus();

		if ( is_array( $menus ) && ! empty( $menus ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$choices = array_merge( $choices, $menus );
		}

		$wp_customize->add_control( new \WP_Customize_Control( $wp_customize, 'lsx_currencies_currency_menu_position', array(

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			'label'       => esc_html__( 'Display in Menu', 'lsx-currencies' ),
			'description' => esc_html__( 'Select the menu to display the currency menu switcher.', 'lsx-currencies' ),
			'section'     => 'lsx_currencies_display',
			'settings'    => 'lsx_currencies_currency_menu_position',
			'type'        => 'select',
			'priority'    => 1,
			'choices'     => $choices,
		) ) );

For multi-line function calls, the closing parenthesis should be on a new line.

		$wp_customize->add_setting( 'lsx_currencies_display_flags', array(

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			'default'           => false,
			'sanitize_callback' => array( '\lsx\currencies\classes\Currencies', 'sanitize_checkbox' ),
		) );

For multi-line function calls, the closing parenthesis should be on a new line.

		$wp_customize->add_control( new \WP_Customize_Control( $wp_customize, 'lsx_currencies_display_flags', array(

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			'label'       => esc_html__( 'Display Flags', 'lsx-currencies' ),
			'description' => esc_html__( 'Displays a small flag in front of the name.', 'lsx-currencies' ),
			'section'     => 'lsx_currencies_display',
			'settings'    => 'lsx_currencies_display_flags',
			'type'        => 'checkbox',
			'priority'    => 2,
		) ) );

For multi-line function calls, the closing parenthesis should be on a new line.

		$wp_customize->add_setting( 'lsx_currencies_flag_position', array(

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			'default'           => 'left',
			'sanitize_callback' => array( '\lsx\currencies\classes\Currencies', 'sanitize_select' ),
		) );

For multi-line function calls, the closing parenthesis should be on a new line.

		$wp_customize->add_control( new \WP_Customize_Control( $wp_customize, 'lsx_currencies_flag_position', array(

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			'label'       => esc_html__( 'Flag Position', 'lsx-currencies' ),
			'description' => esc_html__( 'This moves the flag to the right (after the symbol).', 'lsx-currencies' ),
			'section'     => 'lsx_currencies_display',
			'settings'    => 'lsx_currencies_flag_position',
			'type'        => 'select',
			'priority'    => 3,
			'choices'     => array(
				'left' => esc_html__( 'Left', 'lsx-currencies' ),
				'right' => esc_html__( 'Right', 'lsx-currencies' ),
			),
		) ) );

For multi-line function calls, the closing parenthesis should be on a new line.

		$wp_customize->add_setting( 'lsx_currencies_currency_switcher_position', array(

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			'default'           => 'right',
			'sanitize_callback' => array( '\lsx\currencies\classes\Currencies', 'sanitize_select' ),
		) );

For multi-line function calls, the closing parenthesis should be on a new line.

		$wp_customize->add_control( new \WP_Customize_Control( $wp_customize, 'lsx_currencies_currency_switcher_position', array(

The opening parenthesis of a multi-line function call should be the last content on the line.

For multi-line function calls, each argument should be on a separate line.

			'label'       => esc_html__( 'Symbol Position', 'lsx-currencies' ),
			'description' => esc_html__( 'This moves the symbol for the switcher to the left (before the flag).', 'lsx-currencies' ),
			'section'     => 'lsx_currencies_display',
			'settings'    => 'lsx_currencies_currency_switcher_position',
			'type'        => 'select',
			'priority'    => 4,
			'choices'     => array(
				'left' => esc_html__( 'Left', 'lsx-currencies' ),
				'right' => esc_html__( 'Right', 'lsx-currencies' ),
			),
		) ) );

For multi-line function calls, the closing parenthesis should be on a new line.

	}

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

}