Settings::short_field() - Code Metrics - Inspection of "1.5.0 pre-release" - unfulvio/wp-php-console - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 475e64...ab1972 )

by Fulvio
created 2016-05-29 00:07 UTC
Settings::short_field() A

↳ Parent: Settings
Complexity

Conditions	1
Paths	1
Size

Total Lines	16
Code Lines	12
Duplication

Lines	16
Ratio	100 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
c	1
b	0
f	0
dl	16
loc	16
rs	9.4285
cc	1
eloc	12
nc	1
nop	0
<?php

/**
 * WP PHP Console Plugin Settings Class
 *
 * @link    https://github.com/unfulvio/wp-php-console
 * @since   1.0.0
 * @package WP_PHP_Console
 */
namespace WP_PHP_Console;

defined( 'ABSPATH' ) or exit;
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);

/**
 * WP PHP Console settings class.
 *
 * @since   1.5.0
 * @package WP_PHP_Console
 */
class Settings {


	/**
	 * This plugin's settings page slug.
	 *
	 * @since  1.5.0
	 * @access private
	 * @var    string
	 */
	private $page = '';


	/**
	 * This plugin's option name.
	 *
	 * @since  1.5.0
	 * @access private
	 * @var    string
	 */
	private $option = '';

	/**
	 * This plugin's settings options.
	 *
	 * @since  1.5.0
	 * @access private
	 * @var    array $options Array of this plugin settings options.
	 */
	private $options = array();


	/**
	 * Register settings and admin menu.
	 *
	 * @since 1.5.0
	 * @param array $options Plugin settings options.
	 */
	public function __construct( array $options ) {

		$this->page    = sanitize_title( strtolower( Plugin::NAME ) );
		$this->option  = str_replace( '-', '_', $this->page );
		$this->options = $options;

		add_action( 'admin_menu', array( $this, 'register_settings_page' ) );

	}


	/**
	 * Plugin Settings menu.
	 *
	 * @since 1.5.0
	 */
	public function register_settings_page() {

		add_options_page(
			__( 'WP PHP Console', 'wp-php-console' ),
			__( 'WP PHP Console', 'wp-php-console' ),
			'manage_options',
			$this->page,
			array( $this, 'settings_page' )
		);

		add_action( 'admin_init', array( $this, 'register_settings'  ) );

	}


	/**
	 * Register plugin settings.
	 *
	 * @since 1.5.0
	 */
	public function register_settings() {

		register_setting(
			$this->option,
			$this->option,
			array( $this, 'sanitize_field' )
		);

		add_settings_section(
			$this->option,
			__( 'Settings', 'wp-php-console' ),
			array( $this, 'settings_info' ),
			$this->page
		);

		$settings_fields = array(
			'password' => array(
				 'label'    => esc_html__( 'Password',           'wp-php-console' ),
				 'callback' => array( $this, 'password_field' ),
			),
			'ssl'      => array(
				 'label'    => esc_html__( 'Allow only on SSL',  'wp-php-console' ),
				 'callback' => array( $this, 'ssl_field' ),
			),
			'ip' => array(
				 'label'    => esc_html__( 'Allowed IP Masks',   'wp-php-console' ),
				 'callback' => array( $this, 'ip_field' ),
			),
			'register' => array(
				 'label'    => esc_html__( 'Register PC Class ', 'wp-php-console' ),
				 'callback' => array( $this, 'register_field' ),
			),
			'stack'    => array(
				 'label'    => esc_html__( 'Show Call Stack',    'wp-php-console' ),
				 'callback' => array( $this, 'stack_field' ),
			),
			'short'    => array(
				 'label'    => esc_html__( 'Short Path Names',   'wp-php-console' ),
				 'callback' => array( $this, 'short_field' ),
			),
		);

		foreach ( $settings_fields as $key => $field ) {
			add_settings_field(
				$this->page . '['. $key . ']',
				$field['label'],
				$field['callback'],
				$this->page,
				$this->option
			);
		}

	}


