MonsterInsights_Popular_Posts_Widget::maybe_auto_insert() - Code Metrics - awesomemotive/google-analytics-for-wordpress - Measure and Improve Code Quality continuously with Scrutinizer

maybe_auto_insert() A
last analyzed 2024-09-24 18:01 UTC

↳ Parent: MonsterInsights_Popular_Posts_Widget

Complexity

Conditions	4
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	4
eloc	3
c	3
b	0
f	0
nc	2
nop	0
dl	0
loc	5
rs	10

<?php
/**
 * Code specific to the widget Popular Posts widget type.
 */

/**
 * Class MonsterInsights_Popular_Posts_Widget
 */
class MonsterInsights_Popular_Posts_Widget extends MonsterInsights_Popular_Posts {

	/**
	 * The instance type. Used for loading specific settings.
	 *
	 * @var string
	 */
	protected $type = 'widget';

	/**
	 * Used to load the setting specific for this class.
	 *
	 * @var string
	 */
	protected $settings_key = 'popular_posts_widget';

	/**
	 * Used for registering the shortcode specific to this class.
	 *
	 * @var string
	 */
	protected $shortcode_key = 'monsterinsights_popular_posts_widget';

	/**
	 * Widget-specific hooks.
	 */
	public function hooks() {
		parent::hooks();

		add_action( 'wp', array( $this, 'maybe_auto_insert' ) );

		add_action( 'widgets_init', array( $this, 'register_widget' ) );
		add_filter( 'widget_types_to_hide_from_legacy_widget_block', array(
			$this,
			'remove_widget_from_legacy_widgets'
		) );
	}


	/**
	 * Register Popular Posts widget.
	 */
	public function register_widget() {
		register_widget( 'MonsterInsights_Popular_Posts_Widget_Sidebar' );
	}

	/**
	 * Get the rendered HTML for output.
	 *
	 * @param array $atts These are attributes used to build the specific instance, they can be either shortcode
	 * attributes or Gutenberg block props.
	 *
	 * @return string
	 */
	public function get_rendered_html( $atts ) {

		$theme = $this->theme;

		if ( ! empty( $atts['theme'] ) ) {
			$theme = $atts['theme'];
		}

		$theme = $this->is_theme_available( $theme );

		if ( ! empty( $atts['post_count'] ) ) {
			$limit = intval( $atts['post_count'] );
		} else {
			$limit = $this->count;

		}

		$posts = $this->get_posts_to_display();

		if ( empty( $posts ) ) {
			return '';
		}

		if ( 'curated' === $this->sort && apply_filters( 'monsterinsights_popular_posts_widget_curated_shuffle', true ) ) {

			// Randomize the order.
			shuffle( $posts );
		}

		$theme_styles = $this->get_theme_props( $theme )->get_theme();

		$label_text = '';
		if ( isset( $theme_styles['styles']['label'] ) ) {
			$label_text = isset( $atts['label_text'] ) ? esc_html($atts['label_text']) : esc_html($theme_styles['styles']['label']['text']);
		}

		if ( isset( $atts['widget_title'] ) ) {
			$show_title = (bool) $atts['widget_title'];
			$title_text = empty( $atts['widget_title_text'] ) ? '' : $atts['widget_title_text'];
		} else {
			$show_title = $this->title;

			$title_text = $this->title_text;

		}

		$html = '<div class="' . esc_attr($this->get_wrapper_class( $atts )) . '">';
		if ( $show_title ) {
			$html .= '<h2 class="monsterinsights-widget-popular-posts-widget-title">' . esc_html( $title_text ) . '</h2>';
		}

		$html .= '<ul class="monsterinsights-widget-popular-posts-list">';

		$display_count = 0;
		foreach ( $posts as $post ) {
			$display_count ++;
			if ( $display_count > $limit ) {
				break;
			}
			$this->set_post_shown( $post['id'] );
			$html .= '<li ';
			$html .= ! empty( $this->get_element_style( $theme, 'background', $atts ) ) ? 'style="' . esc_attr( $this->get_element_style( $theme, 'background', $atts ) ) . '"' : '';
			$html .= '>';
			$html .= '<a href="' . esc_url($post['link']) . '">';
			if ( ! empty( $theme_styles['image'] ) && ! empty( $post['image'] ) ) {
				$html .= '<div class="monsterinsights-widget-popular-posts-image">';
				$html .= '<img src="' . esc_url($post['image']) . '" srcset=" ' . esc_attr($post['srcset']) . ' " alt="' . esc_attr( $post['title'] ) . '" />';
				$html .= '</div>';
			}
			$html .= '<div class="monsterinsights-widget-popular-posts-text">';
			if ( isset( $theme_styles['styles']['label'] ) ) {
				$html .= '<span class="monsterinsights-widget-popular-posts-label" ';
				$html .= ! empty( $this->get_element_style( $theme, 'label', $atts ) ) ? 'style="' . esc_attr( $this->get_element_style( $theme, 'label', $atts ) ) . '"' : '';
				$html .= '>' . esc_html( $label_text ) . '</span>';
			}
			$html .= '<span class="monsterinsights-widget-popular-posts-title" ';
			$html .= ! empty( $this->get_element_style( $theme, 'title', $atts ) ) ? 'style="' . esc_attr( $this->get_element_style( $theme, 'title', $atts ) ) . '"' : '';
			$html .= '>' . esc_html( $post['title'] ) . '</span>';
			$html .= '</div>'; // monsterinsights-widget-popular-posts-text.
			$html .= '</a>';
			$html .= '</li>';
		}

		$html .= '</ul></div><p></p>';// Main div.

		return $html;

	}

