Conditions | 3 |
Paths | 3 |
Total Lines | 5 |
Code Lines | 4 |
Lines | 0 |
Ratio | 0 % |
Changes | 0 |
Metric | Value |
---|---|
cc | 3 |
eloc | 4 |
c | 0 |
b | 0 |
f | 0 |
nc | 3 |
nop | 1 |
dl | 0 |
loc | 5 |
rs | 10 |
1 | <?php |
||||
0 ignored issues
–
show
introduced
by
![]() |
|||||
2 | /** |
||||
3 | * Plugin Name: Podlove Subscribe Button |
||||
4 | * Plugin URI: https://wordpress.org/extend/plugins/podlove-subscribe-button/ |
||||
5 | * Description: Brings the Podlove Subscribe Button to your WordPress installation. |
||||
6 | * Version: 1.3.11 |
||||
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
|
|||||
14 | |||||
15 | $correct_php_version = version_compare( phpversion(), "5.3", ">=" ); |
||||
0 ignored issues
–
show
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 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 ( 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: 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. ![]() |
|||||
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>' ); |
||||
0 ignored issues
–
show
|
|||||
19 | echo '<br />'; |
||||
20 | printf( __( 'You are running %s', 'podlove-subscribe-button' ), '<code>PHP ' . phpversion() . '</code>' ); |
||||
0 ignored issues
–
show
|
|||||
21 | exit; |
||||
22 | } |
||||
23 | |||||
24 | // Constants |
||||
0 ignored issues
–
show
|
|||||
25 | require('constants.php'); |
||||
0 ignored issues
–
show
|
|||||
26 | require('settings/buttons.php'); |
||||
0 ignored issues
–
show
|
|||||
27 | // Models |
||||
0 ignored issues
–
show
|
|||||
28 | require('model/base.php'); |
||||
0 ignored issues
–
show
|
|||||
29 | require('model/button.php'); |
||||
0 ignored issues
–
show
|
|||||
30 | require('model/network_button.php'); |
||||
0 ignored issues
–
show
|
|||||
31 | // Table |
||||
0 ignored issues
–
show
|
|||||
32 | require('settings/buttons_list_table.php'); |
||||
0 ignored issues
–
show
|
|||||
33 | // Media Types |
||||
0 ignored issues
–
show
|
|||||
34 | require('media_types.php'); |
||||
0 ignored issues
–
show
|
|||||
35 | // Widget |
||||
0 ignored issues
–
show
|
|||||
36 | require('widget.php'); |
||||
0 ignored issues
–
show
|
|||||
37 | // Version control |
||||
0 ignored issues
–
show
|
|||||
38 | require('version.php'); |
||||
0 ignored issues
–
show
|
|||||
39 | // Helper functions |
||||
0 ignored issues
–
show
|
|||||
40 | require('helper.php'); |
||||
0 ignored issues
–
show
|
|||||
41 | |||||
42 | add_action( 'admin_menu', array( 'PodloveSubscribeButton', 'admin_menu') ); |
||||
0 ignored issues
–
show
|
|||||
43 | if ( is_multisite() ) |
||||
0 ignored issues
–
show
|
|||||
44 | add_action( 'network_admin_menu', array( 'PodloveSubscribeButton', 'admin_network_menu') ); |
||||
0 ignored issues
–
show
|
|||||
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
|
|||||
50 | add_action( 'admin_init', function () { |
||||
0 ignored issues
–
show
|
|||||
51 | $settings = array( 'size', 'autowidth', 'style', 'format', 'color' ); |
||||
52 | |||||
53 | foreach ( $settings as $setting ) { |
||||
54 | if ( 'autowidth' == $setting ) { |
||||
0 ignored issues
–
show
|
|||||
55 | $args = array( |
||||
56 | 'sanitize_callback' => array( 'PodloveSubscribeButton', 'sanitize_settings' ), |
||||
57 | ); |
||||
58 | register_setting( 'podlove-subscribe-button', 'podlove_subscribe_button_default_' . $setting, $args ); |
||||
59 | } else { |
||||
60 | register_setting( 'podlove-subscribe-button', 'podlove_subscribe_button_default_' . $setting ); |
||||
61 | } |
||||
62 | } |
||||
63 | } ); |
||||
0 ignored issues
–
show
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.
![]() |
|||||
64 | |||||
65 | add_shortcode( 'podlove-subscribe-button', array( 'PodloveSubscribeButton', 'shortcode' ) ); |
||||
66 | |||||
67 | add_action( 'plugins_loaded', function () { |
||||
0 ignored issues
–
show
|
|||||
68 | load_plugin_textdomain( 'podlove-subscribe-button', false, dirname(plugin_basename( __FILE__)) . '/languages/'); |
||||
0 ignored issues
–
show
|
|||||
69 | } ); |
||||
0 ignored issues
–
show
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.
![]() |
|||||
70 | |||||
71 | PodloveSubscribeButton::run(); |
||||
72 | |||||
73 | |||||
74 | class PodloveSubscribeButton { |
||||
0 ignored issues
–
show
|
|||||
75 | |||||
76 | public static function run() { |
||||
0 ignored issues
–
show
|
|||||
77 | add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_assets' ) ); |
||||
78 | } |
||||
0 ignored issues
–
show
|
|||||
79 | |||||
80 | public static function enqueue_assets( $hook ) { |
||||
0 ignored issues
–
show
|
|||||
81 | |||||
82 | $pages = array( 'settings_page_podlove-subscribe-button', 'widgets.php' ); |
||||
83 | |||||
84 | if ( ! in_array( $hook, $pages ) ) { |
||||
0 ignored issues
–
show
|
|||||
85 | return; |
||||
86 | } |
||||
87 | |||||
88 | // CSS Stylesheet |
||||
0 ignored issues
–
show
|
|||||
89 | wp_register_style( 'podlove-subscribe-button', plugin_dir_url( __FILE__ ) . 'style.css', false, '1.3.6' ); |
||||
0 ignored issues
–
show
false of type false is incompatible with the type string[] 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
![]() |
|||||
90 | wp_enqueue_style( 'podlove-subscribe-button' ); |
||||
91 | |||||
92 | // Admin JS |
||||
0 ignored issues
–
show
|
|||||
93 | wp_enqueue_style( 'wp-color-picker' ); |
||||
94 | wp_register_script( 'podlove-subscribe-button-admin-tools', plugin_dir_url( __FILE__ ) . 'js/admin.js', array( 'jquery', 'wp-color-picker' ), '1.3.6' ); |
||||
0 ignored issues
–
show
|
|||||
95 | |||||
96 | $js_translations = array( |
||||
97 | 'media_library' => __( 'Media Library', 'podlove-subscribe-button' ), |
||||
98 | 'use_for' => __( 'Use for Podcast Cover Art', 'podlove-subscribe-button' ), |
||||
99 | ); |
||||
100 | wp_localize_script( 'podlove-subscribe-button-admin-tools', 'i18n', $js_translations ); |
||||
101 | wp_enqueue_script( 'podlove-subscribe-button-admin-tools' ); |
||||
102 | } |
||||
0 ignored issues
–
show
|
|||||
103 | |||||
104 | public static function admin_menu() { |
||||
0 ignored issues
–
show
|
|||||
105 | add_options_page( |
||||
106 | 'Podlove Subscribe Button Options', |
||||
0 ignored issues
–
show
|
|||||
107 | 'Podlove Subscribe Button', |
||||
0 ignored issues
–
show
|
|||||
108 | 'manage_options', |
||||
0 ignored issues
–
show
|
|||||
109 | 'podlove-subscribe-button', |
||||
0 ignored issues
–
show
|
|||||
110 | array( 'PodloveSubscribeButton\Settings\Buttons', 'page') |
||||
0 ignored issues
–
show
|
|||||
111 | ); |
||||
0 ignored issues
–
show
|
|||||
112 | } |
||||
0 ignored issues
–
show
|
|||||
113 | |||||
114 | public static function admin_network_menu() { |
||||
0 ignored issues
–
show
|
|||||
115 | add_submenu_page( |
||||
116 | 'settings.php', |
||||
0 ignored issues
–
show
|
|||||
117 | 'Podlove Subscribe Button Options', |
||||
0 ignored issues
–
show
|
|||||
118 | 'Podlove Subscribe Button', |
||||
0 ignored issues
–
show
|
|||||
119 | 'manage_options', |
||||
0 ignored issues
–
show
|
|||||
120 | 'podlove-subscribe-button', |
||||
0 ignored issues
–
show
|
|||||
121 | array( 'PodloveSubscribeButton\Settings\Buttons', 'page') |
||||
0 ignored issues
–
show
|
|||||
122 | ); |
||||
0 ignored issues
–
show
|
|||||
123 | } |
||||
0 ignored issues
–
show
|
|||||
124 | |||||
125 | public static function build_models() { |
||||
0 ignored issues
–
show
|
|||||
126 | // Build Databases |
||||
0 ignored issues
–
show
|
|||||
127 | \PodloveSubscribeButton\Model\Button::build(); |
||||
128 | if ( is_multisite() ) |
||||
0 ignored issues
–
show
|
|||||
129 | \PodloveSubscribeButton\Model\NetworkButton::build(); |
||||
130 | |||||
131 | // Set Button "default" values |
||||
0 ignored issues
–
show
|
|||||
132 | $default_values = array( |
||||
133 | 'size' => 'big', |
||||
0 ignored issues
–
show
|
|||||
134 | 'autowidth' => 'on', |
||||
0 ignored issues
–
show
|
|||||
135 | 'color' => '#599677', |
||||
0 ignored issues
–
show
|
|||||
136 | 'style' => 'filled', |
||||
0 ignored issues
–
show
|
|||||
137 | 'format' => 'rectangle' |
||||
0 ignored issues
–
show
|
|||||
138 | ); |
||||
0 ignored issues
–
show
|
|||||
139 | |||||
140 | foreach ($default_values as $option => $default_value) { |
||||
0 ignored issues
–
show
|
|||||
141 | if ( ! get_option('podlove_subscribe_button_default_' . $option ) ) { |
||||
0 ignored issues
–
show
|
|||||
142 | update_option('podlove_subscribe_button_default_' . $option, $default_value); |
||||
0 ignored issues
–
show
|
|||||
143 | } |
||||
144 | } |
||||
145 | } |
||||
0 ignored issues
–
show
|
|||||
146 | |||||
147 | public static function shortcode( $args ) { |
||||
0 ignored issues
–
show
|
|||||
148 | if ( ! $args || ! isset($args['button']) ) { |
||||
0 ignored issues
–
show
|
|||||
149 | return __('You need to create a Button first and provide its ID.', 'podlove-subscribe-button'); |
||||
0 ignored issues
–
show
|
|||||
150 | } else { |
||||
151 | $buttonid = $args['button']; |
||||
152 | } |
||||
153 | |||||
154 | // Fetch the (network)button by it's name |
||||
0 ignored issues
–
show
|
|||||
155 | if ( ! $button = \PodloveSubscribeButton\Model\Button::get_button_by_name($args['button']) ) |
||||
0 ignored issues
–
show
|
|||||
156 | return sprintf( __('Oops. There is no button with the ID "%s".', 'podlove-subscribe-button'), $args['button'] ); |
||||
0 ignored issues
–
show
|
|||||
157 | |||||
158 | // Get button styling and options |
||||
0 ignored issues
–
show
|
|||||
159 | $autowidth = self::interpret_width_attribute( self::get_array_value_with_fallback($args, 'width') ); |
||||
0 ignored issues
–
show
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
![]() |
|||||
160 | $size = self::get_attribute( 'size', self::get_array_value_with_fallback($args, 'size') ); |
||||
0 ignored issues
–
show
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
![]() 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. ![]() |
|||||
161 | $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. ![]() |
|||||
162 | $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. ![]() |
|||||
163 | $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. ![]() |
|||||
164 | |||||
165 | if ( isset($args['language']) ) { |
||||
0 ignored issues
–
show
|
|||||
166 | $language = $args['language']; |
||||
167 | } else { |
||||
168 | $language = 'en'; |
||||
169 | } |
||||
170 | |||||
171 | if ( isset($args['color']) ) { |
||||
0 ignored issues
–
show
|
|||||
172 | $color = $args['color']; |
||||
173 | } else { |
||||
174 | $color = get_option('podlove_subscribe_button_default_color', '#599677'); |
||||
0 ignored issues
–
show
|
|||||
175 | } |
||||
176 | |||||
177 | if ( isset($args['hide']) && $args['hide'] == 'true' ) { |
||||
0 ignored issues
–
show
|
|||||
178 | $hide = true; |
||||
179 | } else { |
||||
180 | $hide = false; |
||||
181 | } |
||||
182 | |||||
183 | // Render button |
||||
0 ignored issues
–
show
|
|||||
184 | return $button->render($size, $autowidth, $style, $format, $color, $hide, $buttonid, $language); |
||||
0 ignored issues
–
show
|
|||||
185 | } |
||||
0 ignored issues
–
show
|
|||||
186 | |||||
187 | public static function get_array_value_with_fallback($args, $key) { |
||||
0 ignored issues
–
show
|
|||||
188 | if ( isset($args[$key]) ) |
||||
0 ignored issues
–
show
|
|||||
189 | return $args[$key]; |
||||
0 ignored issues
–
show
|
|||||
190 | |||||
191 | return false; |
||||
192 | } |
||||
0 ignored issues
–
show
|
|||||
193 | |||||
194 | /** |
||||
0 ignored issues
–
show
|
|||||
195 | * @param string $attribute |
||||
0 ignored issues
–
show
|
|||||
196 | * @param string $attribute_value |
||||
0 ignored issues
–
show
|
|||||
197 | * @return string |
||||
198 | */ |
||||
199 | private static function get_attribute($attribute=null, $attribute_value=null) { |
||||
0 ignored issues
–
show
|
|||||
200 | if ( isset($attribute_value) && ctype_alnum($attribute_value) && key_exists( $attribute_value, \PodloveSubscribeButton\Model\Button::$$attribute ) ) { |
||||
0 ignored issues
–
show
|
|||||
201 | return $attribute_value; |
||||
202 | } else { |
||||
203 | return get_option('podlove_subscribe_button_default_' . $attribute, \PodloveSubscribeButton\Model\Button::$properties[$attribute]); |
||||
0 ignored issues
–
show
|
|||||
204 | } |
||||
205 | } |
||||
0 ignored issues
–
show
|
|||||
206 | |||||
207 | /** |
||||
208 | * Interprets the provided width attribute and return either auto- or a specific width |
||||
209 | * @param string $width_attribute |
||||
0 ignored issues
–
show
|
|||||
210 | * @return string |
||||
211 | */ |
||||
212 | private static function interpret_width_attribute( $width_attribute = null ) { |
||||
0 ignored issues
–
show
|
|||||
213 | if ( $width_attribute == 'auto' ) |
||||
0 ignored issues
–
show
|
|||||
214 | return 'on'; |
||||
215 | if ( $width_attribute && $width_attribute !== 'auto' ) |
||||
0 ignored issues
–
show
|
|||||
216 | return 'off'; |
||||
217 | |||||
218 | return get_option('podlove_subscribe_button_default_autowidth', 'on'); |
||||
0 ignored issues
–
show
|
|||||
219 | } |
||||
0 ignored issues
–
show
|
|||||
220 | |||||
221 | public static function sanitize_settings( $input = null ) { |
||||
0 ignored issues
–
show
|
|||||
222 | if ( null == $input ) { |
||||
0 ignored issues
–
show
|
|||||
223 | return 'off'; |
||||
224 | } elseif ( 'on' == $input ) { |
||||
0 ignored issues
–
show
|
|||||
225 | return $input; |
||||
226 | } |
||||
227 | } |
||||
0 ignored issues
–
show
|
|||||
228 | } |
||||
229 |