本文记录一些进行禅道二次开发的技巧。
代码调试
方法1：error_log方法
将php.ini文件中的log_errors设置成on
1
| $ vi /opt/zbox/etc/php/php.ini
|
其中日志路径为 /opt/zbox/logs/php_error_log
然后在代码中使用error_log方法来保存日志：
1
2
3
4
5
|
error_log("". $this->app->tab ."\r\n", 3,"/opt/zbox/logs/php_error_log");
error_log("". var_export($cases,true) ."\r\n", 3,"/opt/zbox/logs/php_error_log");
|
清空日志：
1
| $ > /opt/zbox/logs/php_error_log
|
方法2：file_put_contents方法
1
2
3
4
5
6
|
file_put_contents("/opt/zbox/logs/php_error_log","HELLO\r\n",FILE_APPEND);
file_put_contents("/opt/zbox/logs/php_error_log","". $cases ."\r\n",FILE_APPEND);
file_put_contents("/opt/zbox/logs/php_error_log",var_export($cases,true),FILE_APPEND);
|
方法3：a($var)方法
a($var)方法是禅道框架的工具类 helper.class.php（app\zentao\framework\base\helper.class.php）提供的一个方法，可用来打印变量信息，可在module、control和view方法中使用，调用后会直接显示在前端web页面上。
1
2
3
4
5
6
| function a($var)
{
echo "<xmp class='a-left'>";
print_r($var);
echo "</xmp>";
}
|
也可以使用PHP的内置函数die(status)来打印，用来退出当前的php脚本，status不可以是数组、对象类型。
禅道扩展技巧
这里记录禅道二次开发的一些技巧。
1、读取当前用户
1
2
| $this->app->user->account
$this->loadModel("user")->getPairs()
|
2、读取当前模块方法名
1
2
3
4
5
| $this->app->getModuleName()
$this->app->getMethodName()
$this->app->getParams()
$this->app->getURI(true)
$this->app->tab
|
3、加载模块、语言
1
2
| $this->app->loadModel('testtask');
$this->app->loadLang('testtask');
|
4、重定向到父页面
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
return $this->send(array('result' => 'success', 'message' => $this->lang->saveSuccess, 'locate' => 'parent'));
die(js::reload('parent'));
return print(js::reload('parent'));
die(js::reload('parent.parent'));
die(js::closeModal('parent.parent', '', "function(){parent.parent.$('a.refresh').click()}"));
die(js::closeModal('parent.parent', 'this'))
parent.location.href = createLink('execution', 'importPlanStories', 'executionID=' + executionID + '&planID=' + planID);
parent.$.closeModal();
$.zui.closeModal();
|
5、统计代码执行耗时
1
2
3
| $time_start = microtime(true);
$time_end = microtime(true);
a($time_end - $time_start);
|
6、获取禅道数据库操作的SQL语句
输出sql语句
1
2
3
4
| $case = $this->dao->select('id, title')->from(TABLE_CASE)->where('id')->eq('1')->fetch();
$sql = $this->dao->printSQL();
$sql = $this->dao->select('id, title')->from(TABLE_CASE)->where('id')->eq('1')->query();
|
7、直接执行SQL语句
对于复杂的SQL语句，可以写好SQL语句后直接执行。
1
2
3
4
5
| $sql = "SELECT id, title FROM zt_case where id='1'";
$case = $this->dao->query($sql)->fetch();
$case = $this->dao->select('id, title')->from(TABLE_CASE)->where('id')->eq('1')->fetch();
|
8、fetch方法
view方法中调用其它模块，获取这个方法的输出内容：
1
2
3
| <?php include '../../common/view/header.html.php';?>
<?php echo $this->fetch('block', 'dashboard', 'module=my');?>
<?php include '../../common/view/footer.html.php';?>
|
control方法中调用其它模块的control方法
1
2
| echo $this->fetch('personnel', 'unbindWhitelist', "id=$id&confirm=$confirm");
die($this->fetch('file', 'buildExportTPL', "module=$module&templateID=$templateID"));
|
9、禅道session设置
1
2
| $this->session->set('test', "666");
a($this->session->testtesttesttesttest);
|
10、PHP empty方法
1
2
3
4
5
6
7
8
9
10
11
12
13
| empty("") : true
empty(null) : true
empty(undefined): true
empty(array()) : true
empty([]) : true
empty(false) : true
empty(0) : true
empty("0") : true
empty(true) : false
empty(1) : false
empty(-1) : false
empty("1") : false
empty("php") : false
|
php判断是否为空排除0
https://stackoverflow.com/questions/732979/php-whats-an-alternative-to-empty-where-string-0-is-not-treated-as-empty
1
| if($cellValue === '0' || !empty($cellValue))
|
11、PHP格式化字符串
1
2
3
| $lang->report->gerrit->urlerror = '无法访问Gerrit服务器：<a href="%s" target="_blank"><strong>%s</strong></a>，请检查网络环境。';
$gerritTips = sprintf($this->lang->report->gerrit->urlerror, $gerritURL,$gerritURL);
|
12、post表单提交问题
前端控件禁用时（calss=disabled），表单提交时不会提交到后台，可使用hidden属性隐藏input：
1
| <td class="w-300px"><?php echo $fileName . html::hidden('fileName', $fileName);?></td>
|
文件下载
zip文件下载
压缩文件方法：
1
2
3
4
5
6
7
8
9
10
11
12
13
| public function zipfile($filearray, $filename)
{
$zip = new ZipArchive();
if($zip->open($filename, ZIPARCHIVE::OVERWRITE | ZIPARCHIVE::CREATE)===TRUE)
{
for ($i = 0; $i < count($filearray); $i++){
$attachfile= $filearray[$i];
$zip->addfile($attachfile, basename($attachfile));
}
$zip->close();
foreach($filearray as $file) unlink($file);
}
}
|
删除目录方法：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
| public function deldir($path) {
if(is_dir($path)){
$p = scandir($path);
if (count($p)>2) {
foreach($p as $val){
if($val !="." && $val !=".."){
if (is_dir($path.$val)) {
$this->deldir($path.$val.'/');
} else {
unlink($path.$val);
}
}
}
}
}
return rmdir($path);
}
|
生成zip压缩文件并下载：
1
2
3
4
5
6
7
8
9
10
11
12
|
$zipFileName = 'test.zip';
$zipFilePath = $caseSavePath . $zipFileName;
$this->zipfile($fileList, $zipFilePath);
header("Content-type: application/zip");
header("Content-Disposition: attachment; filename=$zipFileName");
header("Content-length: " . filesize($zipFilePath));
header("Pragma: no-cache");
header("Expires: 0");
readfile("$zipFilePath");
|
Excel 文件下载
下载xlsx格式文件：
1
2
3
4
5
6
7
8
| $xlsxFileName = basename($FilePath);
header("Content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
header("Content-Disposition: attachment; filename=$xlsxFileName");
header("Content-length: " . filesize($xlsxFilePath));
header("Pragma: no-cache");
header("Expires: 0");
readfile("$xlsxFilePath");
|
下载xls格式文件：
1
2
3
4
5
6
7
8
| $xlsxFileName = basename($FilePath);
header('Content-Type: application/vnd.ms-excel');
header("Content-Disposition: attachment; filename=$xlsxFileName");
header("Content-length: " . filesize($xlsxFilePath));
header("Pragma: no-cache");
header("Expires: 0");
readfile("$xlsxFilePath");
|
其它文档类型的Content-type：
1
2
3
| application/vnd.ms-powerpoint
application/vnd.openxmlformats-officedocument.presentationml.presentation
application/vnd.openxmlformats-officedocument.wordprocessingml.document
|
参考文档
- https://phpspreadsheet.readthedocs.io/en/latest/topics/recipes/#redirect-output-to-a-clients-web-browser
- ms office - PHP xls, xlsx, ppt, pptx headers - Stack Overflow
- php - Create a zip file and download it - Stack Overflow
离开了权术，这些高级官员也无精明能干之可言，而权术又总是和诚信背道而驰的。——黄仁宇《万历十五年》
