doc.cls.php — LiteSpeed Cache 7.6.1

litespeed-cache / src / doc.cls.php

litespeed-cache / src Last commit date

doc.cls.php

162 lines

1	<?php
2	// phpcs:ignoreFile
3
4	/**
5	* The Doc class.
6	*
7	* @since 2.2.7
8	* @package LiteSpeed
9	*/
10
11	namespace LiteSpeed;
12
13	defined('WPINC') \|\| exit();
14
15	class Doc {
16
17	// protected static $_instance;
18
19	/**
20	* Show option is actually ON by GM
21	*
22	* @since 5.5
23	* @access public
24	*/
25	public static function maybe_on_by_gm( $id ) {
26	if (apply_filters('litespeed_conf', $id)) {
27	return;
28	}
29	if (!apply_filters('litespeed_conf', Base::O_GUEST)) {
30	return;
31	}
32	if (!apply_filters('litespeed_conf', Base::O_GUEST_OPTM)) {
33	return;
34	}
35	echo '<font class="litespeed-warning">';
36	echo '⚠️ ' .
37	sprintf(
38	__('This setting is %1$s for certain qualifying requests due to %2$s!', 'litespeed-cache'),
39	'<code>' . __('ON', 'litespeed-cache') . '</code>',
40	Lang::title(Base::O_GUEST_OPTM)
41	);
42	self::learn_more('https://docs.litespeedtech.com/lscache/lscwp/general/#guest-optimization');
43	echo '</font>';
44	}
45
46	/**
47	* Changes affect crawler list warning
48	*
49	* @since 4.3
50	* @access public
51	*/
52	public static function crawler_affected() {
53	echo '<font class="litespeed-primary">';
54	echo '⚠️ ' . __('This setting will regenerate crawler list and clear the disabled list!', 'litespeed-cache');
55	echo '</font>';
56	}
57
58	/**
59	* Privacy policy
60	*
61	* @since 2.2.7
62	* @access public
63	*/
64	public static function privacy_policy() {
65	return __(
66	'This site utilizes caching in order to facilitate a faster response time and better user experience. Caching potentially stores a duplicate copy of every web page that is on display on this site. All cache files are temporary, and are never accessed by any third party, except as necessary to obtain technical support from the cache plugin vendor. Cache files expire on a schedule set by the site administrator, but may easily be purged by the admin before their natural expiration, if necessary. We may use QUIC.cloud services to process & cache your data temporarily.',
67	'litespeed-cache'
68	) .
69	sprintf(
70	__('Please see %s for more details.', 'litespeed-cache'),
71	'<a href="https://quic.cloud/privacy-policy/" target="_blank">https://quic.cloud/privacy-policy/</a>'
72	);
73	}
74
75	/**
76	* Learn more link
77	*
78	* @since 2.4.2
79	* @access public
80	*/
81	public static function learn_more( $url, $title = false, $self = false, $class = false, $return = false ) {
82	if (!$class) {
83	$class = 'litespeed-learn-more';
84	}
85
86	if (!$title) {
87	$title = __('Learn More', 'litespeed-cache');
88	}
89
90	$self = $self ? '' : "target='_blank'";
91
92	$txt = " <a href='$url' $self class='$class'>$title</a>";
93
94	if ($return) {
95	return $txt;
96	}
97
98	echo $txt;
99	}
100
101	/**
102	* One per line
103	*
104	* @since 3.0
105	* @access public
106	*/
107	public static function one_per_line( $return = false ) {
108	$str = __('One per line.', 'litespeed-cache');
109	if ($return) {
110	return $str;
111	}
112	echo $str;
113	}
114
115	/**
116	* One per line
117	*
118	* @since 3.4
119	* @access public
120	*/
121	public static function full_or_partial_url( $string_only = false ) {
122	if ($string_only) {
123	echo __('Both full and partial strings can be used.', 'litespeed-cache');
124	} else {
125	echo __('Both full URLs and partial strings can be used.', 'litespeed-cache');
126	}
127	}
128
129	/**
130	* Notice to edit .htaccess
131	*
132	* @since 3.0
133	* @access public
134	*/
135	public static function notice_htaccess() {
136	echo '<font class="litespeed-primary">';
137	echo '⚠️ ' . __('This setting will edit the .htaccess file.', 'litespeed-cache');
138	echo ' <a href="https://docs.litespeedtech.com/lscache/lscwp/toolbox/#edit-htaccess-tab" target="_blank" class="litespeed-learn-more">' .
139	__('Learn More', 'litespeed-cache') .
140	'</a>';
141	echo '</font>';
142	}
143
144	/**
145	* Gentle reminder that web services run asynchronously
146	*
147	* @since 5.3.1
148	* @access public
149	*/
150	public static function queue_issues( $return = false ) {
151	$str =
152	'<div class="litespeed-desc">' .
153	__('The queue is processed asynchronously. It may take time.', 'litespeed-cache') .
154	self::learn_more('https://docs.litespeedtech.com/lscache/lscwp/troubleshoot/#quiccloud-queue-issues', false, false, false, true) .
155	'</div>';
156	if ($return) {
157	return $str;
158	}
159	echo $str;
160	}
161	}
162