View_Counter.php — Independent Analytics – WordPress Analytics Plugin 2.11.9

independent-analytics / IAWP / View_Counter.php

independent-analytics / IAWP Last commit date

AJAX 1 year ago Admin_Page 1 year ago Click_Tracking 1 year ago Custom_WordPress_Columns 1 year ago Data_Pruning 1 year ago Date_Picker 1 year ago Date_Range 1 year ago Ecommerce 1 year ago Email_Reports 1 year ago Filter_Lists 1 year ago Form_Submissions 1 year ago Integrations 1 year ago Interval 1 year ago Menu_Bar_Stats 1 year ago Migrations 1 year ago Models 1 year ago Overview 1 year ago Public_API 1 year ago Rows 1 year ago Statistics 1 year ago Tables 1 year ago Utils 1 year ago Appearance.php 1 year ago Campaign_Builder.php 1 year ago Capability_Manager.php 1 year ago Chart.php 1 year ago Chart_Data.php 1 year ago Click_Tracking.php 1 year ago Cron_Job.php 1 year ago Cron_Manager.php 1 year ago Current_Traffic_Finder.php 1 year ago Dashboard_Options.php 1 year ago Dashboard_Widget.php 2 years ago Database.php 1 year ago Database_Manager.php 1 year ago Empty_Report_Option.php 2 years ago Env.php 1 year ago Filters.php 1 year ago Geo_Database_Background_Job.php 1 year ago Geo_Database_Manager.php 1 year ago Geoposition.php 1 year ago Icon_Directory.php 2 years ago Icon_Directory_Factory.php 2 years ago Illuminate_Builder.php 1 year ago Independent_Analytics.php 1 year ago Interrupt.php 1 year ago Known_Referrers.php 1 year ago MainWP.php 1 year ago Map.php 1 year ago Map_Data.php 1 year ago Migration_Fixer_Job.php 1 year ago Patch.php 1 year ago Payload_Validator.php 1 year ago Plugin_Conflict_Detector.php 1 year ago Plugin_Group.php 1 year ago Plugin_Group_Option.php 2 years ago Query.php 1 year ago Query_Taps.php 1 year ago Quick_Stats.php 1 year ago REST_API.php 1 year ago Real_Time.php 1 year ago Report.php 1 year ago Report_Finder.php 1 year ago Report_Options_Parser.php 2 years ago Resource_Identifier.php 1 year ago Settings.php 1 year ago Sort_Configuration.php 1 year ago Tables.php 1 year ago Track_Resource_Changes.php 1 year ago View.php 1 year ago View_Counter.php 1 year ago Views_Over_Time_Finder.php 1 year ago WP_Option_Cache_Bust.php 2 years ago

View_Counter.php

174 lines

