shiftcontroller / sh4 / _wordpress / conf / html / admin / view / publish.html.php

publish.html.php in ShiftController Employee Shift Scheduling 4.9.95, at sh4/_wordpress/conf/html/admin/view/publish.html.php

375 lines 8.1 KB

Raw Download Zip

1	<?php if (! defined('ABSPATH')) exit; // Exit if accessed directly
2	$shortcode = 'shiftcontroller4';
3	?>
4	<p>
5	With the following shoftcode you can insert your <strong class="hc-bold">Everyone's Schedule</strong> view into a post or a page.
6	</p>
7
8	<p>
9	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block">
10	[<?php echo $shortcode; ?>]
11	</code>
12	</p>
13
14	<p>
15	By default, this view will display the current week shifts calendar for everyone.
16	If you need, you can adjust it by supplying additional parameters to control the display:
17	</p>
18
19	<div class="hc-mb3">
20	<div class="hc-bold">
21	route
22	</div>
23
24	<div class="hc-ml3">
25	<ul>
26	<li class="hc-italic">
27	schedule (default)
28	</li>
29	<li>
30	Displays everyone's schedule.
31	</li>
32	</ul>
33
34	<ul>
35	<li class="hc-italic">
36	myschedule
37	</li>
38	<li>
39	Displays the schedule of the employee which is linked to the current user if any.
40	</li>
41	</ul>
42	</div>
43	</div>
44
45	<div class="hc-mb3">
46	<div class="hc-bold">
47	type
48	</div>
49
50	<div class="hc-ml3">
51	<ul class="hc-italic">
52	<li>
53	week (default)
54	</li>
55	<li>
56	month
57	</li>
58	<li>
59	list
60	</li>
61	<li>
62	report
63	</li>
64	</ul>
65	</div>
66	</div>
67
68	<div class="hc-mb3">
69	<div class="hc-bold">
70	groupby
71	</div>
72
73	<div class="hc-ml3">
74	<ul class="hc-italic">
75	<li>
76	none (default)
77	</li>
78	<li>
79	employee
80	</li>
81	<li>
82	calendar
83	</li>
84	</ul>
85	</div>
86	</div>
87
88	<div class="hc-mb3">
89	<div class="hc-bold">start</div>
90
91	<div class="hc-ml3">
92	The start date, <em class="hc-italic">yyyymmdd</em>, for example <em class="hc-italic">20180901</em>. If not supplied, it will start from the current date.
93	You can also supply <em class="hc-italic">start-week</em>, <em class="hc-italic">start-month</em>, <em class="hc-italic">start-year</em> if you are using <em class="hc-italic">list</em> or <em class="hc-italic">report</em> view.
94	Other options: <em class="hc-italic">first-blank</em>, <em class="hc-italic">first-non-blank</em>.
95	</div>
96	</div>
97
98	<div class="hc-mb3">
99	<div class="hc-bold">end</div>
100
101	<div class="hc-ml3">
102	The end date, <em class="hc-italic">yyyymmdd</em>, for example <em class="hc-italic">20180901</em>.
103	You can also supply the range with the plus sign, for example <em class="hc-italic">+3 days</em>.
104	Applicable when <strong>type</strong> is <em>list</em> or <em>report</em>.
105	</div>
106	</div>
107
108	<div class="hc-mb3">
109	<div class="hc-bold">time</div>
110
111	<div class="hc-italic">
112	From version 4.7.5
113	</div>
114
115	<div class="hc-ml3">
116	Exact time, <em class="hc-italic">yyyymmddhhmm</em>, for example <em class="hc-italic">202005281430</em>. Also <em class="hc-italic">now</em> can be used to get the current date and time.
117	</div>
118	</div>
119
120	<div class="hc-mb3">
121	<div class="hc-bold">calendar</div>
122
123	<div class="hc-ml3">
124	Calendar id, for example <em class="hc-italic">123</em>. You can find out the id of a calendar in <em class="hc-italic">Administration > Calendars</em>. If not supplied, it will display shifts of all calendars.
125	You can also supply several ids separated by comma.
126	</div>
127
128	<div class="hc-ml3 hc-mt1">
129	Not applicable when <span class="hc-italic">route="myschedule"</span>.
130	</div>
131	</div>
132
133	<div class="hc-mb3">
134	<div class="hc-bold">
135	employee
136	</div>
137
138	<div class="hc-ml3">
139	Employee id, for example <em class="hc-italic">321</em>. You can find out the id of an employee in <em class="hc-italic">Administration > Employees</em>. If not supplied, it will display shifts of all employees.
140	You can also supply several ids separated by comma.
141	</div>
142
143	<div class="hc-ml3 hc-mt1">
144	Not applicable when <span class="hc-italic">route="myschedule"</span>.
145	</div>
146	</div>
147
148	<div class="hc-mb3">
149	<div class="hc-bold">
150	hideui
151	</div>
152
153	<div class="hc-ml3">
154	Optionally you can hide certain user interface elements on the front end page. Separate several options by comma. Possible options include:
155
156	<ul class="hc-italic">
157	<li>type</li>
158	<li>type-month</li>
159	<li>type-week</li>
160	<li>type-day</li>
161	<li>type-list</li>
162	<li>type-report</li>
163	<li>groupby</li>
164	<li>print</li>
165	<li>download</li>
166	<li>filter</li>
167	<li>filter-calendar</li>
168	<li>filter-employee</li>
169	<li>filter-conflict</li>
170	<li>shiftdetails</li>
171	<li>bulk</li>
172	<li>pagetitle</li>
173	<li>pagemenu</li>
174	<li>date-nav</li>
175	<li>report-duration</li>
176	<li>report-qty</li>
177	</ul>
178	</div>
179
180	<div class="hc-ml3 hc-mt1">
181	Not applicable when <span class="hc-italic">route="myschedule"</span>.
182	</div>
183	</div>
184
185	<?php if( class_exists('SH4_Pickup_Boot') ) : ?>
186	<div class="hc-mb3">
187	<div class="hc-bold">
188	pickup
189	</div>
190
191	<div class="hc-ml3">
192	<ul>
193	<li class="hc-italic">
194	1
195	</li>
196	<li>
197	Display shifts with pickup request.
198	</li>
199	</ul>
200
201	<ul>
202	<li class="hc-italic">
203	-1
204	</li>
205	<li>
206	Display shifts with no pickup request.
207	</li>
208	</ul>
209
210	<ul>
211	<li class="hc-italic">
212	0 (default)
213	</li>
214	<li>
215	Display all shifts.
216	</li>
217	</ul>
218	</div>
219	</div>
220	<?php endif; ?>
221
222	<div class="hc-mb3">
223	<div class="hc-bold">
224	conflict
225	</div>
226
227	<div class="hc-italic">
228	From version 4.9.17
229	</div>
230
231	<div class="hc-ml3">
232	<ul>
233	<li class="hc-italic">1</li>
234	<li>
235	Display shifts with conflicts.
236	</li>
237	</ul>
238
239	<ul>
240	<li class="hc-italic">-1</li>
241	<li>
242	Display shifts with no conflicts.
243	</li>
244	</ul>
245
246	<ul>
247	<li class="hc-italic">0 (default)</li>
248	<li>
249	Display all shifts.
250	</li>
251	</ul>
252	</div>
253	</div>
254
255	<div class="hc-mb3">
256	<div class="hc-bold">t1</div>
257
258	<div class="hc-ml3">
259	<ul>
260	<li>
261	Display shifts that start at this time only (seconds from midnight). Multiple options are allowed, separate them by "-", for example 10800-57600.
262	</li>
263	</ul>
264	</div>
265	</div>
266
267	<div class="hc-mb3">
268	<div class="hc-bold">t2</div>
269
270	<div class="hc-ml3">
271	<ul>
272	<li>
273	Display shifts that end at this time only (seconds from midnight). Multiple options are allowed, separate them by "-", for example 10800-57600.
274	</li>
275	</ul>
276	</div>
277	</div>
278
279	<div class="hc-mb3">
280	<div class="hc-bold">t</div>
281
282	<div class="hc-ml3">
283	<ul>
284	<li>
285	Display shifts that end at this time only (seconds from midnight). Separate start and end times by "-", separate multiple options by "_", for example 10800-21600_57600-68400.
286	</li>
287	</ul>
288	</div>
289	</div>
290
291	<p>
292	<h3>Examples</h3>
293	</p>
294
295	<p>
296	Month calendar for September for calendar #12:
297	</p>
298
299	<p>
300	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
301	[<?php echo $shortcode; ?> start="20180901" type="month" calendar="12"]
302	</code>
303	</p>
304
305	<p>
306	Week calendar for the current week:
307	</p>
308
309	<p>
310	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
311	[<?php echo $shortcode; ?> type="week"]
312	</code>
313	</p>
314
315	<p>
316	List shifts in the next 3 days:
317	</p>
318
319	<p>
320	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
321	[<?php echo $shortcode; ?> type="list" end="+3 days"]
322	</code>
323	</p>
324
325	<p>
326	Do not show the calendar filter and the download button:
327	</p>
328
329	<p>
330	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
331	[<?php echo $shortcode; ?> hideui="filter-calendar,download"]
332	</code>
333	</p>
334
335	<p>
336	Show the current user schedule.
337	</p>
338
339	<p>
340	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
341	[<?php echo $shortcode; ?> route="myschedule"]
342	</code>
343	</p>
344
345	<p>
346	Display shifts at the current moment.
347	</p>
348
349	<p>
350	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
351	[<?php echo $shortcode; ?> type="list" time="now"]
352	</code>
353	</p>
354
355	<p>
356	Display 3am-6am and 4pm-7pm shifts.
357	</p>
358
359	<p>
360	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
361	[<?php echo $shortcode; ?> t="10800-21600_57600-68400"]
362	</code>
363	</p>
364
365	<?php if( class_exists('SH4_Pickup_Boot') ) : ?>
366	<p>
367	Display shifts with pickup request.
368	</p>
369
370	<p>
371	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
372	[<?php echo $shortcode; ?> pickup="1"]
373	</code>
374	</p>
375	<?php endif; ?>