cfoellmann / podlove-subscribe-button-wp-plugin

model/button.php

<?php

This file is missing a doc comment.

namespace PodloveSubscribeButton\Model;

class Button extends Base {

Missing class doc comment

	public static $properties = array(

Missing member variable doc comment

		// $property => $default value
		'size' => 'big',
		'color' => '#599677',
		'autowidth' => 'on',
		'style' => 'filled',
		'format' => 'rectangle',
		'hide' => 'false',
		'buttonid' => ''
		// Note: the fields 'language' and 'json-data' cannot be set here (No function call allowed within class variables)

Inline comments must end in full-stops, exclamation marks, or question marks

	);

	public static $style = array(

Missing member variable doc comment

		'filled' => 'Filled',
		'outline' => 'Outline',
		'frameless' => 'Frameless'
	);

	public static $format = array(

Missing member variable doc comment

		'rectangle' => 'Rectangle',
		'square' => 'Square',
		'cover' => 'Cover'
	);

	public static $width = array(

Missing member variable doc comment

		'on' => 'Yes',
		'off' => 'No'
	);

	public static $size = array(

Missing member variable doc comment

		'small' => 'Small',
		'medium' => 'Medium',
		'big' => 'Big'
	);


	/**
	 * Fetches a Button or Network Button with a specific name
	 * @param  string $name

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

	 * @return object||FALSE
	 */
	public static function get_button_by_name($name) {

Expected 1 spaces between opening bracket and argument "$name"; 0 found

Method name "Button::get_button_by_name" is not in camel caps format

		if ( $button = \PodloveSubscribeButton\Model\Button::find_one_by_property('name', $name) ) {

Assignments must be the first block of code on a line

As per coding style, self should be used for accessing local static members.

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			return $button;
		}

		if ( $network_button = \PodloveSubscribeButton\Model\NetworkButton::find_one_by_property('name', $name) ) {

Assignments must be the first block of code on a line

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			$network_button->id = $network_button->id . 'N';
			return $network_button;
		}

		return false;
	}

Expected 1 blank line before closing function brace; 0 found

	/**

Doc comment for parameter "$settings" missing

	 * Returns either global buttons settings or the default settings 
	 * @param  array

There must be exactly one blank line before the tags in a doc comment

Missing parameter name

	 * @return array
	 */
	public static function get_global_setting_with_fallback( $settings=array() ) {

Method name "Button::get_global_setting_with_fallback" is not in camel caps format

Incorrect spacing between argument "$settings" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$settings"; expected 1 but found 0

		foreach (self::$properties as $property => $default) {
			$settings[$property] = ( get_option('podlove_subscribe_button_default_' . $property) ? get_option('podlove_subscribe_button_default_' . $property) : $default );

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

		}

		return $settings;
	}

Expected 1 blank line before closing function brace; 0 found

	/**

Doc comment for parameter "$language" missing

	 * Gathers all information and renders the Subscribe button.
	 * @param  string  $size

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

	 * @param  string  $autowidth

Missing parameter comment

	 * @param  string  $style

Missing parameter comment

	 * @param  string  $format

Missing parameter comment

	 * @param  string  $color

Missing parameter comment

	 * @param  boolean $hide

Missing parameter comment

	 * @param  boolean $buttonid

Missing parameter comment

	 * @return string
	 */
	public function render( $size='big', $autowidth='on', $style='filled', $format='rectangle', $color='#599677', $hide = false, $buttonid = false, $language='en' ) {

Incorrect spacing between argument "$size" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$size"; expected 1 but found 0

Incorrect spacing between argument "$autowidth" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$autowidth"; expected 1 but found 0

Incorrect spacing between argument "$style" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$style"; expected 1 but found 0

Incorrect spacing between argument "$format" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$format"; expected 1 but found 0

Incorrect spacing between argument "$color" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$color"; expected 1 but found 0

Incorrect spacing between argument "$language" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$language"; expected 1 but found 0

		$button_styling = array_merge(
				$this->get_button_styling($size, $autowidth, $style, $format, $color),

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

				array(

This line of the multi-line function call does not seem to be indented correctly. Expected 12 spaces, but found 16.

						'hide' => $hide,
						'buttonid' => $buttonid,
						'language' => $language
					)
			);

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.

		return $this->provide_button_html(
			array(
				'title' => $this->title,
				'subtitle' => $this->subtitle,
				'description' => $this->description,
				'cover' => $this->cover,
				'feeds' => $this->get_feeds_as_array($this->feeds)

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			), $button_styling );

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 12.

	}

Expected 1 blank line before closing function brace; 0 found

