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
/**
* TClientScript class file
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @link http://www.pradosoft.com/
* @copyright Copyright © 2005 PradoSoft
* @license http://www.pradosoft.com/license/
* @version $Id$
* @package System.Web.UI.WebControls
*/
/**
* TClientScript class
*
* Allows importing of Prado Client Scripts from template via the
* {@link setPradoScripts PradoScripts} property. Multiple Prado
* client-scripts can be specified using comma delimited string of the
* javascript library to include on the page. For example,
*
* <code>
* <com:TClientScript PradoScripts="effects, rico" />
* </code>
*
* Custom javascript files can be register using the {@link setScriptUrl ScriptUrl}
* property.
* <code>
* <com:TClientScript ScriptUrl=<%~ test.js %> />
* </code>
*
* Contents within TClientScript will be treated as javascript code and will be
* rendered in place.
*
* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
* @version $Id$
* @package System.Web.UI.WebControls
* @since 3.0
*/
class TClientScript extends TControl
{
const SCRIPT_LOADER = 'Web/Javascripts/clientscripts.php';
/**
* @return string comma delimited list of javascript libraries to included
* on the page.
*/
public function getPradoScripts()
{
return $this->getViewState('PradoScripts', '');
}
/**
* Include javascript library to the current page. The current supported
* libraries are: "prado", "effects", "ajax", "validator", "logger",
* "datepicker", "colorpicker". Library dependencies are automatically resolved.
*
* @param string comma delimited list of javascript libraries to include.
*/
public function setPradoScripts($value)
{
$this->setViewState('PradoScripts', $value, '');
}
/**
* @return string custom javascript file url.
*/
public function getScriptUrl()
{
return $this->getViewState('ScriptUrl', '');
}
/**
* @param string custom javascript file url.
*/
public function setScriptUrl($value)
{
$this->setViewState('ScriptUrl', $value, '');
}
/**
* @param string custom javascript library directory.
*/
public function setPackagePath($value)
{
$this->setViewState('PackagePath', $value);
}
/**
* @return string custom javascript library directory.
*/
public function getPackagePath()
{
return $this->getViewState('PackagePath');
}
/**
* @param string load specific packages from the javascript library in the PackagePath, comma delimited package names
*/
public function setPackageScripts($value)
{
$this->setViewState('PackageScripts', $value,'');
}
/**
* @return string comma delimited list of javascript library packages to load.
*/
public function getPackageScripts()
{
return $this->getViewState('PackageScripts','');
}
/**
* Calls the client script manager to add each of the requested client
* script libraries.
* @param mixed event parameter
*/
public function onPreRender($param)
{
parent::onPreRender($param);
$scripts = preg_split('/,|\s+/', $this->getPradoScripts());
$cs = $this->getPage()->getClientScript();
foreach($scripts as $script)
{
if(($script = trim($script))!=='')
$cs->registerPradoScript($script);
}
}
/**
* Renders the body content as javascript block.
* Overrides parent implementation, parent renderChildren method is called during
* {@link registerCustomScript}.
* @param THtmlWriter the renderer
*/
public function render($writer)
{
$this->renderCustomScriptFile($writer);
$this->renderPackageScriptFile($writer);
$this->renderCustomScript($writer);
}
/**
* Renders the custom script file.
* @param THtmLWriter the renderer
*/
protected function renderCustomScriptFile($writer)
{
if(($scriptUrl = $this->getScriptUrl())!=='')
$writer->write("<script type=\"text/javascript\" src=\"$scriptUrl\"></script>\n");
}
/**
* Registers the body content as javascript.
* @param THtmlWriter the renderer
*/
protected function renderCustomScript($writer)
{
if($this->getHasControls())
{
$writer->write("<script type=\"text/javascript\">\n/*<![CDATA[*/\n");
$this->renderChildren($writer);
$writer->write("\n/*]]>*/\n</script>\n");
}
}
protected function renderPackageScriptFile($writer)
{
$baseUrl = $this->publishScriptLoader();
$scripts = split('/\s*[, ]+\s*/', $this->getPackageScripts());
$url = $baseUrl . '?js=' . implode(',', $scripts);
if($this->getApplication()->getMode()===TApplicationMode::Debug)
$url.='&mode=debug';
$writer->write("<script type=\"text/javascript\" src=\"{$url}\"></script>\n");
}
protected function publishScriptLoader()
{
list($path, $url) = $this->getPublishedPackagePath();
if(is_dir($path))
{
$scriptLoader = Prado::getFrameworkPath().'/'.self::SCRIPT_LOADER;
$scriptLoaderFile = basename($scriptLoader);
$dest = $path.'/'.$scriptLoaderFile;
if(!is_file($dest))
copy($scriptLoader,$dest);
return $url.'/'.$scriptLoaderFile;
}
else
throw new TConfigurationException('clientscript_invalid_package_path',
$this->getPackagePath(), $this->getUniqueID());
}
protected function getPublishedPackagePath()
{
$assets = $this->getApplication()->getAssetManager();
//assumes dot path first
$dir = Prado::getPathOfNameSpace($packageDir);
if(!is_null($dir))
{
$url = $assets->publishFilePath($dir); //show throw an excemption if invalid
return array($dir, $url);
}
$url = $this->getPackagePath();
$packageDir = str_replace($assets->getBaseUrl(), '', $url);
return array($assets->getBasePath().$packageDir,$url);
}
}
?>
|
