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

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

328 lines 6.9 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	</div>
95	</div>
96
97	<div class="hc-mb3">
98	<div class="hc-bold">end</div>
99
100	<div class="hc-ml3">
101	The end date, <em class="hc-italic">yyyymmdd</em>, for example <em class="hc-italic">20180901</em>.
102	You can also supply the range with the plus sign, for example <em class="hc-italic">+3 days</em>.
103	Applicable when <strong>type</strong> is <em>list</em> or <em>report</em>.
104	</div>
105	</div>
106
107	<div class="hc-mb3">
108	<div class="hc-bold">time</div>
109
110	<div class="hc-italic">
111	From version 4.7.5
112	</div>
113
114	<div class="hc-ml3">
115	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.
116	</div>
117	</div>
118
119	<div class="hc-mb3">
120	<div class="hc-bold">calendar</div>
121
122	<div class="hc-ml3">
123	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.
124	You can also supply several ids separated by comma.
125	</div>
126
127	<div class="hc-ml3 hc-mt1">
128	Not applicable when <span class="hc-italic">route="myschedule"</span>.
129	</div>
130	</div>
131
132	<div class="hc-mb3">
133	<div class="hc-bold">
134	employee
135	</div>
136
137	<div class="hc-ml3">
138	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.
139	You can also supply several ids separated by comma.
140	</div>
141
142	<div class="hc-ml3 hc-mt1">
143	Not applicable when <span class="hc-italic">route="myschedule"</span>.
144	</div>
145	</div>
146
147	<div class="hc-mb3">
148	<div class="hc-bold">
149	hideui
150	</div>
151
152	<div class="hc-ml3">
153	Optionally you can hide certain user interface elements on the front end page. Separate several options by comma. Possible options include:
154
155	<ul class="hc-italic">
156	<li>type</li>
157	<li>type-month</li>
158	<li>type-week</li>
159	<li>type-day</li>
160	<li>type-list</li>
161	<li>type-report</li>
162	<li>groupby</li>
163	<li>print</li>
164	<li>download</li>
165	<li>filter</li>
166	<li>filter-calendar</li>
167	<li>filter-employee</li>
168	<li>filter-conflict</li>
169	<li>shiftdetails</li>
170	<li>bulk</li>
171	<li>pagetitle</li>
172	<li>pagemenu</li>
173	<li>date-nav</li>
174	<li>report-duration</li>
175	<li>report-qty</li>
176	</ul>
177	</div>
178
179	<div class="hc-ml3 hc-mt1">
180	Not applicable when <span class="hc-italic">route="myschedule"</span>.
181	</div>
182	</div>
183
184	<?php if( class_exists('SH4_Pickup_Boot') ) : ?>
185	<div class="hc-mb3">
186	<div class="hc-bold">
187	pickup
188	</div>
189
190	<div class="hc-ml3">
191	<ul>
192	<li class="hc-italic">
193	1
194	</li>
195	<li>
196	Display shifts with pickup request.
197	</li>
198	</ul>
199
200	<ul>
201	<li class="hc-italic">
202	-1
203	</li>
204	<li>
205	Display shifts with no pickup request.
206	</li>
207	</ul>
208
209	<ul>
210	<li class="hc-italic">
211	0 (default)
212	</li>
213	<li>
214	Display all shifts.
215	</li>
216	</ul>
217	</div>
218	</div>
219	<?php endif; ?>
220
221	<div class="hc-mb3">
222	<div class="hc-bold">
223	conflict
224	</div>
225
226	<div class="hc-italic">
227	From version 4.9.17
228	</div>
229
230	<div class="hc-ml3">
231	<ul>
232	<li class="hc-italic">1</li>
233	<li>
234	Display shifts with conflicts.
235	</li>
236	</ul>
237
238	<ul>
239	<li class="hc-italic">-1</li>
240	<li>
241	Display shifts with no conflicts.
242	</li>
243	</ul>
244
245	<ul>
246	<li class="hc-italic">0 (default)</li>
247	<li>
248	Display all shifts.
249	</li>
250	</ul>
251	</div>
252	</div>
253
254	<p>
255	<h3>Examples</h3>
256	</p>
257
258	<p>
259	Month calendar for September for calendar #12:
260	</p>
261
262	<p>
263	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
264	[<?php echo $shortcode; ?> start="20180901" type="month" calendar="12"]
265	</code>
266	</p>
267
268	<p>
269	Week calendar for the current week:
270	</p>
271
272	<p>
273	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
274	[<?php echo $shortcode; ?> type="week"]
275	</code>
276	</p>
277
278	<p>
279	List shifts in the next 3 days:
280	</p>
281
282	<p>
283	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
284	[<?php echo $shortcode; ?> type="list" end="+3 days"]
285	</code>
286	</p>
287
288	<p>
289	Do not show the calendar filter and the download button:
290	</p>
291
292	<p>
293	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
294	[<?php echo $shortcode; ?> hideui="filter-calendar,download"]
295	</code>
296	</p>
297
298	<p>
299	Show the current user schedule.
300	</p>
301
302	<p>
303	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
304	[<?php echo $shortcode; ?> route="myschedule"]
305	</code>
306	</p>
307
308	<p>
309	Display shifts at the current moment.
310	</p>
311
312	<p>
313	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
314	[<?php echo $shortcode; ?> type="list" time="now"]
315	</code>
316	</p>
317
318	<?php if( class_exists('SH4_Pickup_Boot') ) : ?>
319	<p>
320	Display shifts with pickup request.
321	</p>
322
323	<p>
324	<code class="hc-p2 hc-mt1 hc-mb1 hc-border hc-block hc-maroon">
325	[<?php echo $shortcode; ?> pickup="1"]
326	</code>
327	</p>
328	<?php endif; ?>