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