PodloveSubscribeButton

Complexity

Total Complexity

33

Size/Duplication

Total Lines	196
Duplicated Lines	0 %

Importance

Changes	8
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	run()	0	6	1
B	shortcode()	0	38	8
A	get_attribute()	0	5	4
A	get_array_value_with_fallback()	0	5	2
A	build_models()	0	18	4
A	register_shortcode()	0	2	1
A	enqueue_assets()	0	26	2
A	admin_menu()	0	7	1
A	register_settings()	0	11	2
A	admin_network_menu()	0	8	1
A	load_translations()	0	2	1
A	menu()	0	5	2
A	interpret_width_attribute()	0	7	4

<?php

Class file names should be based on the class name with "class-" prepended. Expected class-podlovesubscribebutton.php, but found podlove.php.

/**
 * Plugin Name: Podlove Subscribe Button
 * Plugin URI:  https://wordpress.org/plugins/podlove-subscribe-button/
 * Description: Brings the Podlove Subscribe Button to your WordPress installation.
 * Version:     1.4.0-beta
 * Author:      Podlove
 * Author URI:  https://podlove.org/
 * License:     MIT
 * License URI: license.txt
 * Text Domain: podlove-subscribe-button
 * Domain Path: /languages
 */

Missing @package tag in file comment

$correct_php_version = version_compare( phpversion(), "5.3", ">=" );

The string literal 5.3 does not require double quotes, as per coding-style, please use single quotes.

if ( ! $correct_php_version ) {
	printf( __( 'Podlove Subscribe Button Plugin requires %s or higher.<br>', 'podlove-subscribe-button' ), '<code>PHP 5.3</code>' );

All output should be run through an escaping function (see the Security sections in the WordPress Developer Handbooks), found '__'.

A gettext call containing placeholders was found, but was not accompanied by a "translators:" comment on the line above to clarify the meaning of the placeholders.

	echo '<br />';
	printf( __( 'You are running %s', 'podlove-subscribe-button' ), '<code>PHP ' . phpversion() . '</code>' );

All output should be run through an escaping function (see the Security sections in the WordPress Developer Handbooks), found '__'.

A gettext call containing placeholders was found, but was not accompanied by a "translators:" comment on the line above to clarify the meaning of the placeholders.

All output should be run through an escaping function (see the Security sections in the WordPress Developer Handbooks), found 'phpversion'.

	exit;
}

// Constants

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

require('constants.php');

"require" is a statement not a function; no parentheses are required

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

require('settings/buttons.php');

"require" is a statement not a function; no parentheses are required

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

// Models

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

require('model/base.php');

"require" is a statement not a function; no parentheses are required

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

require('model/button.php');

"require" is a statement not a function; no parentheses are required

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

require('model/network_button.php');

"require" is a statement not a function; no parentheses are required

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

// Table

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

require('settings/buttons_list_table.php');

"require" is a statement not a function; no parentheses are required

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

// Media Types

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

require('media_types.php');

"require" is a statement not a function; no parentheses are required

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

// Widget

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

require('widget.php');

"require" is a statement not a function; no parentheses are required

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

// Version control

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

require('version.php');

"require" is a statement not a function; no parentheses are required

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

// Helper functions

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

require('helper.php');

"require" is a statement not a function; no parentheses are required

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

register_activation_hook( __FILE__, array( 'PodloveSubscribeButton', 'build_models' ) );

PodloveSubscribeButton::run();

/**
 * Class PodloveSubscribeButton
 */
class PodloveSubscribeButton {

	/**

Missing short description in doc comment

	 * @var string current plugin version
	 */
	public static $version = '1.4.0-beta';

	public static function run() {

Missing function doc comment

		add_action( 'plugins_loaded', array( __CLASS__, 'load_translations' ) );
		add_action( 'init', array( __CLASS__, 'register_shortcode' ) );
		add_action( 'admin_init', array( __CLASS__, 'register_settings' ) );
		add_action( 'admin_init', array( 'PodloveSubscribeButton\Settings\Buttons', 'process_form' ) );
		self::menu();

	}

	public static function menu() {

Missing function doc comment

		add_action( 'admin_menu', array( 'PodloveSubscribeButton', 'admin_menu' ) );

		if ( is_network_admin() ) {
			add_action( 'network_admin_menu', array( 'PodloveSubscribeButton', 'admin_network_menu' ) );
		}

	}

