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
|
<?php
namespace Bitweaver\Plugins;
use Bitweaver\KernelTools;
/**
* Smarty plugin
* @package Smarty
* @subpackage plugins
* @author xing <xing$synapse.plus.com>
* @link https://www.bitweaver.org/wiki/function_smartlink function.smartlink
*/
/**
* Smarty {smartlink} function plugin
*
* Type: function<br>
* Name: smartlink<br>
* Input:<br>
* - ititle (required) words that are displayed<br>
* - iatitle (optional) alternative text for the link title (rollover, etc.) <br>
* - ianchor (optional) set the anchor where the link should point to<br>
* - isort (optional) name of the sort column without the orientation (e.g.: title)<br>
* - isort_mode(optional) this can be used to manually pass the sort mode to smartlink<br>
* overrides the value given in $_REQUEST['sort_mode'], which is the default<br>
* - iorder (optional) if set to asc or desc, it sets the default sorting order of this particular column<br>
* asc is default<br>
* - idefault (optional) if set, it will highlight this link if no $isort_mode is given<br>
* this should only be set once per sorting group since it represents the default sorting column<br>
* - itra (optional) if present then don't translate<br>
* - itype (optional) can be set to<br>
* url --> outputs only url<br>
* li --> outputs link as <li><a ... ></li><br>
* - ionclick (optional) pass in any actions that should occur onclick<br>
* - ibiticon (optional) if you want to display an icon instead of text use ibiticon<br>
* format is: '<ipackage>/<iname>'<br>
* e.g.: 'liberty/edit'<br>
* - iforce (optional) pass iforce parameter through to biticon
* - iurl (optional) pass in a full url
* - ifile (optional) set the file where the link should point (default is the current file)<br>
* - ipackage (optional) set the package the link should point to (default is the current package)<br>
* - icontrol (optional) the hash sent out by postGetList()
* - * (optional) anything else that gets added to the pile of items is appended using &$key=$val<br>
* - ihash (optional) you can pass in all the above as an array called ihash or secondary * items common to all links<br>
* Output: any kind of link. especially useful when it comes to links used to sort a table, due to the simplified syntax and loss of cumbersome if clauses
* also useful if the you want to display an icon as link since smartlink takes biticon parameters<br>
* Example - {smartlink ititle="Page Name" isort="title"}<br>
* - {smartlink ititle="Page Name" isort="title" iorder="desc" idefault=1}<br>
* setting iorder and idefault here, makes this link sort in a descending order by default (iorder)<br>
* and it is highlighted when $isort_mode ( or $_REQUEST['sort_mode'] ) is not set (idefault)<br>
* Note Be careful if ititle is generated dynamically since it is passed through KernelTools::tra() by default, use itra to override<br>
*/
function smarty_function_smartlink( $pParams, &$pSmarty=NULL ) {
global $gBitSystem;
if( !empty( $pParams['ihash'] ) ) {
$hash = array_merge( $pParams['ihash'], $pParams );
$hash['ihash'] = NULL;
} else {
// maybe params were passed in separately
$hash = &$pParams;
}
if( !isset( $hash['ititle'] ) ) {
return 'You need to supply "ititle" for {smartlink} to work.';
}
// work out what the url is
if( !empty( $hash['iurl'] ) ) {
$url = $hash['iurl'];
} elseif( !empty( $hash['ifile'] ) ) {
$url = !empty( $hash['ipackage'] )
? ( $hash['ipackage'] == 'root'
? $url = BIT_ROOT_URL.$hash['ifile']
: constant( strtoupper( $hash['ipackage'] ).'_PKG_URL' ).$hash['ifile'] )
: constant( strtoupper( $gBitSystem->getActivePackage() ).'_PKG_URL' ).$hash['ifile'];
} else {
$url = $_SERVER['SCRIPT_NAME'];
}
$url_params = NULL;
if( isset( $hash['itra'] ) && !empty( $hash['itra'] ) ) {
// present and non-zero value
$ititle = $hash['ititle'];
$iatitle = empty( $hash['iatitle'] ) ? $ititle : $hash['iatitle'];
} else {
$ititle = KernelTools::tra( $hash['ititle'] );
$iatitle = empty( $hash['iatitle'] ) ? $ititle : KernelTools::tra( $hash['iatitle'] );
}
$atitle = 'title="'.$iatitle.'"';
// if isort is set, we need to deal with all the sorting stuff
if( !empty( $hash['isort'] ) ) {
$isort_mode = $hash['isort_mode'] ?? ($_REQUEST['sort_mode'] ?? NULL);
$sort_asc = $hash['isort'].'_asc';
$sort_desc = $hash['isort'].'_desc';
$atitle = 'title="'.KernelTools::tra( 'Sort by' ).": ".$iatitle.'"';
$url .= '?';
$url_params .= 'sort_mode=';
// check if we have to highlight this link, when $isort_mode isn't set
if( isset( $hash['idefault'] ) && empty( $isort_mode ) ) {
$isort_mode .= $hash['isort'].'_'.( $hash['iorder'] ?? 'asc' );
}
// check if sort_mode has anything to do with our link
if( $sort_asc == $isort_mode ) {
$sorticon = [
'ipackage' => 'icons',
'iname' => 'icon-sort-up',
'iexplain' => 'ascending',
'iforce' => 'icon',
];
$url_params .= $sort_desc;
} elseif( $sort_desc == $isort_mode ) {
$sorticon = [
'ipackage' => 'icons',
'iname' => 'icon-sort-down',
'iexplain' => 'descending',
'iforce' => 'icon',
];
$url_params .= $sort_asc;
} else {
$url_params .= $hash['isort'].'_'.( $hash['iorder'] ?? 'asc' );
}
}
$ignore = [ 'iatitle', 'icontrol', 'isort', 'ianchor', 'isort_mode', 'iorder', 'ititle', 'idefault', 'ifile', 'ipackage', 'itype', 'iurl', 'ionclick', 'ibiticon', 'booticon', 'biticon', 'iforce', 'itra' ];
// append any other paramters that were passed in
foreach( $hash as $key => $val ) {
if( !empty( $val ) && !in_array( $key, $ignore ) ) {
// normally the key is a string
if( !is_array( $val ) ){
$url_params .= empty( $url_params ) ? '?' : '&';
$url_params .= $key."=".$val;
// but sometimes it can be an array
}else{
foreach( $val as $v ){
$url_params .= empty( $url_params ) ? '?' : '&';
$url_params .= $key."[]=".$v;
}
}
}
}
if( !empty( $hash['icontrol'] ) && is_array( $hash['icontrol'] ) ) {
$sep = empty( $url_params ) ? '?' : '&';
$url_params .= !empty( $hash['icontrol']['current_page'] ) ? $sep.'list_page='.$hash['icontrol']['current_page'] : '';
$sep = empty( $url_params ) ? '?' : '&';
$url_params .= !empty( $hash['icontrol']['find'] ) ? $sep.'find='.$hash['icontrol']['find'] : '';
if( !empty( $hash['icontrol']['parameters'] ) && is_array( $hash['icontrol']['parameters'] ) ) {
foreach( $hash['icontrol']['parameters'] as $key => $value ) {
if( !empty( $value )) {
$sep = empty( $url_params ) ? '?' : '&';
$url_params .= $sep.$key."=".$value;
}
}
}
}
// encode quote marks so we not break href="" construction
$url_params = preg_replace('/"/', '%22', $url_params ?? '');
if( isset( $hash['itype'] ) && $hash['itype'] == 'url' ) {
$ret = $url.$url_params;
} else {
$ret = '<a class="icon" '.$atitle.' '.( !empty( $pParams['ionclick'] ) ? 'onclick="'.$pParams['ionclick'].'" ' : '' ).'href="'.$url.$url_params.( !empty( $pParams['ianchor'] ) ? '#'.$pParams['ianchor'] : '' ).'">';
// if we want to display an icon instead of text, do that
if( isset( $hash['biticon'] ) || isset( $hash['booticon'] ) ) {
$iname = $hash['biticon'] ?? $hash['booticon'];
$biticon = [
'ipackage' => 'icons',
'iname' => $iname,
'iexplain' => $hash['ititle'],
];
if( !empty( $hash['iforce'] ) ) {
$biticon['iforce'] = $hash['iforce'];
}
$ret .= smarty_function_biticon( $biticon );
} elseif( isset( $hash['ibiticon'] ) ) {
$tmp = explode( '/', $hash['ibiticon'] );
if( !empty( $tmp[2] )) {
$tmp[1] .= "/".$tmp[2];
}
$ibiticon = [
'ipackage' => $tmp[0],
'iname' => $tmp[1],
'iexplain' => $hash['ititle'], // use untranslated ititle - biticon has a KernelTools::tra()
];
if( !empty( $hash['iforce'] ) ) {
$ibiticon['iforce'] = $hash['iforce'];
}
$ret .= smarty_function_biticon( $ibiticon );
} else {
$ret .= $ititle;
}
if( isset( $sorticon ) ) {
$ret .= ' '.smarty_function_biticon( $sorticon );
}
$ret .= '</a>';
}
if( isset( $pParams['itype'] ) && $pParams['itype'] == 'li' ) {
$ret = '<li>'.$ret.'</li>';
}
return $ret;
}
|