	/** 

Doc comment for parameter "$feeds" missing

	 * Provides the feed as an array in the required format
	 * @return array

There must be exactly one blank line before the tags in a doc comment

	 */
	private function get_feeds_as_array( $feeds=array() ) {

Method name "Button::get_feeds_as_array" is not in camel caps format

Incorrect spacing between argument "$feeds" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$feeds"; expected 1 but found 0

		foreach ($feeds as $feed) {
			if ( isset(\PodloveSubscribeButton\MediaTypes::$audio[$feed['format']]['extension']) ) {

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

				$new_feed = array(
						'type' => 'audio',
						'format' => \PodloveSubscribeButton\MediaTypes::$audio[$feed['format']]['extension'],
						'url' => $feed['url'],
						'variant' => 'high'
					);

				if ( isset($feed['itunesfeedid']) && $feed['itunesfeedid'] > 0 )

It is generally a best practice to always use braces with control structures.

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

					$new_feed['directory-url-itunes'] = "https://itunes.apple.com/podcast/id" . $feed['itunesfeedid'];

The string literal https://itunes.apple.com/podcast/id does not require double quotes, as per coding-style, please use single quotes.

				$feeds[] = $new_feed;
			}
		}

		return $feeds;
	}

Expected 1 blank line before closing function brace; 0 found

	/** 
	 * Provides the HTML source of the Subscribe Button
	 * @param  array $podcast_data

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

	 * @param  array $button_styling

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

	 * @param  string $data_attributes

Missing parameter comment

	 * @return string 
	 */
	private function provide_button_html($podcast_data, $button_styling, $data_attributes="") {

Expected 1 spaces between opening bracket and argument "$podcast_data"; 0 found

Method name "Button::provide_button_html" is not in camel caps format

Incorrect spacing between argument "$data_attributes" and equals sign; expected 1 but found 0

Incorrect spacing between default value and equals sign for argument "$data_attributes"; expected 1 but found 0

The string literal does not require double quotes, as per coding-style, please use single quotes.

		// Create data attributes for Button

Inline comments must end in full-stops, exclamation marks, or question marks

		foreach ($button_styling as $attribute => $value) {
			$data_attributes .= 'data-' . $attribute . '="' . $value . '" ';
		}

		return"

The string literal \n <script>\n podcastData does not require double quotes, as per coding-style, please use single quotes.

Language constructs must be followed by a single space; expected "return "
" but found "return"
"

			<script>
				podcastData".$this->id . " = ".json_encode($podcast_data)."

The string literal \n </script>\n <script \n class=\"podlove-subscribe-button\" \n src=\"https://cdn.podlove.org/subscribe-button/javascripts/app.js\" does not require double quotes, as per coding-style, please use single quotes.

Concat operator must be surrounded by a single space

The string literal = does not require double quotes, as per coding-style, please use single quotes.

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			</script>
			<script 
				class=\"podlove-subscribe-button\" 
				src=\"https://cdn.podlove.org/subscribe-button/javascripts/app.js\" " . $data_attributes . ">

The string literal >\n </script>\n does not require double quotes, as per coding-style, please use single quotes.

			</script>
		";
	}

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Returns an array with either the set or default values
	 * @param  string $size

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

	 * @param  string $autowidth

Missing parameter comment

	 * @param  string $style

Missing parameter comment

	 * @param  string $format

Missing parameter comment

	 * @param  string $color

Missing parameter comment

	 * @return array
	 */
	public function get_button_styling($size, $autowidth, $style, $format, $color) {

Expected 1 spaces between opening bracket and argument "$size"; 0 found

Method name "Button::get_button_styling" is not in camel caps format

		return array(
				// $attribute => $value
				'size' => ( $size == 'default' ? get_option('podlove_subscribe_button_default_size', $size) : $size )

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			 	. self::interpret_autowidth_attribute($autowidth),

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

				'style' => ( $style == 'default' ? get_option('podlove_subscribe_button_default_style', $style) : $style ),

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

				'format' => ( $format == 'default' ? get_option('podlove_subscribe_button_default_format', $format) : $format ),

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

				'color' => ( isset($color) ? $color : get_option('podlove_subscribe_button_default_color', $color) ),

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

				'json-data' => 'podcastData' . $this->id
			);
	}

Expected 1 blank line before closing function brace; 0 found

	/**
	 * Helper function to interpret the given $autowidth value correctly
	 * @param  string $autowidth

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

	 * @return string
	 */
	private static function interpret_autowidth_attribute($autowidth) {

Expected 1 spaces between opening bracket and argument "$autowidth"; 0 found

Method name "Button::interpret_autowidth_attribute" is not in camel caps format

		if ( $autowidth == 'default' && get_option('podlove_subscribe_button_default_autowidth') !== 'on' )

It is generally a best practice to always use braces with control structures.

Expected 1 spaces after opening bracket; 0 found

Expected 1 spaces before closing bracket; 0 found

			return '';

		if ( $autowidth !== 'default' && $autowidth !== 'on' )

It is generally a best practice to always use braces with control structures.

			return '';

		return ' auto';
	}

Expected 1 blank line before closing function brace; 0 found

}

Button::property( 'id', 'INT NOT NULL AUTO_INCREMENT PRIMARY KEY' );
Button::property( 'name', 'VARCHAR(255)' );
Button::property( 'title', 'VARCHAR(255)' );
Button::property( 'subtitle', 'VARCHAR(255)' );
Button::property( 'description', 'TEXT' );
Button::property( 'cover', 'VARCHAR(255)' );
Button::property( 'feeds', 'TEXT' );