	/**
	 * Settings page additional info.
	 * Prints more details on the plugin settings page.
	 *
	 * @since 1.5.0
	 */
	public function settings_info() {

		?>
		<p><?php
			/* translators: %s refers to 'PHP Console' Chrome extension, will print download link for the Chrome extension */
			printf( _x( 'This plugin allows you to use %s within your WordPress installation for testing, debugging and development purposes.', 'PHP Console, the Chrome Extension', 'wp-php-console' ), '<a href="https://github.com/barbushin/php-console" target="_blank">PHP Console</a>' ); ?>
			<br><?php esc_html_e( 'Usage instructions:', 'wp-php-console' ); ?>
		</p>
		<ol>
			<?php

			$instructions = array(
				/* translators: Install PHP Console extension for Google Chrome download link */
				sprintf( _x( 'Make sure you have downloaded and installed %s.', 'PHP Console, the Chrome Extension', 'wp-php-console' ),
					'<a target="_blank" href="https://chrome.google.com/webstore/detail/php-console/nfhmhhlpfleoednkpnnnkolmclajemef">PHP Console extension for Google Chrome</a>'
				),
				esc_html__( 'Set a password for the eval terminal in the options below and hit "Save Changes".', 'wp-php-console' ),
				esc_html__( 'Reload any page of your installation and click on the key icon in your Chrome browser address bar, enter your password and access the terminal.', 'wp-php-console' ),
				esc_html__( 'From the eval terminal you can execute any PHP or WordPress specific function, including functions from your plugins and active theme.', 'wp-php-console' ),
				/* translators: %1$s - PHP code snippet example, %2$s - Chrome javascript console shortcut */
				sprintf( __( 'In your PHP code, you can call PHP Console debug statements like %1$s to display PHP variables in the browser\'s JavaScript-console (e.g. %2$s) and optionally filter selected tags through the browser\'s Remote PHP Eval Terminal screen\'s "Ignore Debug options".', 'wp-php-console' ),
					'<code>debug(&#36;var, &#36;tag)</code>',
					'<code>CTRL+SHIFT+J</code>'
				),
			);

			foreach ( $instructions as $list_item ) {
				echo '<li>' . $list_item  . '</li>';
			}

			?>
		</ol>
		<hr>
		<?php

	}


	/**
	 * Settings Page Password field.
	 *
	 * @since 1.5.0
	 */
	public function password_field() {

		?>
		<input type="password" id="wp-php-console-password" name="wp_php_console[password]" value="<?php echo esc_attr( $this->options['password'] ); ?>">
		<label for="wp-php-console-password"><?php esc_html_e( 'Required', 'wp-php-console' ); ?></label><br>
		<p class="description"><?php esc_html_e( 'The password for the eval terminal. If empty, the plugin will not work.', 'wp-php-console' ); ?></p>
		<?php

	}


	/**
	 * Settings Page SSL option field.
	 *
	 * @since 1.5.0
	 */
	public function ssl_field() {


		?>
		<input type="checkbox" id="wp-php-console-ssl" name="wp_php_console[ssl]" value="1" <?php checked( (bool) $this->options['ssl'] ); ?> />
		<label for="wp-php-console-ssl"><?php esc_html_e( 'Yes', 'wp-php-console' ); ?></label><br>
		<p class="description"><?php esc_html_e( 'Tick this option if you want the eval terminal to work only on a SSL connection.', 'wp-php-console' ); ?></p>
		<?php

	}


	/**
	 * Settings page IP Range field.
	 *
	 * @since 1.5.0
	 */
	public function ip_field() {

		?>
		<input type="text" class="regular-text" id="wp-php-console-ip" name="wp_php_console[ip]" value="<?php echo esc_attr( $this->options['ip'] ); ?>" />
		<label for="wp-php-console-ip"><?php esc_html_e( 'IP addresses (optional)', 'wp-php-console' ); ?></label><br>
		<p class="description"><?php esc_html_e( 'You may specify any of the following, to give access to specific IPs to the eval terminal:', 'wp-php-console' ); ?><br>
			<ol>
				<li><small><?php
					/* translators: Placeholders: %1$s - a single IP address, %2$s link to Varying Vagrant Vagrants repo */
					printf( __( 'An IP address (for example %1$s, %2$s default IP address).' ),
						'<code>192.168.50.4</code>',
						'<a href="https://github.com/Varying-Vagrant-Vagrants/VVV">Varying Vagrant Vagrants</a>'
					); ?></small></li>
				<li><small><?php
					/* translators: Placeholders: %1$s a range of IP addresses, %2$s - comma separated IP addresses */
					printf( __( 'A range of addresses (%1$s) or multiple addresses, comma separated (%2$s).', 'wp-php-console' ),
						'<code>192.168.*.*</code>',
						'<code>192.168.10.25,192.168.10.28</code>'
					); ?></small></li>
			</ol>
		</p>
		<?php

	}


