1 | <?php |
||
0 ignored issues
–
show
Coding Style
introduced
by
![]() |
|||
2 | namespace PodloveSubscribeButton\Model; |
||
3 | |||
4 | class Button extends Base { |
||
0 ignored issues
–
show
|
|||
5 | |||
6 | public static $properties = array( |
||
0 ignored issues
–
show
|
|||
7 | // $property => $default value |
||
8 | 'size' => 'big', |
||
9 | 'color' => '#599677', |
||
10 | 'autowidth' => 'on', |
||
11 | 'style' => 'filled', |
||
12 | 'format' => 'rectangle', |
||
13 | 'hide' => 'false' |
||
14 | // Note: the fields 'language' and 'json-data' cannot be set here (No function call allowed within class variables) |
||
0 ignored issues
–
show
|
|||
15 | ); |
||
16 | |||
17 | public static $style = array( |
||
0 ignored issues
–
show
|
|||
18 | 'filled' => 'Filled', |
||
19 | 'outline' => 'Outline', |
||
20 | 'frameless' => 'Frameless' |
||
21 | ); |
||
22 | |||
23 | public static $format = array( |
||
0 ignored issues
–
show
|
|||
24 | 'rectangle' => 'Rectangle', |
||
25 | 'square' => 'Square', |
||
26 | 'cover' => 'Cover' |
||
27 | ); |
||
28 | |||
29 | public static $width = array( |
||
0 ignored issues
–
show
|
|||
30 | 'on' => 'Yes', |
||
31 | 'off' => 'No' |
||
32 | ); |
||
33 | |||
34 | public static $size = array( |
||
0 ignored issues
–
show
|
|||
35 | 'small' => 'Small', |
||
36 | 'medium' => 'Medium', |
||
37 | 'big' => 'Big' |
||
38 | ); |
||
39 | |||
40 | |||
41 | /** |
||
42 | * Fetches a Button or Network Button with a specific name |
||
43 | * @param string $name |
||
0 ignored issues
–
show
|
|||
44 | * @return object||FALSE |
||
45 | */ |
||
46 | public static function get_button_by_name($name) { |
||
0 ignored issues
–
show
|
|||
47 | if ( $button = \PodloveSubscribeButton\Model\Button::find_one_by_property('name', $name) ) { |
||
0 ignored issues
–
show
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 <?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 ![]() |
|||
48 | return $button; |
||
49 | } |
||
50 | |||
51 | if ( $network_button = \PodloveSubscribeButton\Model\NetworkButton::find_one_by_property('name', $name) ) { |
||
0 ignored issues
–
show
|
|||
52 | $network_button->id = $network_button->id . 'N'; |
||
53 | return $network_button; |
||
54 | } |
||
55 | |||
56 | return false; |
||
57 | } |
||
0 ignored issues
–
show
|
|||
58 | |||
59 | /** |
||
0 ignored issues
–
show
|
|||
60 | * Returns either global buttons settings or the default settings |
||
61 | * @param array |
||
0 ignored issues
–
show
|
|||
62 | * @return array |
||
63 | */ |
||
64 | public static function get_global_setting_with_fallback( $settings=array() ) { |
||
0 ignored issues
–
show
|
|||
65 | foreach (self::$properties as $property => $default) { |
||
66 | $settings[$property] = ( get_option('podlove_subscribe_button_default_' . $property) ? get_option('podlove_subscribe_button_default_' . $property) : $default ); |
||
0 ignored issues
–
show
|
|||
67 | } |
||
68 | |||
69 | return $settings; |
||
70 | } |
||
0 ignored issues
–
show
|
|||
71 | |||
72 | /** |
||
0 ignored issues
–
show
|
|||
73 | * Gathers all information and renders the Subscribe button. |
||
74 | * @param string $size |
||
0 ignored issues
–
show
|
|||
75 | * @param string $autowidth |
||
0 ignored issues
–
show
|
|||
76 | * @param string $style |
||
0 ignored issues
–
show
|
|||
77 | * @param string $format |
||
0 ignored issues
–
show
|
|||
78 | * @param string $color |
||
0 ignored issues
–
show
|
|||
79 | * @param boolean $hide |
||
0 ignored issues
–
show
|
|||
80 | * @return string |
||
81 | */ |
||
82 | public function render( $size='big', $autowidth='on', $style='filled', $format='rectangle', $color='#599677', $hide = false, $buttonid = false, $language='en' ) { |
||
0 ignored issues
–
show
|
|||
83 | $button_styling = array_merge( |
||
84 | $this->get_button_styling($size, $autowidth, $style, $format, $color), |
||
0 ignored issues
–
show
|
|||
85 | array( |
||
0 ignored issues
–
show
|
|||
86 | 'hide' => $hide, |
||
87 | 'language' => $language |
||
88 | ) |
||
89 | ); |
||
0 ignored issues
–
show
|
|||
90 | |||
91 | return $this->provide_button_html( |
||
92 | array( |
||
93 | 'title' => sanitize_text_field($this->title), |
||
0 ignored issues
–
show
|
|||
94 | 'subtitle' => sanitize_text_field($this->subtitle), |
||
0 ignored issues
–
show
|
|||
95 | 'description' => sanitize_textarea_field($this->description), |
||
0 ignored issues
–
show
|
|||
96 | 'cover' => sanitize_text_field($this->cover), |
||
0 ignored issues
–
show
|
|||
97 | 'feeds' => $this->get_feeds_as_array($this->feeds) |
||
0 ignored issues
–
show
|
|||
98 | ), $button_styling ); |
||
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.
![]() |
|||
99 | } |
||
0 ignored issues
–
show
|
|||
100 | |||
101 | /** |
||
0 ignored issues
–
show
|
|||
102 | * Provides the feed as an array in the required format |
||
103 | * @return array |
||
0 ignored issues
–
show
|
|||
104 | */ |
||
105 | private function get_feeds_as_array( $feeds=array() ) { |
||
0 ignored issues
–
show
|
|||
106 | $returnedFeeds = array(); |
||
107 | |||
108 | if (! $feeds) |
||
0 ignored issues
–
show
|
|||
109 | return $returnedFeeds; |
||
110 | |||
111 | foreach ($feeds as $feed) { |
||
112 | if ( isset(\PodloveSubscribeButton\MediaTypes::$audio[$feed['format']]['extension']) ) { |
||
0 ignored issues
–
show
|
|||
113 | $new_feed = array( |
||
114 | 'type' => 'audio', |
||
115 | 'format' => \PodloveSubscribeButton\MediaTypes::$audio[$feed['format']]['extension'], |
||
116 | 'url' => $feed['url'], |
||
117 | 'variant' => 'high' |
||
118 | ); |
||
119 | |||
120 | if ( isset($feed['itunesfeedid']) && $feed['itunesfeedid'] > 0 ) |
||
0 ignored issues
–
show
|
|||
121 | $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 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. ![]() |
|||
122 | |||
123 | $returnedFeeds[] = $new_feed; |
||
124 | } |
||
125 | } |
||
126 | |||
127 | return $returnedFeeds; |
||
128 | } |
||
0 ignored issues
–
show
|
|||
129 | |||
130 | /** |
||
131 | * Provides the HTML source of the Subscribe Button |
||
132 | * @param array $podcast_data |
||
0 ignored issues
–
show
|
|||
133 | * @param array $button_styling |
||
0 ignored issues
–
show
|
|||
134 | * @param string $data_attributes |
||
0 ignored issues
–
show
|
|||
135 | * @return string |
||
136 | */ |
||
137 | private function provide_button_html($podcast_data, $button_styling, $data_attributes="") { |
||
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 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. ![]() |
|||
138 | // Create data attributes for Button |
||
0 ignored issues
–
show
|
|||
139 | foreach ($button_styling as $attribute => $value) { |
||
140 | $data_attributes .= 'data-' . $attribute . '="' . $value . '" '; |
||
141 | } |
||
142 | |||
143 | return" |
||
0 ignored issues
–
show
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 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. ![]() |
|||
144 | <script> |
||
145 | podcastData".$this->id . " = ".json_encode($podcast_data)." |
||
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 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. ![]() 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 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. ![]() |
|||
146 | </script> |
||
147 | <script |
||
148 | class=\"podlove-subscribe-button\" |
||
149 | 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 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. ![]() |
|||
150 | </script> |
||
151 | "; |
||
152 | } |
||
0 ignored issues
–
show
|
|||
153 | |||
154 | /** |
||
155 | * Returns an array with either the set or default values |
||
156 | * @param string $size |
||
0 ignored issues
–
show
|
|||
157 | * @param string $autowidth |
||
0 ignored issues
–
show
|
|||
158 | * @param string $style |
||
0 ignored issues
–
show
|
|||
159 | * @param string $format |
||
0 ignored issues
–
show
|
|||
160 | * @param string $color |
||
0 ignored issues
–
show
|
|||
161 | * @return array |
||
162 | */ |
||
163 | public function get_button_styling($size, $autowidth, $style, $format, $color) { |
||
0 ignored issues
–
show
|
|||
164 | |||
165 | return array( |
||
166 | // $attribute => $value |
||
167 | 'size' => ( $size == 'default' ? get_option('podlove_subscribe_button_default_size', $size) : $size ) |
||
0 ignored issues
–
show
|
|||
168 | . self::interpret_autowidth_attribute($autowidth), |
||
0 ignored issues
–
show
|
|||
169 | 'style' => ( $style == 'default' ? get_option('podlove_subscribe_button_default_style', $style) : $style ), |
||
0 ignored issues
–
show
|
|||
170 | 'format' => ( $format == 'default' ? get_option('podlove_subscribe_button_default_format', $format) : $format ), |
||
0 ignored issues
–
show
|
|||
171 | 'color' => ( isset($color) ? $color : get_option('podlove_subscribe_button_default_color', $color) ), |
||
0 ignored issues
–
show
|
|||
172 | 'json-data' => 'podcastData' . $this->id |
||
173 | ); |
||
174 | } |
||
0 ignored issues
–
show
|
|||
175 | |||
176 | /** |
||
177 | * Helper function to interpret the given $autowidth value correctly |
||
178 | * @param string $autowidth |
||
0 ignored issues
–
show
|
|||
179 | * @return string |
||
180 | */ |
||
181 | private static function interpret_autowidth_attribute($autowidth) { |
||
0 ignored issues
–
show
|
|||
182 | if ( $autowidth == 'default' && get_option('podlove_subscribe_button_default_autowidth') !== 'on' ) |
||
0 ignored issues
–
show
|
|||
183 | return ''; |
||
184 | |||
185 | if ( $autowidth !== 'default' && $autowidth !== 'on' ) |
||
0 ignored issues
–
show
|
|||
186 | return ''; |
||
187 | |||
188 | return ' auto'; |
||
189 | } |
||
0 ignored issues
–
show
|
|||
190 | } |
||
191 | |||
192 | Button::property( 'id', 'INT NOT NULL AUTO_INCREMENT PRIMARY KEY' ); |
||
193 | Button::property( 'name', 'VARCHAR(255)' ); |
||
194 | Button::property( 'title', 'VARCHAR(255)' ); |
||
195 | Button::property( 'subtitle', 'VARCHAR(255)' ); |
||
196 | Button::property( 'description', 'TEXT' ); |
||
197 | Button::property( 'cover', 'VARCHAR(255)' ); |
||
198 | Button::property( 'feeds', 'TEXT' ); |
||
199 |