通达OA二次开发手册.docx

1、通达OA二次开发手册Office Anywhere 网络智能办公系统二次开发手册V7.5.131120（2013增强版）通达信科中国兵器工业信息中心目 录目 录 1前 言 1第一章 软件开发环境简介 21.1 编程环境 21.3参数配置 31.3.1 Apache配置 31.3.2 PHP配置 41.3.2 MySQL配置 4第二章 数据库管理 52.1 phpMyAdmin的安装 52.2 phpMyAdmin的使用 5第三章 如何创建一个模块 83.1建立模块目录 83.2 创建菜单 83.3 分配菜单权限 93.4 编码和测试 93.4.1 系统变量 93.4.2 PHP代码样例 103

2、.4.3 连接数据库代码 10第四章 内置函数参考 124.1 utility.php 124.1.1 Message 124.1.2 Button_Back 124.1.3 find_id 134.1.4 get_client_ip 134.2 utility_all.php 134.2.1 csubstr 134.2.2 is_ip 144.2.3 add_log 144.2.4 get_code_name 154.2.5 dept_long_name 154.2.6 get_sys_para 154.2.7 set_sys_para 164.3 utility_org.php 164.3

3、.1 is_dept_parent 164.3.2 top_dept 174.3.3 GetDeptNameById 174.3.4 GetPrivNameById 174.3.5 GetUserNameById 184.3.6 GetUserNameByUid 184.3.7 my_exclude_uid 184.4 utility_sms1.php 194.4.1 send_sms 194.4.2 delete_sms 194.5 utility_sms2.php 204.5.1 send_mobile_sms_user 204.5.2 send_mobile_sms 204.6 util

4、ity_file.php 214.6.1 upload 214.6.2 delete_attach 214.6.3 attach_size 214.6.4 copy_attach 224.6.5 is_uploadable 224.6.6 is_text 234.6.7 is_office 234.6.8 is_image 234.6.9 is_viewable 244.6.10 is_media 244.6.11 dir_size 244.6.12 delete_dir 254.6.13 attach_sub_dir 254.6.14 attach_real_path 264.6.15 at

5、tach_id_encode 264.6.16 attach_id_decode 264.6.17 td_copy 274.6.18 td_rename 274.6.19 td_move_uploaded_file 284.6.20 td_file_put_contents 284.6.21 add_attach_module 284.6.22 attach_module_id 294.6.23 attach_sign_key 294.6.24 attach_sign_key_netdisk 294.6.25 attach_real_path_netdisk 304.6.26 cache_at

6、tach_para 304.6.27 attach_url 304.6.28 attach_url_pda 314.6.29 attach_link 324.6. 30 attach_link_pda 324.6.31 attach_url_old 334.6.32 upload_old 334.6.33 add_attach_old 344.6.34 delete_attach_old 344.6.35 add_attach 344.6.36 copy_attach_netdisk 354.6.37 copy_sel_attach 354.6.38 office_attach 364.6.3

7、9 create_attach 364.6.40 is_editable 364.6.41 is_wps 374.6.42 is_ppt_xls 374.6.43 is_thumbable 374.6.44 image_mimetype 384.6.45 Is_SysFile 384.6.46 file_type 384.6.47 mime_type 394.6.48 trim_office_attach 394.6.49 dir_file_nums 394.6.50 CreateThumb 404.6.51 ReplaceImageSrc 404.6.52 trim_inserted_ima

8、ge 404.6.53 backup_file 414.6.54 oc_log 414.6.55 attach_id_explode 424.6.56 attach_id_implode 42第五章 公用组件参考 435.1 人员多选 435.2 人员单选 435.3 部门多选 445.4 部门单选 455.5 角色多选 46前 言Office Anywhere网络智能办公系统（以下简称通达OA），不仅是一套成熟的网络办公系统，同时也是一个完整、精巧的软件开发平台，不仅集成了Web开发的全套环境，并提供了管理架构、系统资源的开放性支持，是开发中小型管理应用系统的理想平台。本文将从不同的技术层面