	public static function enqueue_assets( $hook ) {

Method name "PodloveSubscribeButton::enqueue_assets" is not in camel caps format

Missing function doc comment

		$pages = array( 'settings_page_podlove-subscribe-button', 'widgets.php' );

		if ( ! in_array( $hook, $pages )  ) {

Expected exactly one space before closing parenthesis; " " found.

Not using strict comparison for in_array; supply true for third argument.

			return;
		}

		// CSS Stylesheet

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

		wp_register_style( 'podlove-subscribe-button', plugin_dir_url( __FILE__ ) . 'style.css', false, self::$version );

false of type false is incompatible with the type array expected by parameter $deps of wp_register_style().

		wp_enqueue_style( 'podlove-subscribe-button' );

		// Spectrum JS

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

		wp_enqueue_style( 'podlove-subscribe-button-spectrum', plugin_dir_url( __FILE__ ) . 'js/spectrum/spectrum.css', array(), '1.8.0' );
		wp_enqueue_script( 'podlove-subscribe-button-spectrum', plugin_dir_url( __FILE__ ) . 'js/spectrum/spectrum.js', array( 'jquery' ), '1.8.0' );

In footer ($in_footer) is not set explicitly wp_enqueue_script; It is recommended to load scripts in the footer. Please set this value to true to load it in the footer, or explicitly false if it should be loaded in the header.

		// Admin JS

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

		wp_register_script( 'podlove-subscribe-button-admin-tools', plugin_dir_url( __FILE__ ) . 'js/admin.js', array( 'jquery' ), self::$version );

In footer ($in_footer) is not set explicitly wp_register_script; It is recommended to load scripts in the footer. Please set this value to true to load it in the footer, or explicitly false if it should be loaded in the header.

		$js_translations = array(
			'select_color'  => __( 'Select Color', 'podlove-subscribe-button' ),
			'cancel'        => __( 'Cancel', 'podlove-subscribe-button' ),
			'media_library' => __( 'Media Library', 'podlove-subscribe-button' ),
			'use_for'       => __( 'Use for Podcast Cover Art', 'podlove-subscribe-button' ),
		);
		wp_localize_script( 'podlove-subscribe-button-admin-tools', 'i18n', $js_translations );
		wp_enqueue_script( 'podlove-subscribe-button-admin-tools' );

	}

	public static function admin_menu() {

Method name "PodloveSubscribeButton::admin_menu" is not in camel caps format

Missing function doc comment

		add_options_page(
			'Podlove Subscribe Button Options',
			'Podlove Subscribe Button',
			'manage_options',
			'podlove-subscribe-button',
			array( 'PodloveSubscribeButton\Settings\Buttons', 'page' )
		);

	}

	public static function admin_network_menu() {

Method name "PodloveSubscribeButton::admin_network_menu" is not in camel caps format

Missing function doc comment

		add_submenu_page(
			'settings.php',
			'Podlove Subscribe Button Options',
			'Podlove Subscribe Button',
			'manage_options',
			'podlove-subscribe-button',
			array( 'PodloveSubscribeButton\Settings\Buttons', 'page' )
		);

	}

	public static function load_translations() {

Method name "PodloveSubscribeButton::load_translations" is not in camel caps format

Missing function doc comment

		load_plugin_textdomain( 'podlove-subscribe-button', false, dirname(plugin_basename( __FILE__)) . '/languages/' );

false of type false is incompatible with the type string expected by parameter $deprecated of load_plugin_textdomain().

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

	}

	public static function register_settings() {

Method name "PodloveSubscribeButton::register_settings" is not in camel caps format

Missing function doc comment

		$settings = array(
			'size',
			'autowidth',
			'style',
			'format',
			'color',
		);

		foreach ( $settings as $setting ) {
			register_setting( 'podlove-subscribe-button', 'podlove_subscribe_button_default_' . $setting );
		}

	}

	public static function register_shortcode() {

Method name "PodloveSubscribeButton::register_shortcode" is not in camel caps format

Missing function doc comment

		add_shortcode( 'podlove-subscribe-button', array( 'PodloveSubscribeButton', 'shortcode' ) );

	}

	public static function build_models() {

Method name "PodloveSubscribeButton::build_models" is not in camel caps format

Missing function doc comment

		// Build Databases

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

		\PodloveSubscribeButton\Model\Button::build();
		if ( is_multisite() )

It is generally a best practice to always use braces with control structures.

			\PodloveSubscribeButton\Model\NetworkButton::build();

		// Set Button "default" values

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

		$default_values = array(
				'size' => 'big',

Array item not aligned correctly; expected 12 spaces but found 16

Array double arrow not aligned correctly; expected 6 space(s) between "'size'" and double arrow, but found 1.

				'autowidth' => 'on',

Array item not aligned correctly; expected 12 spaces but found 16

				'color' => '#599677',

Array item not aligned correctly; expected 12 spaces but found 16

Array double arrow not aligned correctly; expected 5 space(s) between "'color'" and double arrow, but found 1.

				'style' => 'filled',

Array item not aligned correctly; expected 12 spaces but found 16

Array double arrow not aligned correctly; expected 5 space(s) between "'style'" and double arrow, but found 1.

				'format' => 'rectangle'

Array item not aligned correctly; expected 12 spaces but found 16

Array double arrow not aligned correctly; expected 4 space(s) between "'format'" and double arrow, but found 1.

Each array item in a multi-line array declaration must end in a comma

			);

Array closer not aligned correctly; expected 8 space(s) but found 12

		foreach ($default_values as $option => $default_value) {

No space after opening parenthesis is prohibited

No space before closing parenthesis is prohibited

			if ( ! get_option('podlove_subscribe_button_default_' . $option ) ) {

Expected 1 spaces after opening bracket; 0 found

				update_option('podlove_subscribe_button_default_' . $option, $default_value);

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			}
		}
	}

Expected 1 blank line before closing function brace; 0 found

