GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.
Passed
Push — master ( 70bbd7...41de00 )
by Christian
02:53
created

PodloveSubscribeButton::build_models()   A

Complexity

Conditions 4
Paths 6

Size

Total Lines 13
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 1 Features 0
Metric Value
cc 4
eloc 7
c 2
b 1
f 0
nc 6
nop 0
dl 0
loc 13
rs 10
1
<?php
0 ignored issues
show
introduced by
Class file names should be based on the class name with "class-" prepended. Expected class-podlovesubscribebutton.php, but found podlove.php.
Loading history...
2
/**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
3
 * @author    Podlove <[email protected]>
4
 * @copyright Copyright (c) 2014-2018, Podlove
5
 * @license   https://github.com/podlove/podlove-subscribe-button-wp-plugin/blob/master/LICENSE MIT
6
 * @package   Podlove\PodloveSubscribeButton
7
 * @version   1.4.0-beta
8
 */
9
10
/**
11
 * Plugin Name: Podlove Subscribe Button
12
 * Plugin URI:  https://wordpress.org/plugins/podlove-subscribe-button/
13
 * Description: Brings the Podlove Subscribe Button to your WordPress installation.
14
 * Version:     1.4.0-beta
15
 * Author:      Podlove
16
 * Author URI:  https://podlove.org/
17
 * License:     MIT
18
 * License URI: license.txt
19
 * Text Domain: podlove-subscribe-button
20
 */
21
22
/** Check if PHP version is sufficient */
23
if ( ! version_compare( phpversion(), '5.4', ">=" ) ) {
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal >= 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...
24
25
	require_once 'php-version.php';
26
	add_action( 'admin_notices', 'podlove_psb_php_notice' );
27
	add_action( 'admin_init', function() {
0 ignored issues
show
Coding Style introduced by
The opening parenthesis of a multi-line function call should be the last content on the line.
Loading history...
Coding Style introduced by
For multi-line function calls, each argument should be on a separate line.

For a function calls that spawns multiple lines, the coding style suggests to split arguments to separate lines like this:

someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
);
Loading history...
28
		deactivate_plugins( plugin_basename( __FILE__ ) );
29
	} );
0 ignored issues
show
Coding Style introduced by
For multi-line function calls, the closing parenthesis should be on a new line.

If a function call spawns multiple lines, the coding standard suggests to move the closing parenthesis to a new line:

someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
Loading history...
30
	return;
