脚本开发
Jump to navigation
Jump to search
位置
Dolibarr命令行脚本必须位于Dolibarr根目录下的 scripts目录中。脚本然后根据其使命划分为子目录。提供多个脚本作为标准。
开发新脚本
脚本通常是针对特定需求而编写的,很可能你找不到你想要的脚本。在这种情况下,我们将解释如何开发自己的脚本。
Step 1 - 创建脚本的框架
第一步是在dev/skeletons/skeleton_scripts.php 中获取骨架脚本并在目录scripts/mydir/myscript.php中复制和重命名它。
重命名完成后,给脚本可执行权限。
在Linux系统,执行以下命令:
cd scripts/mydir;
chmod a+rx myscript.php
然后,运行它以查看是否可以在命令行模式下运行脚本。为此,在Linux上,键入:
php-cli ./myscript.php
或者
php ./myscript.php
必须获得以下输出:
Usage: myscript.php param1 param2 ...
Step 2 - 编辑脚本代码
修改脚本的内容以执行对您感兴趣的操作。
所有代码位于以下两个标签之间
// ---------- START OF YOUR CODE HERE
和
// ---------- END OY YOUR CODE
是提供的一个例子。
你可以删除它并把你想要的代码放进去。
请注意,在本节中,可以使用变量$db来访问Dolibarr数据库,变量已初始化。包含Dolibarr配置的 $conf对象也是可用的。
例子
一些代码示例(创建订单、产品…)可用于目录/dev/examples/中。
示例代码
#!/usr/bin/env php
<?php
/* Copyright (C) 2007-2017 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) ---Put here your own copyright and developer email---
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* \file htdocs/modulebuilder/template/scripts/myobject.php
* \ingroup mymodule
* \brief This file is an example for a command line script to work on MyObject
*/
$sapi_type = php_sapi_name();
$script_file = basename(__FILE__);
$path=dirname(__FILE__).'/';
// Test if batch mode
if (substr($sapi_type, 0, 3) == 'cgi') {
echo "Error: You are using PHP for CGI. To execute ".$script_file." from command line, you must use PHP for CLI mode.\n";
exit(-1);
}
// Global variables
$version='1.0';
$error=0;
// -------------------- START OF YOUR CODE HERE --------------------
@set_time_limit(0); // No timeout for this script
define('EVEN_IF_ONLY_LOGIN_ALLOWED',1); // Set this define to 0 if you want to lock your script when dolibarr setup is "locked to admin user only".
//包含和加载Dolibarr环境变量
$res=0;
if (! $res && file_exists($path."master.inc.php")) $res=@include($path."master.inc.php");
if (! $res && file_exists($path."../master.inc.php")) $res=@include($path."../master.inc.php");
if (! $res && file_exists($path."../../master.inc.php")) $res=@include($path."../../master.inc.php");
if (! $res && file_exists($path."../../../master.inc.php")) $res=@include($path."../../../master.inc.php");
if (! $res) die("Include of master fails");
// $db, $mysoc, $langs, $conf 和 $hookmanager 已定义 (Opened $db handler to database will be closed at end of file).
// $user 已创建,但为空。
//$langs->setDefaultLang('en_US'); // 改变默认语言为 $langs
$langs->load("main"); // 加载语言文件
// 加载用户及权限
$result=$user->fetch('','admin'); // 加载用户 'admin'. 注释行作为匿名用户运行。
if (! $result > 0) { dol_print_error('',$user->error); exit; }
$user->getrights();
print "***** ".$script_file." (".$version.") pid=".dol_getmypid()." *****\n";
if (! isset($argv[1])) { // 检查参数
print "Usage: ".$script_file." param1 param2 ...\n";
exit(-1);
}
print '--- start'."\n";
print 'Argument 1='.$argv[1]."\n";
print 'Argument 2='.$argv[2]."\n";
// 业务开始
$db->begin();
// 操纵 MyObject类的例子
dol_include_once("/mymodule/class/myobject.class.php");
$myobject=new MyObject($db);
// 在数据库中插入创建对象的实例
/*
dol_syslog($script_file." CREATE", LOG_DEBUG);
$myobject->prop1='value_prop1';
$myobject->prop2='value_prop2';
$id=$myobject->create($user);
if ($id < 0) { $error++; dol_print_error($db,$myobject->error); }
else print "Object created with id=".$id."\n";
*/
// 从数据库读取对象的示例
/*
dol_syslog($script_file." FETCH", LOG_DEBUG);
$result=$myobject->fetch($id);
if ($result < 0) { $error; dol_print_error($db,$myobject->error); }
else print "Object with id=".$id." loaded\n";
*/
// 数据库中对象更新实例 ($myobject 必须先装入)
/*
dol_syslog($script_file." UPDATE", LOG_DEBUG);
$myobject->prop1='newvalue_prop1';
$myobject->prop2='newvalue_prop2';
$result=$myobject->update($user);
if ($result < 0) { $error++; dol_print_error($db,$myobject->error); }
else print "Object with id ".$myobject->id." updated\n";
*/
// 数据库中删除对象的示例 ($myobject 必须先装入)
/*
dol_syslog($script_file." DELETE", LOG_DEBUG);
$result=$myobject->delete($user);
if ($result < 0) { $error++; dol_print_error($db,$myobject->error); }
else print "Object with id ".$myobject->id." deleted\n";
*/
// 一个不使用fetch方法的直接SQL读取的例子
/*
$sql = "SELECT field1, field2";
$sql.= " FROM ".MAIN_DB_PREFIX."myobject";
$sql.= " WHERE field3 = 'xxx'";
$sql.= " ORDER BY field1 ASC";
dol_syslog($script_file, LOG_DEBUG);
$resql=$db->query($sql);
if ($resql)
{
$num = $db->num_rows($resql);
$i = 0;
if ($num)
{
while ($i < $num)
{
$obj = $db->fetch_object($resql);
if ($obj)
{
// You can use here results
print $obj->field1;
print $obj->field2;
}
$i++;
}
}
}
else
{
$error++;
dol_print_error($db);
}
*/
// -------------------- END OF YOUR CODE --------------------
if (! $error)
{
$db->commit();
print '--- end ok'."\n";
}
else
{
print '--- end error code='.$error."\n";
$db->rollback();
}
$db->close(); // Close $db database opened handler
exit($error);