	/**
	 * Settings page Register PC Class field.
	 *
	 * @since 1.5.0
	 */
	public function register_field() {


		?>
		<input type="checkbox" id="wp-php-console-register" name="wp_php_console[register]" value="1" <?php checked( (bool) $this->options['register'] ); ?> />
		<label for="wp-php-console-register"><?php esc_html_e( 'Yes', 'wp-php-console' ); ?></label><br>
		<p class="description"><?php
			esc_html_e( 'Tick to register PC class in the global namespace.', 'wp-php-console' );
			echo '<br>';
			/* translators: Placeholders: PHP code snippets examples */
			printf( __( 'Allows to write %1$s or %2$s instructions in PHP to inspect %3$s in the JavaScript console.', 'wp-php-console' ),
				'<code>PC::debug(&#36;var, &#36;tag)</code>',
				'<code>PC::magic_tag(&#36;var)</code>',
				'<code>&#36;var</code>'
			); ?></p>
		<?php

	}


	/**
	 * Settings page Show Call Stack field.
	 *
	 * @since 1.5.0
	 */
	public function stack_field() {


		?>
		<input type="checkbox" id="wp-php-console-stack" name="wp_php_console[stack]" value="1" <?php checked( (bool) $this->options['stack'] ); ?> />
		<label for="wp-php-console-stack"><?php esc_html_e( 'Yes', 'wp-php-console' ); ?></label><br />
		<p class="description"><?php esc_html_e( 'Tick to see the full call stack when PHP Console writes to the browser JavaScript console.', 'wp-php-console' ); ?></p>
		<?php

	}


	/**
	 * Settings page Show Short Paths field.
	 *
	 * @since 1.5.0
	 */
	public function short_field() {


		?>
		<input type="checkbox" id="wp-php-console-short" name="wp_php_console[short]" value="1" <?php checked( (bool) $this->options['short'] ); ?> />
		<label for="wp-php-console-short"><?php esc_html_e( 'Yes', 'wp-php-console' ); ?></label><br>
		<p class="description"><?php
			esc_html_e( 'Tick to shorten the length of PHP Console error sources and traces paths in browser JavaScript console for better readability.', 'wp-php-console' );
			echo '<br>';
			/* translators: %1$s - long server path, %2$s shortened server path */
			printf( __( 'Paths like %1$s will be displayed as %2$s', 'wp-php-console' ),
				'<code>/server/path/to/document/root/WP/wp-admin/admin.php:31</code>',
				'<code>/WP/wp-admin/admin.php:31</code>'
			); ?></p>
		<?php

	}


	/**
	 * Sanitize user input in settings page.
	 *
	 * @since  1.5.0
	 * @param  array $field user input
	 * @return array sanitized input
	 */
	public function sanitize_field( $field ) {

		$input = wp_parse_args( $field, array(
			'ip'       => '',
			'password' => '',
			'register' => false,
			'short'    => false,
			'ssl'      => false,
			'stack'    => false,
		) );

		$sanitized_input = array(
			'ip'       => sanitize_text_field( $input['ip'] ),
			'password' => sanitize_text_field( $input['password'] ),
			'register' => ! empty( $input['register'] ),
			'short'    => ! empty( $input['short'] ),
			'ssl'      => ! empty( $input['ssl'] ),
			'stack'    => ! empty( $input['stack'] ),
		);

		return $sanitized_input;
	}


	/**
	 * Settings page.
	 *
	 * @since 1.5.0
	 */
	public function settings_page() {

		?>
		<div class="wrap">
			<h2><?php esc_html_e( 'WP PHP Console', 'wp-php-console' ); ?></h2>
			<hr />
			<form method="post" action="options.php">
				<?php

				settings_fields( $this->option );

				do_settings_sections( $this->page );

				submit_button();

				?>
			</form>
		</div>
		<?php

	}


}

unfulvio / wp-php-console

Push — master ( 475e64...ab1972 )

Settings::short_field() A

Complexity

Size

Duplication

Importance

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like