31
32
}
33
34
require_once __DIR__ . '/vendor/autoload.php';
35
36
// Constants
0 ignored issues
show
Coding Style introduced by
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
37
require( 'constants.php' );
0 ignored issues
show
Coding Style introduced by
"require" is a statement not a function; no parentheses are required
Loading history...
38
// Version control
0 ignored issues
show
Coding Style introduced by
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
39
require( 'version.php' );
0 ignored issues
show
Coding Style introduced by
"require" is a statement not a function; no parentheses are required
Loading history...
40
41
register_activation_hook(   __FILE__, array( 'PodloveSubscribeButton\Setup', 'activation' ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 3 found
Loading history...
42
register_deactivation_hook( __FILE__, array( 'PodloveSubscribeButton\Setup', 'deactivation' ) );
43
register_uninstall_hook(    __FILE__, array( 'PodloveSubscribeButton\Setup', 'uninstall' ) );
0 ignored issues
show
Coding Style introduced by
Expected 1 spaces after opening bracket; 4 found
Loading history...
44
45
PodloveSubscribeButton::run();
46
47
/**
48
 * Class PodloveSubscribeButton
49
 */
50
class PodloveSubscribeButton {
51
52
	/**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
53
	 * @var string current plugin version
54
	 */
55
	public static $version = '1.4.0-beta';
56
57
	public static function run() {
0 ignored issues
show
Coding Style Documentation introduced by
Missing doc comment for function run()
Loading history...
58
		add_action( 'plugins_loaded', array( __CLASS__, 'load_translations' ) );
59
		add_action( 'init', array( __CLASS__, 'register_shortcode' ) );
60
		add_action( 'admin_init', array( __CLASS__, 'register_settings' ) );
61
		add_action( 'admin_init', array( 'PodloveSubscribeButton\Settings\Buttons', 'process_form' ) );
62
		add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_assets' ) );
63
		add_action( 'widgets_init', array( __CLASS__, 'widgets' ) );
64
		self::menu();
65
66
	}
67
68
	public static function widgets() {
0 ignored issues
show
Coding Style Documentation introduced by
Missing doc comment for function widgets()
Loading history...
69
		register_widget( '\PodloveSubscribeButton\Widget' );
70
71
	}
72
73
	public static function menu() {
0 ignored issues
show
Coding Style Documentation introduced by
Missing doc comment for function menu()
Loading history...
74
		add_action( 'admin_menu', array( 'PodloveSubscribeButton', 'admin_menu' ) );
75
76
		if ( is_network_admin() ) {
77
			add_action( 'network_admin_menu', array( 'PodloveSubscribeButton', 'admin_network_menu' ) );
78
		}
79
80
	}
81
82
	public static function enqueue_assets( $hook ) {
0 ignored issues
show
Coding Style introduced by
Method name "PodloveSubscribeButton::enqueue_assets" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing doc comment for function enqueue_assets()
Loading history...
83
84
		$pages = array( 'settings_page_podlove-subscribe-button', 'widgets.php' );
85
86
		if ( ! in_array( $hook, $pages ) ) {
0 ignored issues
show
introduced by
Not using strict comparison for in_array; supply true for third argument.
Loading history...
87
			return;
88
		}
89
90
		// CSS Stylesheet
0 ignored issues
show
Coding Style introduced by
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
91
		wp_register_style( 'podlove-subscribe-button', \PodloveSubscribeButton\Helpers::get_url( '' ) . 'css/style.css' , false, self::$version );
0 ignored issues
show
Bug introduced by
false of type false is incompatible with the type array expected by parameter $deps of wp_register_style(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

91
		wp_register_style( 'podlove-subscribe-button', \PodloveSubscribeButton\Helpers::get_url( '' ) . 'css/style.css' , /** @scrutinizer ignore-type */ false, self::$version );
Loading history...
Coding Style introduced by
Space found before comma in function call
Loading history...
92
		wp_enqueue_style( 'podlove-subscribe-button' );
93
94
		// Admin JS
0 ignored issues
show
Coding Style introduced by
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
95
		wp_enqueue_style( 'wp-color-picker' );
96
		wp_register_script( 'podlove-subscribe-button-admin-tools', \PodloveSubscribeButton\Helpers::get_url( '' ) . 'js/admin.js', array( 'jquery', 'wp-color-picker' ), self::$version );
0 ignored issues
show
introduced by
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.
Loading history...
97
		$js_translations = array(
98
			'media_library' => __( 'Media Library', 'podlove-subscribe-button' ),
99
			'use_for'       => __( 'Use for Podcast Cover Art', 'podlove-subscribe-button' ),
100
		);
101
		wp_localize_script( 'podlove-subscribe-button-admin-tools', 'i18n', $js_translations );
102
		wp_enqueue_script( 'podlove-subscribe-button-admin-tools' );
103
104
	}
105
106
	public static function admin_menu() {
0 ignored issues
show
Coding Style introduced by
Method name "PodloveSubscribeButton::admin_menu" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing doc comment for function admin_menu()
Loading history...
107
		add_options_page(
108
			__( 'Podlove Subscribe Button Options', 'podlove-subscribe-button' ),
109
			__( 'Podlove Subscribe Button', 'podlove-subscribe-button' ),
110
			'manage_options',
111
			'podlove-subscribe-button',
112
			array( 'PodloveSubscribeButton\Settings\Buttons', 'page' )
113
		);
114
115
	}
116
117
	public static function admin_network_menu() {
0 ignored issues
show
Coding Style introduced by
Method name "PodloveSubscribeButton::admin_network_menu" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing doc comment for function admin_network_menu()
Loading history...
118
		add_submenu_page(
119
			'settings.php',
120
			__( 'Podlove Subscribe Button Options', 'podlove-subscribe-button' ),
121
			__( 'Podlove Subscribe Button', 'podlove-subscribe-button' ),
122
			'manage_options',
123
			'podlove-subscribe-button',
124
			array( 'PodloveSubscribeButton\Settings\Buttons', 'page' )
125
		);
126
127
	}
128
129
	public static function load_translations() {
0 ignored issues
show
Coding Style introduced by
Method name "PodloveSubscribeButton::load_translations" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing doc comment for function load_translations()
Loading history...
130
		load_plugin_textdomain( 'podlove-subscribe-button' );
131
132
	}
133
134
	public static function register_settings() {
0 ignored issues
show
Coding Style introduced by
Method name "PodloveSubscribeButton::register_settings" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing doc comment for function register_settings()
Loading history...
135
		$settings = array(
136
			'size',
137
			'autowidth',
138
			'style',
139
			'format',
140
			'color',
141
			'language',
142
		);
143
144
		foreach ( $settings as $setting ) {
145
			register_setting( 'podlove-subscribe-button', 'podlove_subscribe_button_default_' . $setting );
146
		}
147
148
	}
149
150
	static function get_option( $key, $default = false ) {
0 ignored issues
show
Best Practice introduced by
It is generally recommended to explicitly declare the visibility for methods.

Adding explicit visibility (private, protected, or public) is generally recommend to communicate to other developers how, and from where this method is intended to be used.

Loading history...
Coding Style introduced by
Method name "PodloveSubscribeButton::get_option" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing doc comment for function get_option()
Loading history...
Comprehensibility Best Practice introduced by
It is recommend to declare an explicit visibility for get_option.

Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed.

If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with private, and only raise it to protected if a sub-class needs to have access, or public if an external class needs access.

Loading history...
151
152
		return \get_option( 'podlove_subscribe_button_default_' . $key, $default );
153
154
	}
155
156
	public static function register_shortcode() {
0 ignored issues
show
Coding Style introduced by
Method name "PodloveSubscribeButton::register_shortcode" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing doc comment for function register_shortcode()
Loading history...
157
		add_shortcode( 'podlove-subscribe-button', array( 'PodloveSubscribeButton', 'shortcode' ) );
158
159
	}
160
161
162
163
	/**
0 ignored issues
show
Coding Style Documentation introduced by
Doc comment for parameter "$args" missing
Loading history...
164
	 * Add the shortcode
165
	 *
166
	 * @param $args
0 ignored issues
show
Coding Style introduced by
Missing parameter name
Loading history...
167
	 *
168
	 * @return string|void
169
	 */
170
	public static function shortcode( $args ) {
171
		if ( ! $args || ! isset( $args[ 'button' ] ) ) {
0 ignored issues
show
introduced by
Array keys must NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
172
			return __( 'You need to create a Button first and provide its ID.', 'podlove-subscribe-button' );
173
		} else {
174
			$buttonid = $args[ 'button' ];
0 ignored issues
show
introduced by
Array keys must NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
175
		}
176
177
		// Fetch the (network)button by it's name
0 ignored issues
show
Coding Style introduced by
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
178
		if ( ! $button = \PodloveSubscribeButton\Model\Button::get_button_by_name( $args[ 'button' ] ) )
0 ignored issues
show
Coding Style Best Practice introduced by
It is generally a best practice to always use braces with control structures.

Adding braces to control structures avoids accidental mistakes as your code changes:

// Without braces (not recommended)
if (true)
    doSomething();

// Recommended
if (true) {
    doSomething();
}
Loading history...
introduced by
Variable assignment found within a condition. Did you mean to do a comparison?
Loading history...
Coding Style introduced by
Assignments must be the first block of code on a line
Loading history...
introduced by
Array keys must NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
179
			return sprintf( __( 'Oops. There is no button with the ID "%s".', 'podlove-subscribe-button' ), $args[ 'button' ] );
0 ignored issues
show
introduced by
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.
Loading history...
introduced by
Array keys must NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
180
181
		// Get button styling and options
0 ignored issues
show
Coding Style introduced by
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
182
		$autowidth = self::interpret_width_attribute( self::get_array_value_with_fallback( $args, 'width' ) );
0 ignored issues
show
Bug introduced by
It seems like self::get_array_value_wi...allback($args, 'width') can also be of type false; however, parameter $width_attribute of PodloveSubscribeButton::...rpret_width_attribute() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

182
		$autowidth = self::interpret_width_attribute( /** @scrutinizer ignore-type */ self::get_array_value_with_fallback( $args, 'width' ) );
Loading history...
183
		$size      = self::get_attribute( 'size', self::get_array_value_with_fallback( $args, 'size' ) );
0 ignored issues
show
Bug introduced by
It seems like self::get_array_value_wi...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? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

183
		$size      = self::get_attribute( 'size', /** @scrutinizer ignore-type */ self::get_array_value_with_fallback( $args, 'size' ) );
Loading history...
184
		$style     = self::get_attribute( 'style', self::get_array_value_with_fallback( $args, 'style' ) );
185
		$format    = self::get_attribute( 'format', self::get_array_value_with_fallback( $args, 'format' ) );
186
187
		if ( isset( $args[ 'language' ] ) ) {
0 ignored issues
show
introduced by
Array keys must NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
188
			$language = $args[ 'language' ];
0 ignored issues
show
introduced by
Array keys must NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
189
		} else {
190
			$language = self::get_attribute( 'language', self::get_array_value_with_fallback( $args, 'language' ) );
191
		}
192
193
		if ( isset( $args[ 'color' ] ) ) {
0 ignored issues
show
introduced by
Array keys must NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
194
			$color = $args[ 'color' ];
0 ignored issues
show
introduced by
Array keys must NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
195
		} else {
196
			$color = self::get_attribute( 'color', self::get_array_value_with_fallback( $args, 'color' ) );
197
		}
198
199
		if ( isset( $args[ 'hide' ] ) && $args[ 'hide' ] == 'true' ) {
0 ignored issues
show
introduced by
Array keys must NOT be surrounded by spaces if they only contain a string or an integer.
Loading history...
introduced by
Found: ==. Use strict comparisons (=== or !==).
Loading history...
introduced by
Use Yoda Condition checks, you must.
Loading history...
200
			$hide = true;
201
		} else {
202
			$hide = false;
203
		}
204
205
		// Render button
0 ignored issues
show
Coding Style introduced by
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
206
		return $button->render( $size, $autowidth, $style, $format, $color, $hide, $buttonid, $language );
207
208
	}
209
210
	public static function get_array_value_with_fallback( $args, $key ) {
0 ignored issues
show
Coding Style introduced by
Method name "PodloveSubscribeButton::get_array_value_with_fallback" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing doc comment for function get_array_value_with_fallback()
Loading history...
211
		if ( isset( $args[ $key ] ) ) {
212
			return $args[ $key ];
213
		}
214
215
		return false;
216
217
	}
218
219
	/**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
220
	 * @param  string $attribute
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
221
	 * @param  string $attribute_value
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
222
	 * @return string
223
	 */
224
	private static function get_attribute( $attribute = null, $attribute_value = null ) {
0 ignored issues
show
Coding Style introduced by
Method name "PodloveSubscribeButton::get_attribute" is not in camel caps format
Loading history...
225
		if ( isset( $attribute_value ) && ctype_alnum( $attribute_value ) && key_exists( $attribute_value, \PodloveSubscribeButton\Model\Button::$$attribute ) ) {
226
			return $attribute_value;
227
		} else {
228
			return get_option( 'podlove_subscribe_button_default_' . $attribute, \PodloveSubscribeButton\Model\Button::$properties[ $attribute ] );
229
		}
230
231
	}
232
233
	/**
234
	 * Interprets the provided width attribute and return either auto- or a specific width
235
	 *
236
	 * @param  string $width_attribute
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
237
	 * @return string
238
	 */
239
	private static function interpret_width_attribute( $width_attribute = null ) {
0 ignored issues
show
Coding Style introduced by
Method name "PodloveSubscribeButton::interpret_width_attribute" is not in camel caps format
Loading history...
240
		if ( $width_attribute == 'auto' ) {
0 ignored issues
show
introduced by
Found: ==. Use strict comparisons (=== or !==).
Loading history...
introduced by
Use Yoda Condition checks, you must.
Loading history...
241
			return 'on';
242
		}
243
244
		if ( $width_attribute && $width_attribute !== 'auto' ) {
0 ignored issues
show
introduced by
Use Yoda Condition checks, you must.
Loading history...
245
			return 'off';
246
		}
247
248
		return self::get_option( 'autowidth', 'on' );
249
250
	}
251
252
	public static function plugin_file() {
0 ignored issues
show
Coding Style introduced by
Method name "PodloveSubscribeButton::plugin_file" is not in camel caps format
Loading history...
Coding Style Documentation introduced by
Missing doc comment for function plugin_file()
Loading history...
253
		return __FILE__;
254
	}
0 ignored issues
show
Coding Style introduced by
Expected 1 blank line before closing function brace; 0 found
Loading history...
255
256
} // END class
257