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
<?php
/**
*
*/
abstract class Loco_mvc_AdminController extends Loco_mvc_Controller {
/**
* @var Loco_mvc_View
*/
private $view;
/**
* Debugging timestamp (microseconds)
* @var float
*/
private $bench;
/**
* Base url to plugin folder for web access
* @var string
*/
private $baseurl;
/**
* Pre-init call invoked by router
* @return Loco_mvc_AdminController
*/
final public function _init( array $args ){
if( loco_debugging() ){
$this->bench = microtime( true );
}
$this->view = new Loco_mvc_View( $args );
$this->auth();
// check essential extensions on all pages so admin notices are shown
foreach( array('json','mbstring') as $ext ){
loco_check_extension($ext);
}
// add contextual help tabs to current screen if there are any
if( $screen = get_current_screen() ){
try {
$this->view->cd('/admin/help');
$tabs = $this->getHelpTabs();
// always append common help tabs
$tabs[ __('Help & support','loco-translate') ] = $this->view->render('tab-support');
// set all tabs and common side bar
$i = 0;
foreach( $tabs as $title => $content ){
$id = sprintf('loco-help-%u', $i++ );
$screen->add_help_tab( compact('id','title','content') );
}
$screen->set_help_sidebar( $this->view->render('side-bar') );
$this->view->cd('/');
}
// avoid critical errors rendering non-critical part of page
catch( Loco_error_Exception $e ){
$this->view->cd('/');
Loco_error_AdminNotices::add( $e );
}
}
// helper properties for loading static resources
$this->baseurl = plugins_url( '', loco_plugin_self() );
// add common admin page resources
$this->enqueueStyle('admin', array('wp-jquery-ui-dialog') );
// load colour scheme is user has non-default
$skin = get_user_option('admin_color');
if( $skin && 'fresh' !== $skin ){
$this->enqueueStyle( 'skins/'.$skin );
}
// core minimized admin.js loaded on all pages before any other Loco scripts
$this->enqueueScript('min/admin', array('jquery-ui-dialog') );
$this->init();
return $this;
}
/**
* Post-construct initializer that may be overridden by child classes
* @return void
*/
public function init(){
}
/**
* "admin_title" filter, modifies HTML document title if we've set one
*/
public function filter_admin_title( $admin_title, $title ){
if( $view_title = $this->get('title') ){
$admin_title = $view_title.' ‹ '.$admin_title;
}
return $admin_title;
}
/**
* "admin_footer_text" filter, modifies admin footer only on Loco pages
*/
public function filter_admin_footer_text(){
$url = apply_filters('loco_external', 'https://localise.biz/');
return '<span id="loco-credit">'.sprintf( '<span>%s</span> <a href="%s" target="_blank">Loco</a>', esc_html(__('Loco Translate is powered by','loco-translate')), esc_url($url) ).'</span>';
}
/**
* "update_footer" filter, prints Loco version number in admin footer
*/
public function filter_update_footer( $text ){
$html = sprintf( '<span>v%s</span>', loco_plugin_version() );
if( $this->bench && ( $info = $this->get('_debug') ) ){
$html .= sprintf('<span>%ss</span>', number_format_i18n($info['time'],2) );
}
return $html;
}
/**
* "loco_external" filter callback, campaignizes external links
*/
public function filter_loco_external( $url ){
$u = parse_url( $url );
if( isset($u['host']) && 'localise.biz' === $u['host'] ){
$query = http_build_query( array( 'utm_medium' => 'plugin', 'utm_campaign' => 'wp', 'utm_source' => 'admin', 'utm_content' => $this->get('_route') ), null, '&' );
$url = 'https://localise.biz'.$u['path'];
if( isset($u['query']) ){
$url .= '?'. $u['query'].'&'.$query;
}
else {
$url .= '?'.$query;
}
if( isset($u['fragment']) ){
$url .= '#'.$u['fragment'];
}
}
return $url;
}
/**
* All admin screens must define help tabs, even if they return empty
* @return array
*/
public function getHelpTabs(){
return array();
}
/**
* {@inheritdoc}
*/
public function get( $prop ){
return $this->view->__get($prop);
}
/**
* {@inheritdoc}
*/
public function set( $prop, $value ){
$this->view->set( $prop, $value );
return $this;
}
/**
* Render template for echoing into admin screen
* @return string
*/
public function view( $tpl, array $args = array() ){
/*if( ! $this->baseurl ){
throw new Loco_error_Debug('Did you mean to call $this->viewSnippet('.json_encode($tpl,JSON_UNESCAPED_SLASHES).') in '.get_class($this).'?');
}*/
$view = $this->view;
foreach( $args as $prop => $value ){
$view->set( $prop, $value );
}
// ensure JavaScript config always present
if( $jsConf = $view->js ){
if( ! $jsConf instanceof Loco_mvc_ViewParams ){
throw new InvalidArgumentException('Bad "js" view parameter');
}
}
else {
$jsConf = new Loco_mvc_ViewParams;
$view->set( 'js', $jsConf );
}
// localize script if translations in memory
if( is_textdomain_loaded('loco-translate') ){
$strings = new Loco_js_Strings;
$jsConf['wpl10n'] = $strings->compile();
$strings->unhook();
unset( $strings );
// add currently loaded locale for passing plural equation into js.
// note that plural rules come from our data, because MO is not trusted.
$tag = apply_filters( 'plugin_locale', get_locale(), 'loco-translate' );
$jsConf['wplang'] = Loco_Locale::parse($tag);
}
// take benchmark for debugger to be rendered in footer
if( $this->bench ){
$this->set('_debug', new Loco_mvc_ViewParams( array(
'time' => microtime(true) - $this->bench,
) ) );
// additional debugging info when enabled
$jsConf['WP_DEBUG'] = true;
}
return $view->render( $tpl );
}
/**
* Shortcut to render template without full page arguments as per view
* @return string
*/
public function viewSnippet( $tpl ){
return $this->view->render( $tpl );
}
/**
* Add CSS to head
* @return Loco_mvc_Controller
*/
public function enqueueStyle( $name, array $deps = array() ){
if( $base = $this->baseurl ){
$href = $base.'/pub/css/'.$name.'.css';
$vers = apply_filters( 'loco_static_version', loco_plugin_version(), $href );
wp_enqueue_style( 'loco-'.strtr($name,'/','-'), $href, $deps, $vers, 'all' );
return $this;
}
throw new Loco_error_Exception('Too early to enqueueStyle('.json_encode($name,JSON_UNESCAPED_SLASHES).')');
}
/**
* Add JavaScript to footer
* @return Loco_mvc_Controller
*/
public function enqueueScript( $name, array $deps = array() ){
if( $base = $this->baseurl ){
$href = $base.'/pub/js/'.$name.'.js';
$vers = apply_filters( 'loco_static_version', loco_plugin_version(), $href );
wp_enqueue_script( 'loco-js-'.strtr($name,'/','-'), $href, $deps, $vers, true );
return $this;
}
throw new Loco_error_Exception('Too early to enqueueScript('.json_encode($name,JSON_UNESCAPED_SLASHES).')');
}
}