Issues (1386)

podlove.php (142 issues)

1
<?php
2
/**
3
 * Plugin Name: Podlove Subscribe Button
4
 * Plugin URI:  https://wordpress.org/plugins/podlove-subscribe-button/
5
 * Description: Brings the Podlove Subscribe Button to your WordPress installation.
6
 * Version:     1.4.0-beta
7
 * Author:      Podlove
8
 * Author URI:  https://podlove.org/
9
 * License:     MIT
10
 * License URI: license.txt
11
 * Text Domain: podlove-subscribe-button
12
 * Domain Path: /languages
13
 */
0 ignored issues
show
Coding Style Documentation introduced by
Missing @package tag in file comment
Loading history...
14
15
$correct_php_version = version_compare( phpversion(), "5.3", ">=" );
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal 5.3 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...
16
17
if ( ! $correct_php_version ) {
18
	printf( __( 'Podlove Subscribe Button Plugin requires %s or higher.<br>', 'podlove-subscribe-button' ), '<code>PHP 5.3</code>' );
19
	echo '<br />';
20
	printf( __( 'You are running %s', 'podlove-subscribe-button' ), '<code>PHP ' . phpversion() . '</code>' );
21
	exit;
22
}
23
24
// Constants
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
25
require('constants.php');
0 ignored issues
show
"require" is a statement not a function; no parentheses are required
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
26
require('settings/buttons.php');
0 ignored issues
show
"require" is a statement not a function; no parentheses are required
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
27
// Models
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
28
require('model/base.php');
0 ignored issues
show
"require" is a statement not a function; no parentheses are required
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
29
require('model/button.php');
0 ignored issues
show
"require" is a statement not a function; no parentheses are required
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
30
require('model/network_button.php');
0 ignored issues
show
"require" is a statement not a function; no parentheses are required
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
31
// Table
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
32
require('settings/buttons_list_table.php');
0 ignored issues
show
"require" is a statement not a function; no parentheses are required
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
33
// Media Types
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
34
require('media_types.php');
0 ignored issues
show
"require" is a statement not a function; no parentheses are required
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
35
// Widget
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
36
require('widget.php');
0 ignored issues
show
"require" is a statement not a function; no parentheses are required
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
37
// Version control
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
38
require('version.php');
0 ignored issues
show
"require" is a statement not a function; no parentheses are required
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
39
// Helper functions
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
40
require('helper.php');
0 ignored issues
show
"require" is a statement not a function; no parentheses are required
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
41
42
add_action( 'admin_menu', array( 'PodloveSubscribeButton', 'admin_menu') );
43
if ( is_multisite() )
44
	add_action( 'network_admin_menu', array( 'PodloveSubscribeButton', 'admin_network_menu') );
45
46
add_action( 'admin_init', array( 'PodloveSubscribeButton\Settings\Buttons', 'process_form' ) );
47
register_activation_hook( __FILE__, array( 'PodloveSubscribeButton', 'build_models' ) );
48
49
// Register Settings
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
50
add_action( 'admin_init', function () {
51
	$settings = array('size', 'autowidth', 'style', 'format', 'color');
52
53
	foreach ($settings as $setting) {
54
		register_setting( 'podlove-subscribe-button', 'podlove_subscribe_button_default_' . $setting );
55
	}
56
} );
57
58
add_shortcode( 'podlove-subscribe-button', array( 'PodloveSubscribeButton', 'shortcode' ) );
59
60
add_action( 'plugins_loaded', function () {
61
	load_plugin_textdomain( 'podlove-subscribe-button', false, dirname(plugin_basename( __FILE__)) . '/languages/');
0 ignored issues
show
Expected 1 spaces before closing bracket; 0 found
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
62
} );
63
64
PodloveSubscribeButton::run();
65
66
/**
67
 * Class PodloveSubscribeButton
68
 */
