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

Button::get_global_setting_with_fallback()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
eloc 3
nc 3
nop 1
dl 0
loc 6
rs 10
c 0
b 0
f 0
1
<?php
0 ignored issues
show
introduced by
Filenames should be all lowercase with hyphens as word separators. Expected button.php, but found Button.php.
Loading history...
introduced by
Class file names should be based on the class name with "class-" prepended. Expected class-button.php, but found Button.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
 */
8
9
namespace PodloveSubscribeButton\Model;
10
11
use PodloveSubscribeButton\Defaults;
12
13
class Button extends Base {
0 ignored issues
show
Coding Style Documentation introduced by
Missing doc comment for class Button
Loading history...
14
15
	public static $properties = array(
0 ignored issues
show
Coding Style Documentation introduced by
Missing member variable doc comment
Loading history...
16
		// $property => $default value
0 ignored issues
show
Unused Code Comprehensibility introduced by
43% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
17
		'size'      => 'big',
18
		'color'     => '#599677',
19
		'autowidth' => 'on',
20
		'style'     => 'filled',
21
		'format'    => 'rectangle',
22
		'hide'      => 'false',
23
		'buttonid'  => '',
24
		'language'  => 'en',
25
		// Note: the field 'json-data' cannot be set here (No function call allowed within class variables)
0 ignored issues
show
Coding Style introduced by
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
26
	);
27
28
	/**
29
	 * Fetches a Button or Network Button with a specific name
30
	 * @param  string $name
0 ignored issues
show
Coding Style introduced by
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...
31
	 * @return object|false
32
	 */
33
	public static function get_button_by_name( $name ) {
0 ignored issues
show
Coding Style introduced by
Method name "Button::get_button_by_name" is not in camel caps format
Loading history...
34
		if ( $button = Button::find_one_by_property( 'name', $name ) ) {
0 ignored issues
show
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...
Coding Style introduced by
As per coding style, self should be used for accessing local static members.

This check looks for accesses to local static members using the fully qualified name instead of self::.

<?php

class Certificate {
    const TRIPLEDES_CBC = 'ASDFGHJKL';

    private $key;

    public function __construct()
    {
        $this->key = Certificate::TRIPLEDES_CBC;
    }
}

While this is perfectly valid, the fully qualified name of Certificate::TRIPLEDES_CBC could just as well be replaced by self::TRIPLEDES_CBC. Referencing local members with self:: assured the access will still work when the class is renamed, makes it perfectly clear that the member is in fact local and will usually be shorter.

Loading history...
35
			return $button;
36
		}
37
38
		if ( $network_button = NetworkButton::find_one_by_property( 'name', $name ) ) {
0 ignored issues
show
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...
39
			$network_button->id = $network_button->id . 'N';
40
			return $network_button;
41
		}
42
43
		return false;
44
45
	}
46
47
	/**
0 ignored issues
show
Coding Style Documentation introduced by
Doc comment for parameter "$settings" missing
Loading history...
48
	 * Returns either global buttons settings or the default settings
49
	 * @param  array
0 ignored issues
show
Coding Style introduced by
There must be exactly one blank line before the tags in a doc comment
Loading history...
Coding Style introduced by
Missing parameter name
Loading history...
50
	 * @return array
51
	 */
52
	public static function get_global_setting_with_fallback( $settings = array() ) {
0 ignored issues
show
Coding Style introduced by
Method name "Button::get_global_setting_with_fallback" is not in camel caps format
Loading history...
53
		foreach ( Defaults::options() as $property => $default ) {
54
			$settings[ $property ] = ( get_option( 'podlove_subscribe_button_default_' . $property ) ? get_option( 'podlove_subscribe_button_default_' . $property ) : $default );
55
		}
56
57
		return $settings;
58
	}
0 ignored issues
show
Coding Style introduced by
Expected 1 blank line before closing function brace; 0 found
Loading history...
59
60
	/**
0 ignored issues
show
Coding Style Documentation introduced by
Doc comment for parameter "$language" missing
Loading history...
61
	 * Gathers all information and renders the Subscribe button.
62
	 * @param  string  $size
0 ignored issues
show
Coding Style introduced by
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...
63
	 * @param  string  $autowidth
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
64
	 * @param  string  $style
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
65
	 * @param  string  $format
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
66
	 * @param  string  $color
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
67
	 * @param  boolean $hide
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
68
	 * @param  boolean $buttonid
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
69
	 * @return string
70
	 */
71
	public function render( $size = 'big', $autowidth = 'on', $style = 'filled', $format = 'rectangle', $color = '#599677', $hide = false, $buttonid = false, $language = 'en' ) {
72
		$button_styling = array_merge(
73
			$this->get_button_styling( $size, $autowidth, $style, $format, $color ),
74
			array(
75
				'hide'     => $hide,
76
				'buttonid' => $buttonid,
77
				'language' => $language,
78
			)
79
		);
80
81
		return $this->provide_button_html(
82
			array(
83
				'title'       => $this->title,
0 ignored issues
show
Bug Best Practice introduced by
The property title does not exist on PodloveSubscribeButton\Model\Button. Since you implemented __get, consider adding a @property annotation.
Loading history...
84
				'subtitle'    => $this->subtitle,
0 ignored issues
show
Bug Best Practice introduced by
The property subtitle does not exist on PodloveSubscribeButton\Model\Button. Since you implemented __get, consider adding a @property annotation.
Loading history...
85
				'description' => $this->description,
0 ignored issues
show
Bug Best Practice introduced by
The property description does not exist on PodloveSubscribeButton\Model\Button. Since you implemented __get, consider adding a @property annotation.
Loading history...
86
				'cover'       => $this->cover,
0 ignored issues
show
Bug Best Practice introduced by
The property cover does not exist on PodloveSubscribeButton\Model\Button. Since you implemented __get, consider adding a @property annotation.
Loading history...
87
				'feeds'       => $this->get_feeds_as_array( $this->feeds ),
0 ignored issues
show
Bug Best Practice introduced by
The property feeds does not exist on PodloveSubscribeButton\Model\Button. Since you implemented __get, consider adding a @property annotation.
Loading history...
88
			),
89
			$button_styling
90
		);
91
92
	}
93
94
	/**
0 ignored issues
show
Coding Style Documentation introduced by
Doc comment for parameter "$feeds" missing
Loading history...
95
	 * Provides the feed as an array in the required format
96
	 * @return array
0 ignored issues
show
Coding Style introduced by
There must be exactly one blank line before the tags in a doc comment
Loading history...
97
	 */
98
	private function get_feeds_as_array( $feeds = array() ) {
0 ignored issues
show
Coding Style introduced by
Method name "Button::get_feeds_as_array" is not in camel caps format
Loading history...
99
		foreach ( $feeds as $feed ) {
100
			if ( isset( Defaults::media_types()[ $feed['format'] ]['extension'] ) ) {
101
				$new_feed = array(
102
					'type'    => 'audio',
103
					'format'  => Defaults::media_types()[ $feed['format'] ]['extension'],
104
					'url'     => $feed['url'],
105
					'variant' => 'high',
106
				);
107
108
				if ( isset( $feed['itunesfeedid'] ) && $feed['itunesfeedid'] > 0 ) {
109
					$new_feed['directory-url-itunes'] = "https://itunes.apple.com/podcast/id" . $feed['itunesfeedid'];
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal https://itunes.apple.com/podcast/id 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...
110
				}
111
112
				$feeds[] = $new_feed;
113
114
			}
115
		}
116
117
		return $feeds;
118
119
	}
120
121
	/**
122
	 * Provides the HTML source of the Subscribe Button
123
	 * @param  array $podcast_data
0 ignored issues
show
Coding Style introduced by
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...
Coding Style introduced by
Expected 2 spaces after parameter type; 1 found
Loading history...
124
	 * @param  array $button_styling
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
Coding Style introduced by
Expected 2 spaces after parameter type; 1 found
Loading history...
125
	 * @param  string $data_attributes
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
126
	 * @return string
127
	 */
128
	private function provide_button_html( $podcast_data, $button_styling, $data_attributes = "" ) {
0 ignored issues
show
Coding Style introduced by
Method name "Button::provide_button_html" is not in camel caps format
Loading history...
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...
129
		// Create data attributes for Button
0 ignored issues
show
Coding Style introduced by
Inline comments must end in full-stops, exclamation marks, or question marks
Loading history...
130
		foreach ( $button_styling as $attribute => $value ) {
131
			$data_attributes .= 'data-' . $attribute . '="' . $value . '" ';
132
		}
133
134
		return"
0 ignored issues
show
Coding Style introduced by
Language constructs must be followed by a single space; expected "return "
" but found "return"
"
Loading history...
Coding Style Comprehensibility introduced by
The string literal \n <script>\n podcastData 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...
135
			<script>
136
				podcastData".$this->id . " = " . json_encode( $podcast_data ) . "
0 ignored issues
show
Coding Style introduced by
Concat operator must be surrounded by a single space
Loading history...
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...
introduced by
json_encode() is discouraged. Use wp_json_encode() instead.
Loading history...
Coding Style Comprehensibility introduced by
The string literal \n </script>\n <scri...n/javascripts/app.js\" 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...
137
			</script>
138
			<script 
139
				class=\"podlove-subscribe-button\" 
140
				src=\"https://cdn.podlove.org/subscribe-button/javascripts/app.js\" " . $data_attributes . ">
0 ignored issues
show
Coding Style Comprehensibility introduced by
The string literal >\n </script>\n 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...
141
			</script>
142
		";
143
144
	}
145
146
	/**
147
	 * Returns an array with either the set or default values
148
	 * @param  string $size
0 ignored issues
show
Coding Style introduced by
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...
149
	 * @param  string $autowidth
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
150
	 * @param  string $style
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
151
	 * @param  string $format
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
152
	 * @param  string $color
0 ignored issues
show
Coding Style Documentation introduced by
Missing parameter comment
Loading history...
153
	 * @return array
154
	 */
155
	public function get_button_styling( $size, $autowidth, $style, $format, $color ) {
0 ignored issues
show
Coding Style introduced by
Method name "Button::get_button_styling" is not in camel caps format
Loading history...
156
157
		return array(
158
				// $attribute => $value
0 ignored issues
show
Unused Code Comprehensibility introduced by
60% of this comment could be valid code. Did you maybe forget this after debugging?

Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.

The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.

This check looks for comments that seem to be mostly valid code and reports them.

Loading history...
introduced by
Array item not aligned correctly; expected 12 spaces but found 16
Loading history...
159
				'size' => ( $size == 'default' ? get_option( 'podlove_subscribe_button_default_size', $size ) : $size )
0 ignored issues
show
Bug introduced by
Are you sure $size == 'default' ? get...t_size', $size) : $size of type mixed|false|string can be used in concatenation? ( Ignorable by Annotation )

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

159
				'size' => ( /** @scrutinizer ignore-type */ $size == 'default' ? get_option( 'podlove_subscribe_button_default_size', $size ) : $size )
Loading history...
introduced by
Multi-line array item not aligned correctly; expected 12 spaces, but found 16
Loading history...
introduced by
Array double arrow not aligned correctly; expected 6 space(s) between "'size'" and double arrow, but found 1.
Loading history...
introduced by
Found: ==. Use strict comparisons (=== or !==).
Loading history...
introduced by
Use Yoda Condition checks, you must.
Loading history...
160
			 	. self::interpret_autowidth_attribute( $autowidth ),
161
				'style' => ( $style == 'default' ? get_option( 'podlove_subscribe_button_default_style', $style ) : $style ),
0 ignored issues
show
introduced by
Array item not aligned correctly; expected 12 spaces but found 16
Loading history...
introduced by
Array double arrow not aligned correctly; expected 5 space(s) between "'style'" and double arrow, but found 1.
Loading history...
introduced by
Found: ==. Use strict comparisons (=== or !==).
Loading history...
introduced by
Use Yoda Condition checks, you must.
Loading history...
162
				'format' => ( $format == 'default' ? get_option( 'podlove_subscribe_button_default_format', $format ) : $format ),
0 ignored issues
show
introduced by
Array item not aligned correctly; expected 12 spaces but found 16
Loading history...
introduced by
Array double arrow not aligned correctly; expected 4 space(s) between "'format'" and double arrow, but found 1.
Loading history...
introduced by
Found: ==. Use strict comparisons (=== or !==).
Loading history...
introduced by
Use Yoda Condition checks, you must.
Loading history...
163
				'color' => ( isset( $color ) ? $color : get_option( 'podlove_subscribe_button_default_color', $color ) ),
0 ignored issues
show
introduced by
Array item not aligned correctly; expected 12 spaces but found 16
Loading history...
introduced by
Array double arrow not aligned correctly; expected 5 space(s) between "'color'" and double arrow, but found 1.
Loading history...
164
				'json-data' => 'podcastData' . $this->id
0 ignored issues
show
introduced by
Array item not aligned correctly; expected 12 spaces but found 16
Loading history...
introduced by
Each array item in a multi-line array declaration must end in a comma
Loading history...
165
			);
0 ignored issues
show
introduced by
Array closer not aligned correctly; expected 8 space(s) but found 12
Loading history...
166
167
	}
168
169
	/**
170
	 * Helper function to interpret the given $autowidth value correctly
171
	 * @param  string $autowidth
0 ignored issues
show
Coding Style introduced by
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...
172
	 * @return string
173
	 */
174
	private static function interpret_autowidth_attribute( $autowidth ) {
0 ignored issues
show
Coding Style introduced by
Method name "Button::interpret_autowidth_attribute" is not in camel caps format
Loading history...
175
		if ( $autowidth == 'default' && get_option( 'podlove_subscribe_button_default_autowidth' ) !== 'on' )
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
Found: ==. Use strict comparisons (=== or !==).
Loading history...
introduced by
Use Yoda Condition checks, you must.
Loading history...
176
			return '';
177
178
		if ( $autowidth !== 'default' && $autowidth !== 'on' )
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
Use Yoda Condition checks, you must.
Loading history...
179
			return '';
180
181
		return ' auto';
182
183
	}
184
185
} // END class
186
187
Button::property( 'id', 'INT NOT NULL AUTO_INCREMENT PRIMARY KEY' );
188
Button::property( 'name', 'VARCHAR(255)' );
189
Button::property( 'title', 'VARCHAR(255)' );
190
Button::property( 'subtitle', 'VARCHAR(255)' );
191
Button::property( 'description', 'TEXT' );
192
Button::property( 'cover', 'VARCHAR(255)' );
193
Button::property( 'feeds', 'TEXT' );
194
Button::property( 'language', 'VARCHAR(2)' );
195