code-profiler / lib / help.php

help.php in Code Profiler – WordPress Performance Profiling and Debugging Made Easy 1.6.2, at lib/help.php

194 lines 6.9 KB

Raw Download Zip

1	<?php
2	/*
3	+=====================================================================+
4	\| ____ _ ____ __ _ _ \|
5	\| / ___\|___ __\| \| ___ \| _ \ _ __ ___ / _(_) \| ___ _ __ \|
6	\| \| \| / _ \ / _` \|/ _ \ \| \|_) \| '__/ _ \\| \|_\| \| \|/ _ \ '__\| \|
7	\| \| \|__\| (_) \| (_\| \| __/ \| __/\| \| \| (_) \| _\| \| \| __/ \| \|
8	\| \____\___/ \__,_\|\___\| \|_\| \|_\| \___/\|_\| \|_\|_\|\___\|_\| \|
9	\| \|
10	\| (c) Jerome Bruandet ~ https://code-profiler.com/ \|
11	+=====================================================================+
12	*/
13
14	if (! defined('ABSPATH') ) {
15	die('Forbidden');
16	}
17
18	// =====================================================================
19	// Display contextual help below each chart and table.
20
21	if ( $type == 'slugs') {
22
23	?>
24	<table class="widefat">
25	<tr>
26	<td><h4><?php echo esc_html( $section_list[ $section ] ) ?></h4>
27	<p>
28	<?php esc_html_e('This chart shows the execution time of all activated plugins and the current theme, in seconds and percentage, for the current profile.', 'code-profiler') ?>
29	<br />
30	<?php printf(
31	esc_html__('Note that the execution time excludes any kind of website optimization (caching, CDN, PHP OPcache etc). Consult the %sFAQ%s for more details about that.', 'code-profiler'),
32	'<a href="?page=code-profiler&cptab=faq">',
33	'</a>'
34	) ?>
35	</p>
36	</td>
37	</tr>
38	</table>
39	<?php
40
41	} elseif ( $type == 'iostats') {
42
43	?>
44	<table class="widefat">
45	<tr>
46	<td><h4><?php echo esc_html( $section_list[ $section ] ) ?></h4>
47	<p><?php esc_html_e('The chart displays all file I/O operations that occurred while your website was loading. The following operations are monitored by Code Profiler:', 'code-profiler') ?></p>
48	<table class="widefat" style="border:none;box-shadow:none">
49	<tr>
50	<td style="width:50%">
51	<code>cast</code>: <?php esc_html_e('Retrieve the underlaying resource (stream_select).', 'code-profiler') ?>
52	</td>
53	<td style="width:50%">
54	<code>chgrp</code>: <?php esc_html_e('Change file group.', 'code-profiler') ?>
55	</td>
56	</tr>
57	<tr>
58	<td>
59	<code>chmod</code>: <?php esc_html_e('Change file mode.', 'code-profiler') ?>
60	</td>
61	<td>
62	<code>chown</code>: <?php esc_html_e('Change file owner.', 'code-profiler') ?>
63	</td>
64	</tr>
65	<tr>
66	<td>
67	<code>close</code>: <?php esc_html_e('Close a resource (fclose).', 'code-profiler') ?>
68	</td>
69	<td>
70	<code>closedir</code>: <?php esc_html_e('Close directory handle.', 'code-profiler') ?>
71	</td>
72	</tr>
73	<tr>
74	<td>
75	<code>eof</code>: <?php esc_html_e('Test for end-of-file on a file pointer (feof).', 'code-profiler') ?>
76	</td>
77	<td>
78	<code>flush</code>: <?php esc_html_e('Flush the output (fflush).', 'code-profiler') ?>
79	</td>
80	</tr>
81	<tr>
82	<td>
83	<code>lock</code>: <?php esc_html_e('Advisory file locking (flock).', 'code-profiler') ?>
84	</td>
85	<td>
86	<code>mkdir</code>: <?php esc_html_e('Create a directory.', 'code-profiler') ?>
87	</td>
88	</tr>
89	<tr>
90	<td>
91	<code>open</code>: <?php esc_html_e('Open file (e.g., fopen, file_get_contents).', 'code-profiler') ?>
92	</td>
93	<td>
94	<code>opendir</code>: <?php esc_html_e('Open directory handle.', 'code-profiler') ?>
95	</td>
96	</tr>
97	<tr>
98	<td>
99	<code>read</code>: <?php esc_html_e('Read from stream (e.g., fread, fgets).', 'code-profiler') ?>
100	</td>
101	<td>
102	<code>readdir</code>: <?php esc_html_e('Read entry from directory handle.', 'code-profiler') ?>
103	</td>
104	<tr>
105	<tr>
106	<td>
107	<code>rename</code>: <?php esc_html_e('Rename a file or directory.', 'code-profiler') ?>
108	</td>
109	<td>
110	<code>rewinddir</code>: <?php esc_html_e('Rewind directory handle.', 'code-profiler') ?>
111	</td>
112	</tr>
113	<tr>
114	<td>
115	<code>rmdir</code>: <?php esc_html_e('Remove a directory.', 'code-profiler') ?>
116	</td>
117	<td>
118	<code>seek</code>: <?php esc_html_e('Seek to specific location in a stream (fseek).', 'code-profiler') ?>
119	</td>
120	</tr>
121	<tr>
122	<td>
123	<code>set_option</code>: <?php esc_html_e('Change stream options.', 'code-profiler') ?>
124	</td><td>
125	<code>stat</code>: <?php esc_html_e('Retrieve information about a file resource (fstat).', 'code-profiler') ?>
126	</td>
127	</tr>
128	<tr>
129	<td>
130	<code>tell</code>: <?php esc_html_e('Retrieve the current position of a stream. (fseek).', 'code-profiler') ?>
131	</td><td>
132	<code>truncate</code>: <?php esc_html_e('Truncate stream (ftruncate).', 'code-profiler') ?>
133	</td>
134	</tr>
135	<tr>
136	<td>
137	<code>touch</code>: <?php esc_html_e('Set access and modification time of file.', 'code-profiler') ?>
138	</td>
139	<td>
140	<code>unlink</code>: <?php esc_html_e('Delete a file.', 'code-profiler') ?>
141	</td>
142	</tr>
143	<tr>
144	<td>
145	<code>url_stat</code>: <?php esc_html_e('Retrieve information about a file. This method is called in response to all stat related functions, such as copy, filesize, filetype, is_dir, is_file, file_exists etc.', 'code-profiler') ?>
146	</td>
147	<td>
148	<code>write</code>: <?php esc_html_e('Write to stream (fwrite).', 'code-profiler') ?>
149	</td>
150	</tr>
151	</table>
152	</td>
153	</tr>
154	</table>
155	<?php
156
157	} elseif ( $type == 'diskio') {
158
159	?>
160	<table class="widefat">
161	<tr>
162	<td><h4><?php echo esc_html( $section_list[ $section ] ) ?></h4>
163	<p><?php esc_html_e('The chart shows the total amount of disk I/O read and write data, in bytes, that occurred while your website was loading. It includes all activated plugins, the current theme and also WordPress.', 'code-profiler') ?></p>
164
165	</td>
166	</tr>
167	</table>
168	<?php
169
170	// Profiles list
171	} elseif ( $type == 'profiles_list') {
172
173	?>
174	<table class="widefat">
175	<tr>
176	<td><h4><?php esc_html_e('Profiles List', 'code-profiler') ?></h4>
177	<p><?php esc_html_e('This page shows all saved profiles with sortable columns:', 'code-profiler') ?></p>
178	<ul class="license-help-view">
179	<li><?php esc_html_e('Profile: name of the saved profile.', 'code-profiler') ?></li>
180	<li><?php esc_html_e('Date: creation date of the profile.', 'code-profiler') ?></li>
181	<li><?php esc_html_e('Item: number of plugins + the current theme.', 'code-profiler') ?></li>
182	<li><?php esc_html_e('Time: execution time in second.', 'code-profiler') ?></li>
183	<li><?php esc_html_e('Memory: peak memory in megabytes.', 'code-profiler') ?></li>
184	<li><?php esc_html_e('File I/O: sum of all file I/O operations.', 'code-profiler') ?></li>
185	<li><?php esc_html_e('SQL: sum of database queries (WordPress, all plugins and the theme).', 'code-profiler') ?></li>
186	</ul>
187	</td>
188	</tr>
189	</table>
190	<?php
191	}
192	// =====================================================================
193	// EOF
194