69
class PodloveSubscribeButton {
70
71
	/**
0 ignored issues
show
Missing short description in doc comment
Loading history...
72
	 * @var string current plugin version
73
	 */
74
	public static $version = '1.4.0-beta';
75
76
	public static function run() {
0 ignored issues
show
Coding Style Documentation introduced by
Missing function doc comment
Loading history...
77
		add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_assets' ) );
78
	}
0 ignored issues
show
Expected 1 blank line before closing function brace; 0 found
Loading history...
79
80
	public static function enqueue_assets( $hook ) {
0 ignored issues
show
Method name "PodloveSubscribeButton::enqueue_assets" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing function doc comment
Loading history...
81
82
		$pages = array( 'settings_page_podlove-subscribe-button', 'widgets.php' );
83
84
		if ( ! in_array( $hook, $pages )  ) {
85
			return;
86
		}
87
88
		// CSS Stylesheet
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
89
		wp_register_style( 'podlove-subscribe-button', plugin_dir_url( __FILE__ ) . 'style.css', false, self::$version );
90
		wp_enqueue_style( 'podlove-subscribe-button' );
91
92
		// Spectrum JS
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
93
		wp_enqueue_style( 'podlove-subscribe-button-spectrum', plugin_dir_url( __FILE__ ) . 'js/spectrum/spectrum.css', array(), '1.8.0' );
94
		wp_enqueue_script( 'podlove-subscribe-button-spectrum', plugin_dir_url( __FILE__ ) . 'js/spectrum/spectrum.js', array( 'jquery' ), '1.8.0' );
95
96
		// Admin JS
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
97
		wp_register_script( 'podlove-subscribe-button-admin-tools', plugin_dir_url( __FILE__ ) . 'js/admin.js', array( 'jquery' ), self::$version );
98
		$js_translations = array(
99
			'select_color'  => __( 'Select Color', 'podlove-subscribe-button' ),
100
			'cancel'        => __( 'Cancel', 'podlove-subscribe-button' ),
101
			'media_library' => __( 'Media Library', 'podlove-subscribe-button' ),
102
			'use_for'       => __( 'Use for Podcast Cover Art', 'podlove-subscribe-button' ),
103
		);
104
		wp_localize_script( 'podlove-subscribe-button-admin-tools', 'i18n', $js_translations );
105
		wp_enqueue_script( 'podlove-subscribe-button-admin-tools' );
106
	}
0 ignored issues
show
Expected 1 blank line before closing function brace; 0 found
Loading history...
107
108
	public static function admin_menu() {
0 ignored issues
show
Method name "PodloveSubscribeButton::admin_menu" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing function doc comment
Loading history...
109
		add_options_page(
110
				'Podlove Subscribe Button Options',
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
111
				'Podlove Subscribe Button',
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
112
				'manage_options',
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
113
				'podlove-subscribe-button',
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
114
				array( 'PodloveSubscribeButton\Settings\Buttons', 'page')
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
115
			);
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.
Loading history...
116
	}
0 ignored issues
show
Expected 1 blank line before closing function brace; 0 found
Loading history...
117
118
	public static function admin_network_menu() {
0 ignored issues
show
Method name "PodloveSubscribeButton::admin_network_menu" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing function doc comment
Loading history...
119
		add_submenu_page(
120
				'settings.php',
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
121
				'Podlove Subscribe Button Options',
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
122
				'Podlove Subscribe Button',
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
123
				'manage_options',
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
124
				'podlove-subscribe-button',
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
125
				array( 'PodloveSubscribeButton\Settings\Buttons', 'page')
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.
Loading history...
126
			);
0 ignored issues
show
This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.
Loading history...
127
	}
0 ignored issues
show
Expected 1 blank line before closing function brace; 0 found
Loading history...
128
129
	public static function build_models() {
0 ignored issues
show
Method name "PodloveSubscribeButton::build_models" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing function doc comment
Loading history...
130
		// Build Databases
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
131
		\PodloveSubscribeButton\Model\Button::build();
132
		if ( is_multisite() )
133
			\PodloveSubscribeButton\Model\NetworkButton::build();
134
135
		// Set Button "default" values
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
136
		$default_values = array(
137
				'size' => 'big',
138
				'autowidth' => 'on',
139
				'color' => '#599677',
140
				'style' => 'filled',
141
				'format' => 'rectangle'
142
			);
143
144
		foreach ($default_values as $option => $default_value) {
145
			if ( ! get_option('podlove_subscribe_button_default_' . $option ) ) {
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
146
				update_option('podlove_subscribe_button_default_' . $option, $default_value);
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
147
			}
148
		}
149
	}
0 ignored issues
show
Expected 1 blank line before closing function brace; 0 found
Loading history...
150
151
	public static function shortcode( $args ) {
0 ignored issues
show
Coding Style Documentation introduced by
Missing function doc comment
Loading history...
152
		if ( ! $args || ! isset($args['button']) ) {
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
153
			return __('You need to create a Button first and provide its ID.', 'podlove-subscribe-button');
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
154
		} else {
155
			$buttonid = $args['button'];
156
		}
157
158
		// Fetch the (network)button by it's name
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
159
		if ( ! $button = \PodloveSubscribeButton\Model\Button::get_button_by_name($args['button']) )
0 ignored issues
show
Assignments must be the first block of code on a line
Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
160
			return sprintf( __('Oops. There is no button with the ID "%s".', 'podlove-subscribe-button'), $args['button'] );
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
161
162
		// Get button styling and options
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
163
		$autowidth = self::interpret_width_attribute( self::get_array_value_with_fallback($args, 'width') );
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
164
		$size = self::get_attribute( 'size', self::get_array_value_with_fallback($args, 'size') );
0 ignored issues
show
Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
165
		$style = self::get_attribute( 'style', self::get_array_value_with_fallback($args, 'style') );
0 ignored issues
show
Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
166
		$format = self::get_attribute( 'format', self::get_array_value_with_fallback($args, 'format') );
0 ignored issues
show
Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
167
		$color = self::get_attribute( 'color', self::get_array_value_with_fallback($args, 'color') );
0 ignored issues
show
Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line.

To visualize

$a = "a";
$ab = "ab";
$abc = "abc";

will produce issues in the first and second line, while this second example

$a   = "a";
$ab  = "ab";
$abc = "abc";

will produce no issues.

Loading history...
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
168
169
		if ( isset($args['language']) ) {
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
170
			$language = $args['language'];
171
		} else {
172
			$language = 'en';
173
		}
174
175
		if ( isset($args['color']) ) {
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
176
			$color = $args['color'];
177
		} else {
178
			$color = get_option('podlove_subscribe_button_default_color', '#599677');
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
179
		}
180
181
		if ( isset($args['hide']) && $args['hide'] == 'true' ) {
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
182
			$hide = true;
183
		} else {
184
			$hide = false;
185
		}
186
187
		// Render button
0 ignored issues
show
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
188
		return $button->render($size, $autowidth, $style, $format, $color, $hide, $buttonid, $language);
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
189
	}
0 ignored issues
show
Expected 1 blank line before closing function brace; 0 found
Loading history...
190
191
	public static function get_array_value_with_fallback($args, $key) {
0 ignored issues
show
Method name "PodloveSubscribeButton::get_array_value_with_fallback" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing function doc comment
Loading history...
Expected 1 spaces between opening bracket and argument "$args"; 0 found
Loading history...
192
		if ( isset($args[$key]) )
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
193
			return $args[$key];
194
195
		return false;
196
	}
0 ignored issues
show
Expected 1 blank line before closing function brace; 0 found
Loading history...
197
198
	/**
0 ignored issues
show
Missing short description in doc comment
Loading history...
199
	 * @param  string $attribute
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
200
	 * @param  string $attribute_value
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
201
	 * @return string
202
	 */
203
	private static function get_attribute($attribute=null, $attribute_value=null) {
0 ignored issues
show
Method name "PodloveSubscribeButton::get_attribute" is not in camel caps format
Loading history...
Expected 1 spaces between opening bracket and argument "$attribute"; 0 found
Loading history...
Incorrect spacing between argument "$attribute" and equals sign; expected 1 but found 0
Loading history...
Incorrect spacing between default value and equals sign for argument "$attribute"; expected 1 but found 0
Loading history...
Incorrect spacing between argument "$attribute_value" and equals sign; expected 1 but found 0
Loading history...
Incorrect spacing between default value and equals sign for argument "$attribute_value"; expected 1 but found 0
Loading history...
204
		if ( isset($attribute_value) && ctype_alnum($attribute_value) && key_exists( $attribute_value, \PodloveSubscribeButton\Model\Button::$$attribute ) ) {
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
205
			return $attribute_value;
206
		} else {
207
			return get_option('podlove_subscribe_button_default_' . $attribute, \PodloveSubscribeButton\Model\Button::$properties[$attribute]);
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
208
		}
209
	}
0 ignored issues
show
Expected 1 blank line before closing function brace; 0 found
Loading history...
210
211
	/**
212
	 * Interprets the provided width attribute and return either auto- or a specific width
213
	 * @param  string $width_attribute
0 ignored issues
show
There must be exactly one blank line before the tags in a doc comment
Loading history...
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
214
	 * @return string
215
	 */
216
	private static function interpret_width_attribute( $width_attribute = null ) {
0 ignored issues
show
Method name "PodloveSubscribeButton::interpret_width_attribute" is not in camel caps format
Loading history...
217
		if ( $width_attribute == 'auto' )
218
			return 'on';
219
		if ( $width_attribute && $width_attribute !== 'auto' )
220
			return 'off';
221
222
		return get_option('podlove_subscribe_button_default_autowidth', 'on');
0 ignored issues
show
Expected 1 spaces after opening bracket; 0 found
Loading history...
Expected 1 spaces before closing bracket; 0 found
Loading history...
223
	}
0 ignored issues
show
Expected 1 blank line before closing function brace; 0 found
Loading history...
224
}