9、向您揭示通达OA的二次开发细节，是主要针对专职程序设计人员、编程爱好者、软件产品技术支持人员编写的OA二次开发入门教程。通过阅读本文，您将不仅可以了解通达OA的设计奥秘，也将能够运用本文所介绍的知识和技巧，轻松构建属于自己的应用系统或模块，文中将结合具体实例加以说明。第一章 软件开发环境简介1.1 编程环境通达OA主要采用PHP语言开发，系统使用MySQL数据库。在Windows平台下，通达OA主要注册了9个系统服务，可以通过控制面板-管理工具-服务，查看这9项服务，服务名分别是Office_Anywhere、MySQL5_OA、memcached Server、OfficeDaemon、Of

10、ficeIm、OfficeIndex、OfficeMail、OfficePOP3、OfficeTask，Office_Anywhere服务实际是集成了PHP模块的Apache服务，Apache是通达OA所使用的Web Server，通达OA也可以支持IIS作为Web Server，具体配置方法参见通达网站OA知识库相关文档。关于PHP语言的使用，可参阅，下载PHP手册，作为开发指导；关于MySQL数据库的管理与使用，将在第二章进行详细介绍。1.2目录层次结构通达OA的目录层次结构清晰，体现出对服务程序、应用程序、WEB页面的巧妙整合与组织，便于理解和扩充，下面对目录结构加以说明：MYOAatt

11、ach OA附件文件存放目录bin Apache、PHP、Zend等主程序及配置文件，服务配置程序等conf Apache配置文件data5 MySQL数据库文件目录 BUS 公交线路查询数据库 TD_OA 通达OA主数据库 MySQL MySQL系统数据库 TD_OA_ARCHIVE 通达OA归档数据库 ib_logfile0 InnoDB引擎使用的日志文件 ib_logfile1 InnoDB引擎使用的日志文件 ibdata1 InnoDB引擎存储数据与索引的数据文件logs Apache等日志文件目录modules Apache的模块文件MyAdmin 通达OA的MySQL管理工具mys

12、ql5 MySQL主程序文件nginx 高性能的通达Nginx Web应用服务tmp 临时文件目录webroot 通达OA的WEB根目录（PHP程序目录）attachment 部分OA附件文件存放目录 hrms_pic 人事档案照片目录 product_pic 销售管理产品照片存放目录 new_sms 新短消息提醒状态文件 部分附件目录（略） rss 今日资讯信息缓存文件 update 系统升级，该文件夹下如存在1.php会被自动执行并删除 weather 天气预报缓存文件 wm 外部邮件存储目录 general 主要模块目录 一般模块目录（略） ipanel 主控面板，集成了菜单、短信箱等应

13、用控制界面 mytable 桌面模块程序 system 系统功能模块，下级目录略 inc 系统通用程序及函数目录ispirit OA精灵页面 mobile OA移动界面 module 系统组件 dept_select 部门选择组件 editor 简易HTML编辑器组件 OC Office 文档在线编辑与阅读 OC_NETDISK 文档在线编辑与阅读-仅适用于网络硬盘 save_file 文件转存组件 user_select 用户多选组件 user_select_single 用户单选组件portal 门户界面static 系统通用程序及静态文件目录 common 通用css文件及其引用的图片文

14、件 images 所有代码中的标签src引用的图片文件templates 登录界面模版theme 界面主题wav 微讯提醒声音js 界面主题templates 登录界面模版 modules 所有模块非通用的css文件及其引用的图片文件等的目录 address 通讯簿非通用css文件及其引用的图片文件 部分模块目录（略） workflow 工作流非通用css文件及其引用的图片文件注：上表中红色颜色标示的目录是备份数据时需要备份的，是OA的所有数据所存放的目录。1.3参数配置1.3.1 Apache配置（MYOAconfhttpd.conf）Timeout 300 /连接超时，单位秒ServerT