	/**
	 * Add widget-specific styles based on theme settings.
	 */
	public function build_inline_styles() {

		$themes = $this->get_themes_styles_for_output();
		$styles = '';

		foreach ( $themes as $theme_key => $theme_styles ) {

			if ( ! empty( $theme_styles['background'] ) ) {
				$styles .= '.monsterinsights-popular-posts-styled.monsterinsights-widget-popular-posts.monsterinsights-widget-popular-posts-' . esc_attr($theme_key) . ' .monsterinsights-widget-popular-posts-list li {';

				if ( ! empty( $theme_styles['background']['color'] ) ) {
					$styles .= 'background-color:' . esc_attr($theme_styles['background']['color']) . ';';
				}
				if ( ! empty( $theme_styles['background']['border'] ) ) {
					$styles .= 'border-color:' . esc_attr($theme_styles['background']['border']) . ';';
				}

				$styles .= '}';
			}

			if ( ! empty( $theme_styles['label'] ) ) {
				$styles .= '.monsterinsights-popular-posts-styled.monsterinsights-widget-popular-posts.monsterinsights-widget-popular-posts-' . esc_attr($theme_key) . ' .monsterinsights-widget-popular-posts-label {';

				if ( ! empty( $theme_styles['label']['color'] ) ) {
					$styles .= 'color:' . esc_attr($theme_styles['label']['color']) . ';';
				}

				if ( ! empty( $theme_styles['label']['background'] ) ) {
					$styles .= 'background-color:' . esc_attr($theme_styles['label']['background']) . ';';
				}

				$styles .= '}';
			}

			if ( ! empty( $theme_styles['title'] ) ) {
				$styles .= '.monsterinsights-popular-posts-styled.monsterinsights-widget-popular-posts.monsterinsights-widget-popular-posts-' . esc_attr($theme_key) . ' .monsterinsights-widget-popular-posts-list li .monsterinsights-widget-popular-posts-title {';

				if ( ! empty( $theme_styles['title']['color'] ) ) {
					$styles .= 'color:' . esc_attr($theme_styles['title']['color']) . ';';
				}
				if ( ! empty( $theme_styles['title']['size'] ) ) {
					$styles .= 'font-size:' . esc_attr($theme_styles['title']['size']) . 'px;';
				}

				$styles .= '}';
			}

			if ( ! empty( $theme_styles['border'] ) ) {
				$styles .= '.monsterinsights-popular-posts-styled.monsterinsights-widget-popular-posts-' . esc_attr($theme_key) . ' .monsterinsights-inline-popular-posts-border {';

				if ( ! empty( $theme_styles['border']['color'] ) ) {
					$styles .= 'border-color:' . esc_attr($theme_styles['border']['color']) . ';';
				}

				$styles .= '}';
			}
		}

		return $styles;
	}

	/**
	 * Check if we should attempt to automatically insert the inline widget.
	 */
	public function maybe_auto_insert() {

		$post_types = $this->post_types;

		if ( ! empty( $post_types ) && is_singular( $post_types ) && $this->automatic ) {

			add_filter( 'the_content', array( $this, 'add_inline_posts_to_content' ) );
		}

	}

	/**
	 * Insert the widget in the content.
	 *
	 * @param string $content The post content.
	 *
	 * @return string
	 */
	public function add_inline_posts_to_content( $content ) {

		if ( $this->is_post_excluded() ) {
			return $content;
		}

		$content .= $this->shortcode_output( array() );

		return $content;
	}

