-
Notifications
You must be signed in to change notification settings - Fork 61
/
ssi_examples.php
1008 lines (938 loc) · 28.1 KB
/
ssi_examples.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @package ElkArte Forum
* @copyright ElkArte Forum contributors
* @license BSD http://opensource.org/licenses/BSD-3-Clause (see accompanying LICENSE.txt file)
*
* This file contains code covered by:
* copyright: 2011 Simple Machines (http://www.simplemachines.org)
*
* @version 2.0 dev
*/
use ElkArte\User;
// Special thanks to Spaceman-Spiff for his contributions to this page.
/**
* Define $ssi_guest_access variable just before including SSI.php to handle guest access to your script.
* false: (default) fallback to forum setting
* true: allow guest access to the script regardless
*/
$ssi_guest_access = false;
global $settings, $user_info, $context, $modsettings;
// Include the SSI file.
require(__DIR__ . '/SSI.php');
// Viewing the homepage sample?
if (isset($_GET['view']) && $_GET['view'] === 'home1')
{
template_homepage_sample1('output');
exit;
}
// Load the main template.
template_ssi_above();
?>
<h2>SSI.php Functions</h2>
<p><strong>Current Version:</strong> 2.0 dev</p>
<p>This file is used to demonstrate the capabilities of SSI.php using PHP include functions. The examples show the include tag, then the results of it.</p>
<h2>Include Code</h2>
<p>To use SSI.php in your page add at the very top of your page before the <html> tag on line 1 of your php file:</p>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php require("<?php echo addslashes(User::$info->is_admin ? realpath(BOARDDIR . '/SSI.php') : 'SSI.php'); ?>");</pre>
<h2>Some notes on usage</h2>
<p>All the functions have an output method parameter. This can either be "echo" (the default) or "array"</p>
<p>If it is "echo", the function will act normally - otherwise, it will return an array containing information about the requested task. For example, it might return a list of topics for ssi_recentTopics.</p>
<p>This functionality can be used to allow you to present the information in any way you wish.</p>
<h2>Additional Guides & FAQ</h2>
<p>Need more information on using SSI.php? Check out <a href="https://github.com/elkarte/Elkarte/wiki/SSI">Using SSI.php article</a> or <a href="https://www.elkarte.net/index.php">ask on the forum</a>.</p>
<div id="sidenav" class="content">
<h2 id="functionlist">Function List</h2>
<h3>Recent Items</h3>
<ul>
<li>
<a href="#" onclick="showSSIBlock('ssi_recentTopics');return false;">Recent Topics</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_recentPosts');return false;">Recent Posts</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_recentPoll');return false;">Recent Poll</a>
</li>
</ul>
<h3>Top Items</h3>
<ul>
<li>
<a href="#" onclick="showSSIBlock('ssi_topBoards');return false;">Top Boards</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_topTopicsViews');return false;">Top Topics</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_topPoll');return false;">Top Poll</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_topPoster');return false;">Top Poster</a>
</li>
</ul>
<h3>Members</h3>
<ul>
<li>
<a href="#" onclick="showSSIBlock('ssi_latestMember');return false;">Latest Member Function</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_randomMember');return false;">Member of the Day</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_whosOnline');return false;">Who's Online</a>
</li>
</ul>
<h3>Authentication</h3>
<ul>
<li>
<a href="#" onclick="showSSIBlock('ssi_login');return false;">Welcome, Login & Logout</a>
</li>
</ul>
<h3>Calendar</h3>
<ul>
<li>
<a href="#" onclick="showSSIBlock('ssi_todaysCalendar');return false;">Today's Events</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_recentEvents');return false;">Recent Events</a>
</li>
</ul>
<h3>Miscellaneous</h3>
<ul>
<li>
<a href="#" onclick="showSSIBlock('ssi_boardStats');return false;">Forum Stats</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_news');return false;">News</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_boardNews');return false;">Board News</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_menubar');return false;">Menubar</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_quickSearch');return false;">Quick Search Box</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_recentAttachments');return false;">Recent Attachments</a>
</li>
</ul>
<?php if (User::$info->is_admin)
{
?>
<h3>Advanced Functions <i class="helpicon i-help" title="Functions that require additional tweaking, not just copy and paste."></i></h3>
<ul>
<li>
<a href="#" onclick="showSSIBlock('ssi_showPoll');return false;">Show Single Poll</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_fetchPosts');return false;">Show Single Post</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_fetchMember');return false;">Show Single Member</a>
</li>
<li>
<a href="#" onclick="showSSIBlock('ssi_fetchGroupMembers');return false;">Show Group Members</a>
</li>
</ul>
<?php } ?>
<h3>Website Samples</h3>
<ul>
<li>
<a href="#" onclick="showSSIBlock('htmlhome');">Sample 1</a>
</li>
</ul>
<h2 id="other">Other</h2>
<ul>
<li>
<a href="#" onclick="toggleVisibleByClass('ssi_preview', false);return false;">Show all examples</a>
</li>
<li>
<a href="#" onclick="toggleVisibleByClass('ssi_preview', true);return false;">Hide all examples</a>
</li>
</ul>
</div>
<div id="preview" class="content">
<!-- RECENT ITEMS -->
<div class="ssi_preview" id="ssi_recentTopics">
<h2>Recent Topics Function</h2>
<h3>Code (simple mode)</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_recentTopics();</pre>
<h3>Code (advanced mode)</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_recentTopics($num_recent = 8, $exclude_boards = null, $include_boards = null, $output_method = 'echo');</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_recentTopics();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_recentPosts">
<h2>Recent Posts Function</h2>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_recentPosts();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_recentPosts();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_recentPoll">
<h2>Recent Poll Function</h2>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_recentPoll();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_recentPoll();
flush();
?>
</div>
</div>
<!-- TOP ITEMS -->
<div class="ssi_preview" id="ssi_topBoards">
<h2>Top Boards Function</h2>
<p>Shows top boards by the number of posts.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_topBoards();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_topBoards();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_topTopicsViews">
<h2>Top Topics</h2>
<p>Shows top topics by the number of replies or views.</p>
<h3>Code (show by number of views)</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_topTopicsViews();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_topTopicsViews();
flush();
?>
</div>
<h3>Code (show by number of replies)</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_topTopicsReplies();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_topTopicsReplies();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_topPoll">
<h2>Top Poll Function</h2>
<p>Shows the most-voted-in poll.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_topPoll();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_topPoll();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_topPoster">
<h2>Top Poster Function</h2>
Shows the top poster's name and profile link.
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_topPoster();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_topPoster();
flush();
?>
</div>
</div>
<!-- MEMBERS -->
<div class="ssi_preview" id="ssi_latestMember">
<h2>Latest Member Function</h2>
<p>Shows the latest member's name and profile link.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_latestMember();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_latestMember();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_randomMember">
<h2>Member of the Day</h2>
<p>Shows one random member of the day. This changes once a day.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_randomMember('day');</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_randomMember('day');
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_whosOnline">
<h2>Who's Online Function</h2>
<p>This function shows who are online inside the forum.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_whosOnline();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_whosOnline();
flush();
?>
</div>
<h2>Log Online Presence</h2>
<p>This function logs the SSI page's visitor, then shows the Who's Online list. In other words, this function shows who are online inside and outside the forum.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_logOnline();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_logOnline();
flush();
?>
</div>
</div>
<!-- WELCOME, LOGIN AND LOGOUT -->
<div class="ssi_preview" id="ssi_login">
<h2>Login Function</h2>
<p>Shows a login box <strong>only</strong> when user is not logged in.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_login();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_login();
flush();
?>
</div>
<h2>Logout Function</h2>
<p>Shows a logout link <strong>only</strong> when user is logged in.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_logout();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_logout();
flush();
?>
</div>
<h2>Welcome Function</h2>
<p>Greets users or guests, also shows user's messages if logged in.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_welcome();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_welcome();
flush();
?>
</div>
</div>
<!-- CALENDAR -->
<div class="ssi_preview" id="ssi_todaysCalendar">
<h2>Today's Calendar Function</h2>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_todaysCalendar();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_todaysCalendar();
flush();
?>
</div>
<h2>Today's Birthdays Function</h2>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_todaysBirthdays();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_todaysBirthdays();
flush();
?>
</div>
<h2>Today's Holidays Function</h2>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_todaysHolidays();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_todaysHolidays();
flush();
?>
</div>
<h2>Today's Events Function</h2>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_todaysEvents();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_todaysEvents();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_recentEvents">
<h2>Recent Calendar Events Function</h2>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_recentEvents();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_recentEvents();
flush();
?>
</div>
</div>
<!-- MISCELLANEOUS -->
<div class="ssi_preview" id="ssi_boardStats">
<h2>Forum Stats</h2>
<p>Shows some basic forum stats: total members, posts, topics, boards, etc.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_boardStats();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_boardStats();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_news">
<h2>News Function</h2>
<p>Shows random forum news.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_news();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_news();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_boardNews">
<h2>Board News Function</h2>
<p>Shows the latest posts from read only boards, or a specific board.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_boardNews();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_boardNews();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_menubar">
<h2>Menubar Function</h2>
<p>Displays a menu bar, like one displayed at the top of the forum.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_menubar();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_menubar();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_quickSearch">
<h2>Quick Search Function</h2>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_quickSearch();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_quickSearch();
flush();
?>
</div>
</div>
<div class="ssi_preview" id="ssi_recentAttachments">
<h2>Recent Attachments Function</h2>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_recentAttachments();</pre>
<h3>Result</h3>
<div class="ssi_result"><?php
ssi_recentAttachments();
flush();
?>
</div>
</div>
<!-- ADVANCED FUNCTIONS -->
<div class="ssi_preview" id="ssi_showPoll">
<h2>Show Single Poll</h2>
<p>Shows a poll in the specified topic.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_showPoll($topicID);</pre>
<h3>Result</h3>
<div class="ssi_result">
<i>Not shown because it needs specific topic ID that contains a poll.</i>
</div>
</div>
<div class="ssi_preview" id="ssi_fetchPosts">
<h2>Show Single Post</h2>
<p>Fetches a post with a particular IDs. By default will only show if you have permission to the see
the board in question. This can be overriden by passing the 2nd parameter as <span class="tt">true</span>.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_fetchPosts($postIDs, $isOverride);</pre>
<h3>Result</h3>
<div class="ssi_result">
<i>Not shown because it needs a specific post ID.</i>
</div>
</div>
<div class="ssi_preview" id="ssi_fetchMember">
<h2>Show Single Member</h2>
<p>Shows the specified member's name and profile link.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_fetchMember($memberIDs);</pre>
<h3>Result</h3>
<div class="ssi_result">
<i>Not shown because it needs a specific member ID.</i>
</div>
</div>
<div class="ssi_preview" id="ssi_fetchGroupMembers">
<h2>Show Group Members</h2>
<p>Shows all members in a specified group.</p>
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php ssi_fetchGroupMembers($groupIDs);</pre>
<h3>Result</h3>
<div class="ssi_result">
<i>Not shown because it needs specific membergroup IDs.</i>
</div>
</div>
<div class="ssi_preview" id="htmlhome">
<h2>Home Page Sample</h2>
This sample uses the following features: ssi_recentTopics(), ssi_logOnline(), ssi_welcome(), and ssi_boardNews().
ssi_recentTopics() is fetched using the array method, to allow further customizations on the output.
<h3>Code</h3>
<div class="codeheader">
<a href="javascript:void(0);" onclick="return elkSelectText(this);" class="codeoperation">[Select]</a>
</div>
<pre class="bbc_code"><?php
echo \ElkArte\Helper\Util::htmlspecialchars(template_homepage_sample1('source'), ENT_COMPAT, 'UTF-8'); ?>
</pre>
<h3>Result</h3>
<iframe src="?view=home1" style="width: 100%; height: 450px;"></iframe>
</div>
</div>
<?php
template_ssi_below();
function template_ssi_above()
{
global $settings, $context, $scripturl;
echo '<!DOCTYPE html>
<html>
<head>
<title>ElkArte SSI Examples</title>
<link rel="stylesheet" href="', $settings['default_theme_url'], '/css/index.css', CACHE_STALE, '" />
<link rel="stylesheet" href="', $settings['default_theme_url'], '/css/icons_svg.css', CACHE_STALE, '" />
<link rel="stylesheet" href="', $settings['default_theme_url'], '/css/_light/index_light.css', CACHE_STALE, '" />
<script src="', $settings['default_theme_url'], '/scripts/script.js"></script>
<style>
#wrapper {
padding: 2px 2px 12px;
}
#content_section {
position: relative;
top: -20px;
}
#main_content_section h2 {
font-size: 1.5em;
border-bottom: solid 1px #D05800;
line-height: 1.5em;
margin: 0.5em 0;
color: #D05800;
}
#liftup {
position: relative;
top: -30px;
padding: 1em 2em 1em 1em;
line-height: 1.6em;
}
#footer_section {
position: relative;
top: 0;
min-height: 40px;
}
#sidenav {
width: 210px;
float: left;
margin-right: 20px;
}
#sidenav ul {
margin: 0 0 0 1em;
padding: 0;
list-style: none;
font-size: 95%;
}
#preview {
margin-left: 230px;
}
.ssi_preview {
margin-bottom: 1.5em;
}
.ssi_preview h3 {
margin: 1em 0 0.5em 0;
}
.ssi_result {
background: #FFFFFF;
border: 1px solid #9999AA;
padding: .8em;
overflow: hidden;
}
.bbc_code {
height: auto;
}
.ssi_table {
margin: 0;
width: 100%;
border-spacing: 0;
border-collapse: collapse;
border: none;
}
.ssi_table th {
padding: 5px 8px 5px 0;
border-top: 2px solid #DDDDDD;
border-bottom: 2px solid #DDDDDD;
background: #FFFFFF;
color: #555555;
font-size: 1em;
font-weight: 600;
}
.ssi_table td, .ssi_table th {
text-align: left;
white-space: nowrap;
}
.ssi_table td.top {
vertical-align: top;
}
.ssi_table th.righttext, .ssi_table td.righttext {
text-align: right;
}
.ssi_table th.centertext, .ssi_table td.centertext {
text-align: center;
}
.top_topic .link {
text-align: left;
}
.top_topic .views, .top_topic .num_replies {
text-align: right;
}
.codeheader:before {
content: "Code:\20";
}
h3 {
font-weight: 600;
}
</style>
<script>
var elk_scripturl = "', $scripturl, '",
elk_charset = "UTF-8",
elk_theme_url = "', $settings['theme_url'], '",
elk_default_theme_url = "', $settings['default_theme_url'], '",
elk_session_id = "', $context['session_id'], '",
elk_session_var = "', $context['session_var'], '",
elk_member_id = ', $context['user']['id'], ';
// Sets all ssi_preview class to hidden, then shows the one requested.
function showSSIBlock(elementID)
{
toggleVisibleByClass("ssi_preview", true);
document.getElementById(elementID).style.display = "block";
if (elementID !== "ssi_recentTopics")
{
document.getElementById(elementID).scrollIntoView();
}
}
// Toggle visibility of all sections.
function toggleVisibleByClass(sClassName, bHide)
{
var oSections = document.getElementsByTagName("div");
for (var i = 0; i < oSections.length; i++)
{
if (oSections[i].className === null || oSections[i].className.indexOf(sClassName) == -1)
continue;
oSections[i].style.display = bHide ? "none" : "block";
}
}
</script>
</head>
<body>
<div id="top_section">
<div id="header" class="wrapper">
<h1 id="forumtitle">ElkArte SSI (Server Side Includes) Examples
<span id="logobox">
<img id="logo" src="themes/default/images/logo.png" alt="ElkArte Logo" title="ElkArte Community" />
</span>
</h1>
</div>
</div>
<div id="wrapper" class="wrapper">
<div id="upper_section">
<div id="inner_section">
<div id="inner_wrap">
<div class="frame">
<div id="main_content_section">
<div id="liftup" class="flow_auto">';
}
function template_ssi_below()
{
echo '
<script>
showSSIBlock("ssi_recentTopics");
</script>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="footer_section">
<div class="frame">
<div class="smalltext"><a href="https://www.elkarte.net/">ElkArte Community</a>
</div>
</div>
</body>
</html>';
}
function template_homepage_sample1($method = 'source')
{
$header = '<!DOCTYPE html>
<html>
<head>
<title>SSI.php example for home page</title>
<style>
html {
width: 99%;
}
body {
font: 87.5%/150% "Segoe UI", -apple-system, BlinkMacSystemFont, "Roboto", "Oxygen", "Ubuntu", "Cantarell", "Droid Sans", "Helvetica Neue", "Trebuchet MS", Arial, sans-serif;
background: #DFDFDF;
color: #FFFFFF;
margin: 0;
}
ul, ol {
padding-left: 1.25em;
margin: 0;
}
li {
font-size: 1em;
}
h1, h2, h3 {
margin: 0;
padding: 0;
}
h3 {
font-size: 1em;
}
a:link,a:visited {
color: #FF9000;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
#container {
background: #52514E;
width: 100%;
border: 1px solid midnightblue;
line-height: 150%;
margin: 0;
}
#header, #footer {
color: lightgray;
background: #2A2825;
clear: both;
padding: .5em;
}
#leftbar {
background: #DF7E00;
float: left;
width: 160px;
margin: 0;
padding: 1em;
}
#leftbar a {
color: #000;
text-decoration: underline;
}
#content {
margin-left: 190px;
padding: 1em;
}
#navigation {
float: right;
}
#navigation a:link, #navigation a:visited {
color: #FF9000;
}
</style>
</head>
<body>
<div id="container">
<div id="header">
<div id="navigation">
<a href="#">Link</a> | <a href="#">Link</a> | <a href="#">Link</a> | <a href="#">Link</a> | <a href="#">Link</a>
</div>
<h1 class="header">YourWebsite.com</h1>
</div>
<div id="leftbar">
<h3>Recent Forum Topics</h3>
<ul>';
$footer = '
<div id="footer">
<a target="_blank" rel="license" href="http://creativecommons.org/licenses/publicdomain/"><img alt="Creative Commons License" style="border:0;" src="http://i.creativecommons.org/l/publicdomain/88x31.png" /></a>
This sample website layout is dedicated to the <a target="_blank" rel="license" href="http://creativecommons.org/licenses/publicdomain/">Public Domain</a>.
</div>
</div>
</body>
</html>';
if ($method === 'source')
{
$header = '<?php require("' . (User::$info->is_admin ? addslashes(realpath(BOARDDIR . '/SSI.php')) : 'SSI.php') . '"); ?>' . "\n" . $header;
return $header . template_homepage_sample1_html() . $footer;
}
echo $header;
template_homepage_sample1_php();
echo $footer;
}
function template_homepage_sample1_php()
{
global $txt;
$topics = ssi_recentTopics(8, null, null, 'array');
foreach ($topics as $topic)
echo '
<li>
<a href="', $topic['href'], '">', $topic['subject'], '</a> ', $txt['by'], ' ', $topic['poster']['link'], '
</li>';
unset($topics);
echo '
</ul>
<br />
<h3>Online Users</h3>';
ssi_logOnline();
echo '
</div>
<div id="content">';
ssi_welcome();
echo '
<br /><br />
<h2>News</h2>';
ssi_boardNews();
echo '
</div>';
}
function template_homepage_sample1_html()
{
$result = '
<?php
// Using array method to show shorter display style.
$topics = ssi_recentTopics(8, null, null, \'array\');
foreach ($topics as $topic)
{
// Uncomment the following code to get a listing of array elements that the system provides for this function.
// echo \'<pre>\', print_r($topic), \'</pre>\';
echo \'
<li>
<a href=\"\', $topic[\'href\'], \'\">\', $topic[\'subject\'], \'</a> \', $txt[\'by\'], \' \', $topics[$i][\'poster\'][\'link\'], \'</li>\';
}
unset($topics);
?>
</ul><br />
<h3>Online Users</h3>
<?php ssi_logOnline(); ?>
</div>
<div id="content">