15、okens Prod /Apache信息，Full,OS,Minor,Minimal,Major,ProdErrorDocument /错误文档ErrorLog logs/error.log /错误日志CustomLog logs/access.log combined /访问日志1.3.2 PHP配置（MYOAbinphp.ini）display_errors = Off /是否显示PHP程序错误log_errors = Off /是否记录错误日志error_log = filename /错误日志记录文件max_execution_time = 1200 /程序最大执行时间，单位秒memo

16、ry_limit = 256M /单个程序占用内存上限post_max_size = 1000M /表单提交最大数据量，单位MBupload_max_filesize = 200M /上传单个附件大小，单位MB1.3.2 MySQL配置（MYOAmysql5my.ini）basedir=D:/MYOA/mysql5/ /MySQL主程序路径datadir=D:/MYOA/data5/ /MySQL数据库路径tmpdir=D:/MYOA/tmp/ /缓存路径character-set-server=gbk /MySQL数据库字编码port=3336 /端口wait_timeout=30 /SQL

17、语句执行结束后自动断开时间interactive_timeout=30 /运行SQL语句时段开时间skip-name-resolve /避免外部锁定(默认是ON)bind-address=0.0.0.0 /允许远程连接innodb_file_per_table=1 /启用独立表空间模式innodb_file_format=Barracuda /InnoDB数据压缩注：以上所有的配置选项修改后都需要重启服务才会生效。第二章 数据库管理2.1 phpMyAdmin的安装 MySQL的数据库管理工具很多，phpMyAdmin是使用PHP编写的免费MySQL数据库管理工具。由于OA的MySQL数据库出

18、于安全考虑，被配置为仅能从本机访问，所以使用phpMyAdmin这样的B/S结构的管理工具，可实现数据库的远程管理。第一步、下载程序包phpMyAdmin程序可以从其官方网站下载，建议下载最新的all-language版本。第二步、解压缩 在MYOAwebroot目录下新建一个目录，如mysql369(为了防止他人利用该工具侵入数据库系统，可把目录名设为比较复杂的，如MySQL2345，避免目录名被猜测到。),将下载的程序包解压后拷贝至mysql369目录下。第三步、修改配置文件用文本编辑器，如记事本，打开MySQL管理工具目录，复制config.sample.inc.php文件并改名为con

19、fing.inc.php，打开后修改以下配置信息：$cfgblowfish_secret = ; /随便输入一个字符串，加密Cookie等信息 $cfgServers$iauth_type = http; /http,config,cookie，建议使用http$cfgServers$ihost = localhost; /数据库地址，默认为localhost$cfgServers$iport = 3336; /数据库端口，默认为3336$cfgServers$iuser = root; /数据库用户名，默认为root$cfgServers$ipassword = ; /数据库密码，默认为my

20、oa888第四步、使用phpMyAdminMySQL管理工具地址：http:/OA地址/mysql，注意，进入后先选择中文界面（中文-Chinese simplified ）。该管理工具的使用需具有一定数据库基础，请勿进行危险操作，以免导致数据丢失。2.2 phpMyAdmin的使用phpMyAdmin主界面如下在左侧选择TD数据库，可查看OA所有的数据表，如下图点击左侧的表名，则右侧列出该表的结构和字段、索引、记录数等信息，如下图phpMyAdmin的具体使用教程方法可以参考 通达网站/OA知识库/Office Anywhere 高级应用技巧/OA数据库管理工具/mysql网页方式管理工具/

21、phpMyAdmin的安装和使用.wmv 。第三章 如何创建一个模块创建一个模块一般需要经过以下几个步骤：根据功能建立程序存放目录、创建菜单、分配菜单权限、编码、测试等。3.1建立模块目录在MYOAwebrootgeneral下建议一个目录abc，作为自己开发模块的目录，将程序放置于该目录下，默认页面是index.php或index.html或index.htm3.2 创建菜单用管理员帐号进入OA，打开 系统管理-菜单设置，在相应的一级菜单后点击“下一级”链接，在右侧的界面上点击“增加子菜单项”按钮，如下图所示：详细阅读上图界面中的说明信息，按界面上说明的要求定义好菜单：子菜单项ID：系统自动