	public static function shortcode( $args ) {

Missing function doc comment

		if ( ! $args || ! isset($args['button']) ) {

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			return __('You need to create a Button first and provide its ID.', 'podlove-subscribe-button');

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

		} else {
			$buttonid = $args['button'];
		}

		// Fetch the (network)button by it's name

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

		if ( ! $button = \PodloveSubscribeButton\Model\Button::get_button_by_name($args['button']) )

It is generally a best practice to always use braces with control structures.

Variable assignment found within a condition. Did you mean to do a comparison?

Assignments must be the first block of code on a line

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			return sprintf( __('Oops. There is no button with the ID "%s".', 'podlove-subscribe-button'), $args['button'] );

A gettext call containing placeholders was found, but was not accompanied by a "translators:" comment on the line above to clarify the meaning of the placeholders.

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

		// Get button styling and options

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

		$autowidth = self::interpret_width_attribute( self::get_array_value_with_fallback($args, 'width') );

It seems like self::get_array_value_with_fallback($args, 'width') can also be of type false; however, parameter $width_attribute of PodloveSubscribeButton::interpret_width_attribute() does only seem to accept string, maybe add an additional type check?

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

		$size = self::get_attribute( 'size', self::get_array_value_with_fallback($args, 'size') );

It seems like self::get_array_value_with_fallback($args, 'size') can also be of type false; however, parameter $attribute_value of PodloveSubscribeButton::get_attribute() does only seem to accept string, maybe add an additional type check?

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

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

		$style = self::get_attribute( 'style', self::get_array_value_with_fallback($args, 'style') );

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

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

		$format = self::get_attribute( 'format', self::get_array_value_with_fallback($args, 'format') );

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

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

		$color = self::get_attribute( 'color', self::get_array_value_with_fallback($args, 'color') );

The assignment to $color is dead and can be removed.

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

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

		if ( isset($args['language']) ) {

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			$language = $args['language'];
		} else {
			$language = 'en';
		}

		if ( isset($args['color']) ) {

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			$color = $args['color'];
		} else {
			$color = get_option('podlove_subscribe_button_default_color', '#599677');

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

		}

		if ( isset($args['hide']) && $args['hide'] == 'true' ) {

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

Found: ==. Use strict comparisons (=== or !==).

Use Yoda Condition checks, you must.

			$hide = true;
		} else {
			$hide = false;
		}

		// Render button

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

		return $button->render($size, $autowidth, $style, $format, $color, $hide, $buttonid, $language);

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

	}

Expected 1 blank line before closing function brace; 0 found

	public static function get_array_value_with_fallback($args, $key) {

Method name "PodloveSubscribeButton::get_array_value_with_fallback" is not in camel caps format

No space after opening parenthesis is prohibited

Missing function doc comment

Expected 1 spaces between opening bracket and argument "$args"; 0 found

No space before closing parenthesis is prohibited

		if ( isset($args[$key]) )

It is generally a best practice to always use braces with control structures.

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

Array keys must be surrounded by spaces unless they contain a string or an integer.

			return $args[$key];

Array keys must be surrounded by spaces unless they contain a string or an integer.

		return false;
	}

Expected 1 blank line before closing function brace; 0 found

	/**

Missing short description in doc comment

	 * @param  string $attribute

Missing parameter comment

	 * @param  string $attribute_value

Missing parameter comment

	 * @return string
	 */
	private static function get_attribute($attribute=null, $attribute_value=null) {

Method name "PodloveSubscribeButton::get_attribute" is not in camel caps format

No space after opening parenthesis is prohibited

Expected 1 spaces between opening bracket and argument "$attribute"; 0 found

Incorrect spacing between argument "$attribute" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$attribute"; expected 1 but found 0

Incorrect spacing between argument "$attribute_value" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$attribute_value"; expected 1 but found 0

No space before closing parenthesis is prohibited

		if ( isset($attribute_value) && ctype_alnum($attribute_value) && key_exists( $attribute_value, \PodloveSubscribeButton\Model\Button::$$attribute ) ) {

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			return $attribute_value;
		} else {
			return get_option('podlove_subscribe_button_default_' . $attribute, \PodloveSubscribeButton\Model\Button::$properties[$attribute]);

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

Array keys must be surrounded by spaces unless they contain a string or an integer.

		}
	}

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Interprets the provided width attribute and return either auto- or a specific width
	 * @param  string $width_attribute

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

	 * @return string
	 */
	private static function interpret_width_attribute( $width_attribute = null ) {

Method name "PodloveSubscribeButton::interpret_width_attribute" is not in camel caps format

		if ( $width_attribute == 'auto' )

It is generally a best practice to always use braces with control structures.

Found: ==. Use strict comparisons (=== or !==).

Use Yoda Condition checks, you must.

			return 'on';
		if ( $width_attribute && $width_attribute !== 'auto' )

It is generally a best practice to always use braces with control structures.

Use Yoda Condition checks, you must.

			return 'off';

		return get_option( 'podlove_subscribe_button_default_autowidth', 'on' );
	}

Expected 1 blank line before closing function brace; 0 found

}