/
_skin.class.php
2120 lines (1836 loc) · 71.3 KB
/
_skin.class.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
/**
* This file implements the Skin class.
*
* This file is part of the evoCore framework - {@link http://evocore.net/}
* See also {@link https://github.com/b2evolution/b2evolution}.
*
* @license GNU GPL v2 - {@link http://b2evolution.net/about/gnu-gpl-license}
*
* @copyright (c)2003-2018 by Francois Planque - {@link http://fplanque.com/}
* Parts of this file are copyright (c)2005-2006 by PROGIDISTRI - {@link http://progidistri.com/}.
*
* @package evocore
*/
if( !defined('EVO_MAIN_INIT') ) die( 'Please, do not access this page directly.' );
load_class( '_core/model/dataobjects/_dataobject.class.php', 'DataObject' );
/**
* Skin Class
*
* @package evocore
*/
class Skin extends DataObject
{
var $name;
var $folder;
var $type;
var $class;
/**
* Skin version
* @var string
*/
var $version = NULL;
/**
* Do we want to use style.min.css instead of style.css ?
*/
var $use_min_css = false; // true|false|'check' Set this to true for better optimization
// Note: we set this to false by default for backwards compatibility with third party skins.
// But for best performance, you should set it to true.
/**
* Lazy filled.
* @var array
*/
var $container_list = NULL;
/**
* The translations keyed by locale. They get loaded through include() of _global.php.
* @see Skin::T_()
* @var array
*/
var $_trans = array();
/**
* Constructor
*
* @param table Database row
*/
function __construct( $db_row = NULL, $skin_folder = NULL )
{
// Call parent constructor:
parent::__construct( 'T_skins__skin', 'skin_', 'skin_ID' );
if( is_null($db_row) )
{ // We are creating an object here:
$this->set( 'folder', $skin_folder );
$this->set( 'name', $this->get_default_name() );
$this->set( 'type', $this->get_default_type() );
$this->set( 'class', get_class( $this ) );
}
else
{ // Wa are loading an object:
$this->ID = $db_row->skin_ID;
$this->name = $db_row->skin_name;
$this->folder = $db_row->skin_folder;
$this->type = $db_row->skin_type;
$this->class = $db_row->skin_class;
}
}
/**
* Get param prefix with is used on edit forms and submit data
*
* @return string
*/
function get_param_prefix()
{
return 'edit_skin_'.( empty( $this->ID ) ? '0' : $this->ID ).'_set_';
}
/**
* Get delete restriction settings
*
* @return array
*/
static function get_delete_restrictions()
{
return array(
array( 'table'=>'T_blogs', 'fk'=>'blog_normal_skin_ID', 'fk_short'=>'normal_skin_ID', 'msg'=>T_('%d blogs using this skin') ),
array( 'table'=>'T_blogs', 'fk'=>'blog_mobile_skin_ID', 'fk_short'=>'mobile_skin_ID', 'msg'=>T_('%d blogs using this skin') ),
array( 'table'=>'T_blogs', 'fk'=>'blog_tablet_skin_ID', 'fk_short'=>'tablet_skin_ID', 'msg'=>T_('%d blogs using this skin') ),
array( 'table'=>'T_settings', 'fk'=>'set_value', 'msg'=>T_('This skin is set as default skin.'),
'and_condition' => '( set_name = "def_normal_skin_ID" OR set_name = "def_mobile_skin_ID" OR set_name = "def_tablet_skin_ID" )' ),
);
}
/**
* Get delete cascade settings
*
* @return array
*/
static function get_delete_cascades()
{
return array(
array( 'table'=>'T_skins__container', 'fk'=>'sco_skin_ID', 'msg'=>T_('%d linked containers') ),
);
}
/**
* Install current skin to DB
*/
function install()
{
// INSERT NEW SKIN INTO DB:
$this->dbinsert();
}
/**
* Get default name for the skin.
* Note: the admin can customize it.
*/
function get_default_name()
{
return $this->folder;
}
/**
* Get default skin type for the skin.
*/
function get_default_type()
{
return (substr($this->folder,0,1) == '_' ? 'feed' : 'normal');
}
/**
* Get the customized name for the skin.
*/
function get_name()
{
return $this->name;
}
/**
* What evoSkins API does has this skin been designed with?
*
* This determines where we get the fallback templates from (skins_fallback_v*)
* (allows to use new markup in new b2evolution versions)
*/
function get_api_version()
{
return 5;
}
/**
* Get supported collection kinds.
*
* This should be overloaded in skins.
*
* For each kind the answer could be:
* - 'yes' : this skin does support that collection kind (the result will be was is expected)
* - 'partial' : this skin is not a primary choice for this collection kind (but still produces an output that makes sense)
* - 'maybe' : this skin has not been tested with this collection kind
* - 'no' : this skin does not support that collection kind (the result would not be what is expected)
* There may be more possible answers in the future...
*/
public function get_supported_coll_kinds()
{
$supported_kinds = array(
'main' => 'maybe',
'std' => 'maybe', // Blog
'photo' => 'maybe',
'forum' => 'no',
'manual' => 'no',
'group' => 'maybe', // Tracker
// Any kind that is not listed should be considered as "maybe" supported
);
return $supported_kinds;
}
final public function supports_coll_kind( $kind )
{
$supported_kinds = $this->get_supported_coll_kinds();
if( isset($supported_kinds[$kind]) )
{
return $supported_kinds[$kind];
}
// When the skin doesn't say... consider it a "maybe":
return 'maybe';
}
/*
* What CSS framework does has this skin been designed with?
*
* This may impact default markup returned by Skin::get_template() for example
*/
function get_css_framework()
{
return ''; // Other possibilities: 'bootstrap', 'foundation'... (maybe 'bootstrap4' later...)
}
/**
* Load data from Request form fields.
*
* @return boolean true if loaded data seems valid.
*/
function load_from_Request()
{
// Name
param_string_not_empty( 'skin_name', T_('Please enter a name.') );
$this->set_from_Request( 'name' );
// Skin type
param( 'skin_type', 'string' );
$this->set_from_Request( 'type' );
return ! param_errors_detected();
}
/**
* Load params
*/
function load_params_from_Request()
{
load_funcs('plugins/_plugin.funcs.php');
// Loop through all widget params:
foreach( $this->get_param_definitions( array('for_editing'=>true) ) as $parname => $parmeta )
{
if( isset( $parmeta['type'] ) && $parmeta['type'] == 'color' && empty( $parmeta['valid_pattern'] ) )
{ // Set default validation for color fields
$parmeta['valid_pattern'] = array(
'pattern' => '~^(#([a-f0-9]{3}){1,2})?$~i',
'error' => T_('Invalid color code.')
);
}
autoform_set_param_from_request( $parname, $parmeta, $this, 'Skin' );
}
}
/**
* Display a container
*
* @todo fp> if it doesn't get any skin specific, move it outta here! :P
* fp> Do we need Skin objects in the frontoffice at all? -- Do we want to include the dispatcher into the Skin object? WARNING: globals
* fp> We might want to customize the container defaults. -- Per blog or per skin?
*
* @param string
* @param array
*/
function container( $sco_name, $params = array() )
{
/**
* Blog currently displayed
* @var Blog
*/
global $Collection, $Blog;
global $admin_url, $rsc_url;
global $Timer, $Session, $debug, $current_User;
$params = array_merge( array(
'container_display_if_empty' => true, // FALSE - If no widget, don't display container at all, TRUE - Display container anyway
'container_start' => '',
'container_end' => '',
), $params );
$timer_name = 'skin_container('.$sco_name.')';
$Timer->start( $timer_name );
// Get container code from container name:
$container_code = preg_replace( '/[^a-z\d]+/', '_', strtolower( $sco_name ) );
// Start to get content of widgets:
ob_start();
$display_containers = ( $debug == 2 ) || ( is_logged_in() && $Session->get( 'display_containers_'.$Blog->ID ) );
if( $display_containers )
{ // Wrap container in visible container:
echo '<div class="dev-blocks dev-blocks--container"><div class="dev-blocks-name">';
if( is_logged_in() && $current_User->check_perm( 'blog_properties', 'edit', false, $Blog->ID ) )
{ // Display a link to edit this widget only if current user has a permission:
echo '<span class="dev-blocks-action"><a href="'.$admin_url.'?ctrl=widgets&blog='.$Blog->ID.'">Edit</a></span>';
}
echo 'Container: <b>'.$sco_name.'</b></div>';
}
/**
* @var EnabledWidgetCache
*/
$EnabledWidgetCache = & get_EnabledWidgetCache();
$Widget_array = & $EnabledWidgetCache->get_by_coll_container( $Blog->ID, $sco_name );
if( ! empty( $Widget_array ) )
{
foreach( $Widget_array as $w => $ComponentWidget )
{ // Let the Widget display itself (with contextual params):
if( $w == 0 )
{ // Use special params for first widget in the current container
$orig_params = $params;
if( isset( $params['block_first_title_start'] ) )
{
$params['block_title_start'] = $params['block_first_title_start'];
}
if( isset( $params['block_first_title_end'] ) )
{
$params['block_title_end'] = $params['block_first_title_end'];
}
}
$widget_timer_name = 'Widget->display('.$ComponentWidget->code.')';
$Timer->start( $widget_timer_name );
$ComponentWidget->display_with_cache( $params, array(
// 'sco_name' => $sco_name, // fp> not sure we need that for now
) );
if( $w == 0 )
{ // Restore the params for next widgets after first
$params = $orig_params;
unset( $orig_params );
}
$Timer->pause( $widget_timer_name );
}
}
if( $display_containers )
{ // End of visible container:
//echo get_icon( 'pixel', 'imgtag', array( 'class' => 'clear' ) );
echo '</div>';
}
// Store content of widgets to var in order to display them in container wrapper:
$container_widgets_content = ob_get_clean();
if( $params['container_display_if_empty'] || ! empty( $Widget_array ) )
{ // Display container wrapper with widgets content if it is not empty or we should display it anyway:
// Display start of container wrapper:
echo str_replace( '$wico_class$', 'evo_container__'.str_replace( ' ', '_', $container_code ), $params['container_start'] );
// Display widgets of the container:
echo $container_widgets_content;
// Display end of container wrapper:
echo $params['container_end'];
}
$Timer->pause( $timer_name );
}
/**
* Discover containers included in skin files only in the given folder
*
* @param string Folder name
* @param array Exclude the files
* @return array Files that were prepared
*/
function discover_containers_by_folder( $folder, $exclude_files = array() )
{
global $skins_path, $Messages;
if( empty( $folder ) )
{ // Get files from fallback skins folder:
global $basepath;
$skin_folder = $this->get_api_version() == 6 ? 'skins_fallback_v6' : 'skins_fallback_v5';
$skin_path = $basepath.$skin_folder;
}
else
{ // Get files from given skin folder:
$skin_folder = $folder;
$skin_path = $skins_path.$skin_folder;
}
if( ! $dir = @opendir( $skin_path ) )
{ // Skin directory not found!
$Messages->add( T_('Cannot open skin directory.'), 'error' ); // No trans
return false;
}
// Store the file names to return
$files = array();
// Go through all files in the skin directory:
while( ( $file = readdir( $dir ) ) !== false )
{
if( is_array( $exclude_files ) && in_array( $file, $exclude_files ) )
{ // Skip this file
continue;
}
$af_main_path = $skin_path.'/'.$file;
if( !is_file( $af_main_path ) || ! preg_match( '~\.php$~', $file ) )
{ // Not a php template file, go to next:
continue;
}
if( ! is_readable( $af_main_path ) )
{ // Cannot open PHP file:
$Messages->add_to_group( sprintf( T_('Cannot read skin file «%s»!'), $skin_folder.'/'.$file ), 'error', T_('File read error:') );
continue;
}
$file_contents = @file_get_contents( $af_main_path );
if( ! is_string( $file_contents ) )
{ // Cannot get contents:
$Messages->add_to_group( sprintf( T_('Cannot read skin file «%s»!'), $skin_folder.'/'.$file ), 'error', T_('File read error:') );
continue;
}
$files[] = $file;
// DETECT if the file contains containers:
// if( ! preg_match_all( '~ \$Skin->container\( .*? (\' (.+?) \' )|(" (.+?) ") ~xmi', $file_contents, $matches ) )
if( ! preg_match_all( '~ (\$Skin->|skin_)container\( .*? ([\'"] (.+?) [\'"]) ~xmi', $file_contents, $matches ) )
{ // No containers in this file, go to next:
continue;
}
$c = 0;
foreach( $matches[3] as $container )
{
// We have one more container:
$c++;
if( in_array( $container, $this->container_list ) )
{ // we already have that one
continue;
}
$this->container_list[] = $container;
}
if( $c )
{
$Messages->add_to_group( sprintf( T_('%d containers have been found in skin template «%s».'), $c, $skin_folder.'/'.$file ), 'success', sprintf( T_('Containers found in skin "%s":'), $skin_folder ) );
}
}
return $files;
}
/**
* Discover containers included in skin files
*/
function discover_containers()
{
global $Messages;
$this->container_list = array();
// Find the containers in the current skin folder
$skin_files = $this->discover_containers_by_folder( $this->folder );
// Find the containers in the root skins folder with excluding the files that are contained in the skin folder
$this->discover_containers_by_folder( '', $skin_files );
if( empty( $this->container_list ) )
{
$Messages->add( T_('No containers found in this skin!'), 'error' );
return false;
}
return true;
}
/**
* Get the list of containers that have been previously discovered for this skin.
*
* @return array
*/
function get_containers()
{
/**
* @var DB
*/
global $DB;
if( is_null( $this->container_list ) )
{
$this->container_list = $DB->get_col(
'SELECT sco_name
FROM T_skins__container
WHERE sco_skin_ID = '.$this->ID, 0, 'get list of containers for skin' );
}
return $this->container_list;
}
/**
* Update the DB based on previously recorded changes
*
* @return boolean true
*/
function dbupdate()
{
global $DB;
$DB->begin();
if( parent::dbupdate() !== false )
{ // Skin updated, also save containers:
$this->db_save_containers();
}
$DB->commit();
return true;
}
/**
* Insert object into DB based on previously recorded changes.
*
* @return boolean true
*/
function dbinsert()
{
global $DB;
$DB->begin();
if( parent::dbinsert() )
{ // Skin saved, also save containers:
$this->db_save_containers();
}
$DB->commit();
return true;
}
/**
* Save containers
*
* to be called by dbinsert / dbupdate
*/
function db_save_containers()
{
global $DB;
// Get a list of all currently empty containers:
$sql = 'SELECT sco_name
FROM T_skins__container LEFT JOIN T_widget ON ( sco_name = wi_sco_name )
WHERE sco_skin_ID = '.$this->ID.'
GROUP BY sco_name
HAVING COUNT(wi_ID) = 0';
$empty_containers_list = $DB->get_col( $sql, 0, 'Get empty containers' );
//pre_dump( $empty_containers_list );
// Look for containers in skin file:
$this->discover_containers();
// Delete empty containers:
foreach( $empty_containers_list as $empty_container )
{
if( !in_array( $empty_container, $this->container_list ) )
{ // This container has been removed from the skin + it's empty, so delete it from DB:
$DB->query( 'DELETE FROM T_skins__container
WHERE sco_name = '.$DB->quote($empty_container) );
}
}
// Make sure new containers are added:
if( ! empty( $this->container_list ) )
{
$values = array();
foreach( $this->container_list as $container_name )
{
$values [] = '( '.$this->ID.', '.$DB->quote($container_name).' )';
}
$DB->query( 'REPLACE INTO T_skins__container( sco_skin_ID, sco_name )
VALUES '.implode( ',', $values ), 'Insert containers' );
}
}
/**
* Display skinshot for skin folder in various places.
*
* Including for NON installed skins.
*
* @param string Skin folder
* @param string Skin name
* @param array Params
*/
static function disp_skinshot( $skin_folder, $skin_name, $disp_params = array() )
{
global $skins_path, $skins_url, $kind;
$disp_params = array_merge( array(
'selected' => false,
'skinshot_class' => 'skinshot',
'skin_compatible' => true,
'highlighted' => false,
), $disp_params );
if( isset( $disp_params[ 'select_url' ] ) )
{
$skin_url = $disp_params[ 'select_url' ];
$select_a_begin = '<a href="'.$disp_params[ 'select_url' ].'" title="'.T_('Select this skin!').'">';
$select_a_end = '</a>';
}
elseif( isset( $disp_params[ 'function_url' ] ) )
{
$skin_url = $disp_params[ 'function_url' ];
$select_a_begin = '<a href="'.$disp_params[ 'function_url' ].'" title="'.T_('Install NOW!').'">';
$select_a_end = '</a>';
}
else
{
$skin_url = '';
$select_a_begin = '';
$select_a_end = '';
}
// Display skinshot:
echo '<div class="'.$disp_params['skinshot_class'].( $disp_params['highlighted'] ? ' evo_highlight' : '' ).'">';
echo '<div class="skinshot_placeholder';
if( $disp_params[ 'selected' ] )
{
echo ' current';
}
echo '">';
if( file_exists( $skins_path.$skin_folder.'/skinshot.png' ) )
{
echo $select_a_begin;
echo '<img src="'.$skins_url.$skin_folder.'/skinshot.png" width="240" height="180" alt="'.$skin_folder.'" />';
echo $select_a_end;
}
elseif( file_exists( $skins_path.$skin_folder.'/skinshot.jpg' ) )
{
echo $select_a_begin;
echo '<img src="'.$skins_url.$skin_folder.'/skinshot.jpg" width="240" height="180" alt="'.$skin_folder.'" />';
echo $select_a_end;
}
elseif( file_exists( $skins_path.$skin_folder.'/skinshot.gif' ) )
{
echo $select_a_begin;
echo '<img src="'.$skins_url.$skin_folder.'/skinshot.gif" width="240" height="180" alt="'.$skin_folder.'" />';
echo $select_a_end;
}
else
{
echo '<div class="skinshot_noshot">'.T_('No skinshot available for').'</div>';
echo '<div class="skinshot_name">'.$select_a_begin.$skin_folder.$select_a_end.'</div>';
}
echo '</div>';
//
echo '<div class="legend">';
if( isset( $disp_params['function'] ) )
{
echo '<div class="actions">';
switch( $disp_params['function'] )
{
case 'broken':
echo '<span class="text-danger">';
if( ! empty( $disp_params['msg'] ) )
{
echo $disp_params[ 'msg' ];
}
else
{
echo T_('Broken.');
}
echo '</span>';
if( ! empty( $disp_params['help_info'] ) )
{
echo ' '.get_icon( 'help', 'imgtag', array( 'title' => $disp_params['help_info'] ) );
}
break;
case 'install':
// Display a link to install the skin
if( ! empty( $skin_url ) )
{
echo '<a href="'.$skin_url.'" title="'.T_('Install NOW!').'">';
echo T_('Install NOW!').'</a>';
}
if( empty( $kind ) && get_param( 'tab' ) != 'current_skin' )
{ // Don't display the checkbox on new collection creating form and when we install one skin for the selected collection:
$skin_name_before = '<label><input type="checkbox" name="skin_folders[]" value="'.$skin_name.'" /> ';
$skin_name_after = '</label>';
}
break;
case 'upgrade':
$link_text = T_('Upgrade NOW!');
case 'downgrade':
if( empty( $link_text ) ) $link_text = T_('Downgrade NOW!');
if( ! empty( $skin_url ) )
{
echo '<a href="'.$skin_url.'" title="'.$link_text.'">';
echo $link_text.'</a>';
}
if( empty( $kind ) && get_param( 'tab' ) != 'current_skin' )
{ // Don't display the checkbox on new collection creating form and when we install one skin for the selected collection:
$skin_name_before = '<label><input type="checkbox" name="skin_folders[]" value="'.$skin_name.'" /> ';
$skin_name_after = '</label>';
}
break;
case 'select':
// Display a link to preview the skin:
if( ! empty( $disp_params['function_url'] ) )
{
echo '<a href="'.$disp_params['function_url'].'" target="_blank" title="'.T_('Preview blog with this skin in a new window').'">';
echo /* TRANS: Verb */ T_('Preview').'</a>';
}
break;
}
echo '</div>';
}
echo '<strong>'
.( empty( $skin_name_before ) ? '<label>' : $skin_name_before )
.$skin_name
.( empty( $skin_name_after ) ? '</label>' : $skin_name_after )
.'</strong>';
echo '</div>';
echo '</div>';
}
/**
* Get definitions for editable params
*
* @todo this is destined to be overridden by derived Skin classes
*
* @see Plugin::GetDefaultSettings()
* @param local params like 'for_editing' => true
*/
function get_param_definitions( $params )
{
$r = array();
return $r;
}
/**
* Get a skin specific param value from current Blog
*
* @param string Setting name
* @param string Input group name
* @return string|array|NULL
*/
function get_setting( $parname, $group = NULL )
{
/**
* @var Blog
*/
global $Collection, $Blog;
if( ! empty( $group ) )
{ // $parname is prefixed with $group, we'll remove the group prefix
$parname = substr( $parname, strlen( $group ) );
}
// Name of the setting in the blog settings:
$blog_setting_name = 'skin'.$this->ID.'_'.$group.$parname;
$value = $Blog->get_setting( $blog_setting_name );
if( ! is_null( $value ) )
{ // We have a value for this param:
return $value;
}
return $this->get_setting_default_value( $group.$parname, $group );
}
/**
* Get a skin specific param default value
*
* @param string Setting name
* @param string Input group name
* @return string|array|NULL
*/
function get_setting_default_value( $parname, $group = NULL )
{
if( ! empty ( $group ) )
{
$parname = substr( $parname, strlen( $group ) );
}
// Try default values:
$params = $this->get_param_definitions( NULL );
if( isset( $params[ $parname ]['defaultvalue'] ) )
{ // We have a default value:
return $params[ $parname ]['defaultvalue'] ;
}
elseif( isset( $params[ $parname ]['type'] ) &&
$params[ $parname ]['type'] == 'checklist' &&
! empty( $params[ $parname ]['options'] ) )
{ // Get default values for checkbox list:
$options = array();
foreach( $params[ $parname ]['options'] as $option )
{
if( isset( $option[2] ) )
{ // Set default value only if it is defined by skin:
$options[ $option[0] ] = $option[2];
}
}
return $options;
}
elseif( isset( $params[ $parname ]['type'] ) &&
$params[ $parname ]['type'] == 'fileselect' &&
! empty( $params[ $parname ]['initialize_with'] ) &&
$default_File = & get_file_by_abspath( $params[ $parname ]['initialize_with'], true ) )
{ // Get default value for fileselect
return $default_File->ID;
}
elseif( ! empty( $group ) &&
isset( $params[ $group ]['type'] ) &&
$params[ $group ]['type'] == 'input_group' &&
! empty( $params[ $group ]['inputs'] ) &&
isset( $params[ $group ]['inputs'][ $parname ] ) )
{
return $params[ $group ]['inputs'][ $parname ]['defaultvalue'];
}
return NULL;
}
/**
* Get current skin post navigation setting.
* Possible values:
* - NULL - In this case the Blog post navigation setting will be used
* - 'same_category' - to always navigate through the same category in this skin
* - 'same_author' - to always navigate through the same authors in this skin
* - 'same_tag' - to always navigate through the same tags in this skin
*
* Set this to not NULL only if the same post navigation should be used in every Blog where this skin is used
*/
function get_post_navigation()
{
return NULL;
}
/**
* Get current skin path
* @return string
*/
function get_path()
{
global $skins_path;
return trailing_slash($skins_path.$this->folder);
}
/**
* Get current skin URL
* @return string
*/
function get_url()
{
global $skins_url;
return trailing_slash($skins_url.$this->folder);
}
/**
* Set a skin specific param value for current Blog
*
* @param string parameter name
* @param mixed parameter value
*/
function set_setting( $parname, $parvalue )
{
/**
* @var Blog
*/
global $Collection, $Blog;
// Name of the setting in the blog settings:
$blog_setting_name = 'skin'.$this->ID.'_'.$parname;
// Convert array values into string for DB storage
if( is_array( $parvalue ) )
{
$parvalue = serialize( $parvalue );
}
$Blog->set_setting( $blog_setting_name, $parvalue );
}
/**
* Save skin specific settings for current blgo to DB
*/
function dbupdate_settings()
{
/**
* @var Blog
*/
global $Collection, $Blog;
$Blog->dbupdate();
}
/**
* Get ready for displaying the skin.
*
* This method may register some CSS or JS.
* The default implementation can register a few common things that you may request in the $features param.
* This is where you'd specify you want to use BOOTSTRAP, etc.
*
* If this doesn't do what you need you may add functions like the following to your skin's display_init():
* require_js() , require_css() , add_js_headline()
*
* @param array of possible features you want to include. If empty, will default to {'b2evo_base', 'style', 'colorbox'} for backwards compatibility.
*/
function display_init( /*optional: $features = array() */ )
{
global $debug, $Messages, $disp, $UserSettings;
// We get the optional arg this way for PHP7 comaptibility:
@list( $features ) = func_get_args();
if( empty($features) )
{ // Fall back to v5 default set of features:
$features = array( 'b2evo_base_css', 'style_css', 'colorbox', 'disp_auto' );
}
// "Temporary" patch to at least have disp_auto unless another disp_xxx was specified. Use 'disp_off' to NOT include anuthing.
if( !preg_grep( '/disp_.*/', $features ) )
{
$features[] = 'disp_auto';
}
// We're NOT using foreach so that the array can continue to grow during parsing: (see 'disp_auto')
for( $i = 0; isset($features[$i]); $i++ )
{
// Get next feature to include:
$feature = $features[$i];
switch( $feature )
{
case 'jquery':
// Include jQuery:
require_js( '#jquery#', 'blog' );
break;
case 'font_awesome':
// Initialize font-awesome icons and use them as a priority over the glyphicons, @see get_icon()
init_fontawesome_icons( 'fontawesome-glyphicons', 'blog' );
break;
case 'bootstrap':
// Include Bootstrap:
require_js( '#bootstrap#', 'blog' );
require_css( '#bootstrap_css#', 'blog' );
break;
case 'bootstrap_theme_css':
// Include the Bootstrap Theme CSS: