Issues (1386)

model/button.php (7 issues)

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