	/**
	 * Check if the selected theme is available with the current license to avoid showing a theme not available.
	 * Returns the default 'alpha' theme if not available.
	 *
	 * @param string $theme Theme slug for which we are checking.
	 *
	 * @return string
	 */
	public function is_theme_available( $theme ) {

		$theme_props = $this->get_theme_props( $theme )->get_theme();

		if ( ! empty( $theme_props['level'] ) && 'lite' === $theme_props['level'] ) {
			return $theme;
		}

		return 'alpha';

	}

	/**
	 * Remove this widget from legacy widgets not to have duplications.
	 *
	 * @param string[] $widgets An array of excluded widget-type IDs.
	 *
	 * @return mixed
	 */
	public function remove_widget_from_legacy_widgets( $widgets ) {
		// $widgets[] = 'monsterinsights-popular-posts-widget';

		return $widgets;
	}

}

/**
 * Get the current class in a function.
 *
 * @return MonsterInsights_Popular_Posts_Widget Instance of the current class.
 */
function MonsterInsights_Popular_Posts_Widget() {
	return MonsterInsights_Popular_Posts_Widget::get_instance();
}

MonsterInsights_Popular_Posts_Widget();


1			<?php
2			/**
3			* Code specific to the widget Popular Posts widget type.
4			*/
5
6			/**
7			* Class MonsterInsights_Popular_Posts_Widget
8			*/
9			class MonsterInsights_Popular_Posts_Widget extends MonsterInsights_Popular_Posts {
10
11			/**
12			* The instance type. Used for loading specific settings.
13			*
14			* @var string
15			*/
16			protected $type = 'widget';
17
18			/**
19			* Used to load the setting specific for this class.
20			*
21			* @var string
22			*/
23			protected $settings_key = 'popular_posts_widget';
24
25			/**
26			* Used for registering the shortcode specific to this class.
27			*
28			* @var string
29			*/
30			protected $shortcode_key = 'monsterinsights_popular_posts_widget';
31
32			/**
33			* Widget-specific hooks.
34			*/
35			public function hooks() {
36			parent::hooks();
37
38			add_action( 'wp', array( $this, 'maybe_auto_insert' ) );
39
40			add_action( 'widgets_init', array( $this, 'register_widget' ) );
41			add_filter( 'widget_types_to_hide_from_legacy_widget_block', array(
42			$this,
43			'remove_widget_from_legacy_widgets'
44			) );
45			}
46
47
48			/**
49			* Register Popular Posts widget.
50			*/
51			public function register_widget() {
52			register_widget( 'MonsterInsights_Popular_Posts_Widget_Sidebar' );
53			}
54
55			/**
56			* Get the rendered HTML for output.
57			*
58			* @param array $atts These are attributes used to build the specific instance, they can be either shortcode
59			* attributes or Gutenberg block props.
60			*
61			* @return string
62			*/
63			public function get_rendered_html( $atts ) {
64
65			$theme = $this->theme;
			0 ignored issues – show Bug Best Practice introduced 2020-11-05 15:12 UTC by Report Bug Copy Issue Report The property `theme` does not exist on `MonsterInsights_Popular_Posts_Widget`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
66			if ( ! empty( $atts['theme'] ) ) {
67			$theme = $atts['theme'];
68			}
69
70			$theme = $this->is_theme_available( $theme );
71
72			if ( ! empty( $atts['post_count'] ) ) {
73			$limit = intval( $atts['post_count'] );
74			} else {
75			$limit = $this->count;
			0 ignored issues – show Bug Best Practice introduced 2020-11-05 15:12 UTC by Report Bug Copy Issue Report The property `count` does not exist on `MonsterInsights_Popular_Posts_Widget`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
76			}
77
78			$posts = $this->get_posts_to_display();
79
80			if ( empty( $posts ) ) {
81			return '';
82			}
83
84			if ( 'curated' === $this->sort && apply_filters( 'monsterinsights_popular_posts_widget_curated_shuffle', true ) ) {
			0 ignored issues – show Bug Best Practice introduced 2021-03-23 09:37 UTC by Report Bug Copy Issue Report The property `sort` does not exist on `MonsterInsights_Popular_Posts_Widget`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
85			// Randomize the order.
86			shuffle( $posts );
87			}
88
89			$theme_styles = $this->get_theme_props( $theme )->get_theme();
90
91			$label_text = '';
92			if ( isset( $theme_styles['styles']['label'] ) ) {
93			$label_text = isset( $atts['label_text'] ) ? esc_html($atts['label_text']) : esc_html($theme_styles['styles']['label']['text']);
94			}
95
96			if ( isset( $atts['widget_title'] ) ) {
97			$show_title = (bool) $atts['widget_title'];
98			$title_text = empty( $atts['widget_title_text'] ) ? '' : $atts['widget_title_text'];
99			} else {
100			$show_title = $this->title;
			0 ignored issues – show Bug Best Practice introduced 2020-11-05 15:12 UTC by Report Bug Copy Issue Report The property `title` does not exist on `MonsterInsights_Popular_Posts_Widget`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
101			$title_text = $this->title_text;
			0 ignored issues – show Bug Best Practice introduced 2020-11-05 15:12 UTC by Report Bug Copy Issue Report The property `title_text` does not exist on `MonsterInsights_Popular_Posts_Widget`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
102			}
103
104			$html = '<div class="' . esc_attr($this->get_wrapper_class( $atts )) . '">';
105			if ( $show_title ) {
106			$html .= '<h2 class="monsterinsights-widget-popular-posts-widget-title">' . esc_html( $title_text ) . '</h2>';
107			}
108
109			$html .= '<ul class="monsterinsights-widget-popular-posts-list">';
110
111			$display_count = 0;
112			foreach ( $posts as $post ) {
113			$display_count ++;
114			if ( $display_count > $limit ) {
115			break;
116			}
117			$this->set_post_shown( $post['id'] );
118			$html .= '<li ';
119			$html .= ! empty( $this->get_element_style( $theme, 'background', $atts ) ) ? 'style="' . esc_attr( $this->get_element_style( $theme, 'background', $atts ) ) . '"' : '';
120			$html .= '>';
121			$html .= '<a href="' . esc_url($post['link']) . '">';
122			if ( ! empty( $theme_styles['image'] ) && ! empty( $post['image'] ) ) {
123			$html .= '<div class="monsterinsights-widget-popular-posts-image">';
124			$html .= '<img src="' . esc_url($post['image']) . '" srcset=" ' . esc_attr($post['srcset']) . ' " alt="' . esc_attr( $post['title'] ) . '" />';
125			$html .= '</div>';
126			}
127			$html .= '<div class="monsterinsights-widget-popular-posts-text">';
128			if ( isset( $theme_styles['styles']['label'] ) ) {
129			$html .= '<span class="monsterinsights-widget-popular-posts-label" ';
130			$html .= ! empty( $this->get_element_style( $theme, 'label', $atts ) ) ? 'style="' . esc_attr( $this->get_element_style( $theme, 'label', $atts ) ) . '"' : '';
131			$html .= '>' . esc_html( $label_text ) . '</span>';
132			}
133			$html .= '<span class="monsterinsights-widget-popular-posts-title" ';
134			$html .= ! empty( $this->get_element_style( $theme, 'title', $atts ) ) ? 'style="' . esc_attr( $this->get_element_style( $theme, 'title', $atts ) ) . '"' : '';
135			$html .= '>' . esc_html( $post['title'] ) . '</span>';
136			$html .= '</div>'; // monsterinsights-widget-popular-posts-text.
137			$html .= '</a>';
138			$html .= '</li>';
139			}
140
141			$html .= '</ul></div><p></p>';// Main div.
142
143			return $html;
144
145			}
146
147			/**
148			* Add widget-specific styles based on theme settings.
149			*/
150			public function build_inline_styles() {
151
152			$themes = $this->get_themes_styles_for_output();
153			$styles = '';
154
155			foreach ( $themes as $theme_key => $theme_styles ) {
156
157			if ( ! empty( $theme_styles['background'] ) ) {
158			$styles .= '.monsterinsights-popular-posts-styled.monsterinsights-widget-popular-posts.monsterinsights-widget-popular-posts-' . esc_attr($theme_key) . ' .monsterinsights-widget-popular-posts-list li {';
159
160			if ( ! empty( $theme_styles['background']['color'] ) ) {
161			$styles .= 'background-color:' . esc_attr($theme_styles['background']['color']) . ';';
162			}
163			if ( ! empty( $theme_styles['background']['border'] ) ) {
164			$styles .= 'border-color:' . esc_attr($theme_styles['background']['border']) . ';';
165			}
166
167			$styles .= '}';
168			}
169
170			if ( ! empty( $theme_styles['label'] ) ) {
171			$styles .= '.monsterinsights-popular-posts-styled.monsterinsights-widget-popular-posts.monsterinsights-widget-popular-posts-' . esc_attr($theme_key) . ' .monsterinsights-widget-popular-posts-label {';
172
173			if ( ! empty( $theme_styles['label']['color'] ) ) {
174			$styles .= 'color:' . esc_attr($theme_styles['label']['color']) . ';';
175			}
176
177			if ( ! empty( $theme_styles['label']['background'] ) ) {
178			$styles .= 'background-color:' . esc_attr($theme_styles['label']['background']) . ';';
179			}
180
181			$styles .= '}';
182			}
183
184			if ( ! empty( $theme_styles['title'] ) ) {
185			$styles .= '.monsterinsights-popular-posts-styled.monsterinsights-widget-popular-posts.monsterinsights-widget-popular-posts-' . esc_attr($theme_key) . ' .monsterinsights-widget-popular-posts-list li .monsterinsights-widget-popular-posts-title {';
186
187			if ( ! empty( $theme_styles['title']['color'] ) ) {
188			$styles .= 'color:' . esc_attr($theme_styles['title']['color']) . ';';
189			}
190			if ( ! empty( $theme_styles['title']['size'] ) ) {
191			$styles .= 'font-size:' . esc_attr($theme_styles['title']['size']) . 'px;';
192			}
193
194			$styles .= '}';
195			}
196
197			if ( ! empty( $theme_styles['border'] ) ) {
198			$styles .= '.monsterinsights-popular-posts-styled.monsterinsights-widget-popular-posts-' . esc_attr($theme_key) . ' .monsterinsights-inline-popular-posts-border {';
199
200			if ( ! empty( $theme_styles['border']['color'] ) ) {
201			$styles .= 'border-color:' . esc_attr($theme_styles['border']['color']) . ';';
202			}
203
204			$styles .= '}';
205			}
206			}
207
208			return $styles;
209			}
210
211			/**
212			* Check if we should attempt to automatically insert the inline widget.
213			*/
214			public function maybe_auto_insert() {
215
216			$post_types = $this->post_types;
			0 ignored issues – show Bug Best Practice introduced 2020-11-05 15:12 UTC by Report Bug Copy Issue Report The property `post_types` does not exist on `MonsterInsights_Popular_Posts_Widget`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
217			if ( ! empty( $post_types ) && is_singular( $post_types ) && $this->automatic ) {
			0 ignored issues – show Bug Best Practice introduced 2020-11-05 15:12 UTC by Report Bug Copy Issue Report The property `automatic` does not exist on `MonsterInsights_Popular_Posts_Widget`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
218			add_filter( 'the_content', array( $this, 'add_inline_posts_to_content' ) );
219			}
220
221			}
222
223			/**
224			* Insert the widget in the content.
225			*
226			* @param string $content The post content.
227			*
228			* @return string
229			*/
230			public function add_inline_posts_to_content( $content ) {
231
232			if ( $this->is_post_excluded() ) {
233			return $content;
234			}
235
236			$content .= $this->shortcode_output( array() );
237
238			return $content;
239			}
240
241			/**
242			* Check if the selected theme is available with the current license to avoid showing a theme not available.
243			* Returns the default 'alpha' theme if not available.
244			*
245			* @param string $theme Theme slug for which we are checking.
246			*
247			* @return string
248			*/
249			public function is_theme_available( $theme ) {
250
251			$theme_props = $this->get_theme_props( $theme )->get_theme();
252
253			if ( ! empty( $theme_props['level'] ) && 'lite' === $theme_props['level'] ) {
254			return $theme;
255			}
256
257			return 'alpha';
258
259			}
260
261			/**
262			* Remove this widget from legacy widgets not to have duplications.
263			*
264			* @param string[] $widgets An array of excluded widget-type IDs.
265			*
266			* @return mixed
267			*/
268			public function remove_widget_from_legacy_widgets( $widgets ) {
269			// $widgets[] = 'monsterinsights-popular-posts-widget';
270
271			return $widgets;
272			}
273
274			}
275
276			/**
277			* Get the current class in a function.
278			*
279			* @return MonsterInsights_Popular_Posts_Widget Instance of the current class.
280			*/
281			function MonsterInsights_Popular_Posts_Widget() {
282			return MonsterInsights_Popular_Posts_Widget::get_instance();
283			}
284
285			MonsterInsights_Popular_Posts_Widget();
286

awesomemotive / google-analytics-for-wordpress

maybe_auto_insert() A last analyzed 2024-09-24 18:01 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

maybe_auto_insert() A
last analyzed 2024-09-24 18:01 UTC