1	<?php
2
3	namespace IAWP;
4
5	use IAWP\Date_Range\Relative_Date_Range;
6	use IAWP\Utils\Number_Formatter;
7	use IAWP\Utils\Security;
8	use IAWPSCOPED\Illuminate\Database\Query\Builder;
9	use IAWPSCOPED\Illuminate\Database\Query\JoinClause;
10	/** @internal */
11	class View_Counter
12	{
13	public function __construct()
14	{
15	\add_action('the_content', [$this, 'output_counter']);
16	\add_action('init', [$this, 'add_shortcode']);
17	\add_action('add_meta_boxes', [$this, 'maybe_add_meta_box'], 10);
18	\add_action('save_post', [$this, 'save_metabox_settings']);
19	}
20	public function output_counter($content)
21	{
22	if (!$this->passes_checks()) {
23	return $content;
24	}
25	$resource = $this->get_resource();
26	if (\is_null($resource)) {
27	return $content;
28	}
29	$view_count = $this->get_view_count($resource, null);
30	// Checking here instead of passes_checks() so we don't have to always make a DB request for every page
31	if ($view_count < \IAWPSCOPED\iawp()->get_option('iawp_view_counter_threshold', 0)) {
32	return $content;
33	}
34	$view_count = Number_Formatter::decimal($view_count);
35	$counter = $this->get_counter_html($view_count);
36	$position = \IAWPSCOPED\iawp()->get_option('iawp_view_counter_position', 'after');
37	if ($position == 'before' \|\| $position == 'both') {
38	$content = $counter . $content;
39	}
40	if ($position == 'after' \|\| $position == 'both') {
41	$content .= $counter;
42	}
43	return $content;
44	}
45	public function get_counter_html($view_count = 0, $label = null, $icon = null)
46	{
47	if (\is_null($label)) {
48	if (!\get_option('iawp_view_counter_label_show', \true)) {
49	$label = '';
50	} else {
51	$default = \function_exists('IAWPSCOPED\\pll__') ? pll__('Views:', 'independent-analytics') : \__('Views:', 'independent-analytics');
52	$label = \IAWPSCOPED\iawp()->get_option('iawp_view_counter_label', $default);
53	}
54	}
55	if (\is_null($icon)) {
56	$icon = \get_option('iawp_view_counter_icon', \true);
57	}
58	if ($icon) {
59	$svg = '<svg height="20" viewBox="0 0 192 192" width="20" fill="currentColor" style="margin-right:6px; margin-top:-2px;"><path d="m16 176v-136h-16v144a8 8 0 0 0 8 8h184v-16z"/><path d="m72 112a8 8 0 0 0 -8-8h-24a8 8 0 0 0 -8 8v56h40z"/><path d="m128 80a8 8 0 0 0 -8-8h-24a8 8 0 0 0 -8 8v88h40z"/><path d="m184 48a8 8 0 0 0 -8-8h-24a8 8 0 0 0 -8 8v120h40z"/></svg>';
60	$label = $svg . ' ' . $label;
61	}
62	return '<div class="iawp-view-counter" style="display: flex;"><span class="view-counter-text" style="display: flex; align-items: center;">' . Security::svg($label) . '</span> <span class="view-counter-value" style="margin-left: 3px;">' . \esc_html($view_count) . '</span></div>';
63	}
64	public function add_shortcode()
65	{
66	\add_shortcode('iawp_view_counter', [$this, 'shortcode']);
67	}
68	public function shortcode($atts)
69	{
70	$attributes = \shortcode_atts(['label' => \IAWPSCOPED\iawp()->get_option('iawp_view_counter_label', \esc_html__('Views:', 'independent-analytics')), 'icon' => \true, 'range' => \IAWPSCOPED\iawp()->get_option('iawp_view_counter_views_to_count', 'total')], $atts);
71	$resource = $this->get_resource($attributes['range']);
72	if (\is_null($resource)) {
73	return;
74	}
75	$view_count = $this->get_view_count($resource, $attributes['range']);
76	if ($view_count < \IAWPSCOPED\iawp()->get_option('iawp_view_counter_threshold', 0)) {
77	return;
78	}
79	$view_count = Number_Formatter::decimal($view_count);
80	return $this->get_counter_html($view_count, $attributes['label'], $attributes['icon']);
81	}
82	public function maybe_add_meta_box() : void
83	{
84	if (!\IAWPSCOPED\iawp()->get_option('iawp_view_counter_manual_adjustment', \false)) {
85	return;
86	}
87	foreach (\IAWPSCOPED\iawp()->get_option('iawp_view_counter_post_types', []) as $screen) {
88	\add_meta_box('iawp-view-counter-adjustment', \esc_html__('View Counter Adjustment', 'independent-analytics'), [$this, 'render_meta_box_content'], $screen, 'side');
89	}
90	}
91	public function render_meta_box_content() : void
92	{
93	global $post;
94	echo '<p>' . \esc_html__('Increase count by:', 'independent-analytics') . '<input type="number" name="iawp_view_counter_adjustment" id="iawp_view_counter_adjustment"
95	value="' . \esc_attr(\get_post_meta($post->ID, 'iawp_view_counter_adjustment', \true)) . '"
96	placeholder="0" style="max-width: 80px; margin-left: 8px" />
97	<a class="info-link"
98	href="https://independentwp.com/knowledgebase/dashboard/display-view-counter/"
99	target="_blank"
100	style="text-decoration:none;float:right;margin-top:4px">
101	<span class="dashicons dashicons-editor-help"></span>
102	</a>
103	</p>';
104	}
105	public function save_metabox_settings(int $post_id)
106	{
107	if (\array_key_exists('iawp_view_counter_adjustment', $_POST)) {
108	\update_post_meta($post_id, 'iawp_view_counter_adjustment', \absint($_POST['iawp_view_counter_adjustment']));
109	}
110	}
111	private function get_resource($range = null) : ?\IAWP\Resource_Identifier
112	{
113	$current_resource = \IAWP\Resource_Identifier::for_resource_being_viewed();
114	// It's critical to check because this function is called erroneously by Gutenberg in the editor
115	if (\is_null($current_resource)) {
116	return null;
117	}
118	// Get stats for individual posts in the loop if shortcode added to each post
119	global $post;
120	if ($post->ID != $current_resource->meta_value() && \is_main_query() && \in_the_loop()) {
121	$current_resource = \IAWP\Resource_Identifier::for_post_id($post->ID);
122	}
123	return $current_resource;
124	}
125	private function passes_checks() : bool
126	{
127	if (!\is_singular() \|\| !\is_main_query() \|\| !\in_the_loop()) {
128	return \false;
129	}
130	if (\IAWPSCOPED\iawp()->get_option('iawp_view_counter_enable', \false) == \false) {
131	return \false;
132	}
133	if (!\in_array(\get_post_type(), \IAWPSCOPED\iawp()->get_option('iawp_view_counter_post_types', []))) {
134	return \false;
135	}
136	if (\IAWPSCOPED\iawp()->get_option('iawp_view_counter_private', \false) && !\is_user_logged_in()) {
137	return \false;
138	}
139	$exclude = \IAWPSCOPED\iawp()->get_option('iawp_view_counter_exclude', '');
140	if ($exclude != '') {
141	$exclude = \explode(',', $exclude);
142	if (\in_array(\get_the_ID(), $exclude)) {
143	return \false;
144	}
145	}
146	return \true;
147	}
148	private function get_view_count(\IAWP\Resource_Identifier $resource, ?string $relative_range_id) : int
149	{
150	// The shortcode has a parameter for users to enter a custom date range
151	if (\is_null($relative_range_id)) {
152	$relative_range_id = \IAWPSCOPED\iawp()->get_option('iawp_view_counter_views_to_count', 'total');
153	}
154	$relative_range_id = \strtoupper($relative_range_id);
155	if ($relative_range_id === 'TOTAL' \|\| !\in_array($relative_range_id, Relative_Date_Range::range_ids())) {
156	$relative_range_id = 'ALL_TIME';
157	}
158	$resources_table = \IAWP\Query::get_table_name(\IAWP\Query::RESOURCES);
159	$views_table = \IAWP\Query::get_table_name(\IAWP\Query::VIEWS);
160	$relative_range = new Relative_Date_Range($relative_range_id);
161	$query = \IAWP\Illuminate_Builder::new()->selectRaw('COUNT(views.id) AS views')->from($resources_table, 'resources')->leftJoin("{$views_table} AS views", function (JoinClause $join) {
162	$join->on('resources.id', '=', 'views.resource_id');
163	})->where('resource', '=', $resource->type())->when($resource->has_meta(), function (Builder $query) use($resource) {
164	$query->where($resource->meta_key(), '=', $resource->meta_value());
165	})->whereBetween('viewed_at', [$relative_range->iso_start(), $relative_range->iso_end()])->groupBy('resources.id');
166	$views = $query->value('views');
167	$views = \is_null($views) ? 0 : $views;
168	if (\IAWPSCOPED\iawp()->get_option('iawp_view_counter_manual_adjustment', \false)) {
169	$views += \intval(\get_post_meta($resource->meta_value(), 'iawp_view_counter_adjustment', \true));
170	}
171	return $views;
172	}
173	}
174