22、生成，无须调整上级菜单：根据自己的实际应用情况调整子菜单项代码：两位的数字或字母，作为排序之用子菜单项名称：根据自己的实际应用自行填写子菜单模块路径：该菜单对应的程序目录，应为上一个步骤创建的目录名称。如果为abc，则该菜单对应的菜单图片名称为MYOAwebrootstaticimagesmenuabc.gif，需要自己创建或拷贝abc.gif拷贝至MYOAwebrootstaticimagesmenu下.3.3 分配菜单权限用管理员帐号进入OA，打开 系统管理-组织机构设置-角色与权限管理，给相关的角色分配刚创建的菜单的使用权限，则相关角色的人员就可以在OA界面左侧的菜单中看到并访问该菜单。

23、3.4 编码和测试为便于用户开发自己的模块，通达科技在用户服务区提供了Office Anywhere部份模块源码的下载，供开发人员参考。用户自行开发OA的功能模块，需要根据OA的相关规范进行开发，这样既可以使自行开发的模块和OA的界面效果一致，又可以保证自行开发的程序在OA安全框架的保护之下，这样不仅可以保证新模块数据的安全，又可以使开发人员集中精力投入到模块功能的开发上。OA的各功能模块下的每个程序都需要包含OA的安全验证程序：inc/auth.inc.php。该程序包含了对用户登录信息、是否有权限访问该路径等的检查等。具体的语法为：include_once(inc/auth.inc.php

24、);为更好兼容更多版本的浏览器，需要使用标准统一的HTML解析模式对页面进行解析和渲染，在所有包含HTML代码输出的页面，都需要包含：inc/header.inc.php，输出统一的HTML头信息，包括采用的HTML标准、页面字符集、页面标题、标准界面样式表（style.css）等。在没有HTML代码输出的页面，不需要包含该文件。OA数据库的所有表名全部使用小写字母，字段名称全部使用大写字母，新模块中字段名也建议与表名统一使用小写字母，开发过程请注意。在开发自己的功能模块时可以参考现有OA模块，把功能相似的OA模块代码复制一份，然后在OA 代码的基础上修改。以下几个小节介绍OA系统变量和数据库

25、的使用。3.4.1 系统变量OA系统提供了16个通过SESSION保存的当前用户的系统变量，分别是$_SESSIONLOGIN_UID /用户数字ID$_SESSIONLOGIN_USER_ID /用户名，登录使用$_SESSIONLOGIN_BYNAME /用户别名$_SESSIONLOGIN_USER_NAME /用户真实姓名$_SESSIONLOGIN_USER_PRIV /用户角色ID$_SESSIONLOGIN_USER_PRIV_OTHER /用户辅助角色ID$_SESSIONLOGIN_SYS_ADMIN /用户是否有系统管理员权限$_SESSIONLOGIN_DEPT_ID /

26、用户部门ID$_SESSIONLOGIN_DEPT_ID_OTHER /用户辅助部门ID$_SESSIONLOGIN_AVATAR /用户头像$_SESSIONLOGIN_THEME /用户界面主题$_SESSIONLOGIN_FUNC_STR /用户模块权限$_SESSIONLOGIN_NOT_VIEW_USER /用户禁止查看用户列表$_SESSIONLOGIN_DEPT_ID_JUNIOR /用户所在部门和所属部门合集字符串$_SESSIONLOGIN_CLIENT /用户登录OA的设备类型$_SESSIONLOGIN_USER_SEX /用户性别如需使用这些系统变量，程序需要包含auth.inc.php，如下代码：3.4.2 PHP代码样例以下是一段样例代码index.php，可放置于abc目录下，可作为开发OA应用程序的模版。/或/*/是PHP的注释语句。程序运行结果如下：3.4.3 连接数据库代码以下程序代码为读取admin用户所属部门的示例：?include_once(inc/auth.inc.php); / 如需登录验证则包含，未登录将退出include_once(inc/utility_all.php); / 如需要使用公用函数则包含$HTML_PAGE_TITLE = _(功能模块名称);include_once