通达OA二次开发介绍材料.doc

《通达OA二次开发介绍材料.doc》由会员分享，可在线阅读，更多相关《通达OA二次开发介绍材料.doc（76页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、-*Office Anywhere 网络智能办公系统二次开发手册V8.1.150425（2015版）通达信科中国兵器工业信息中心http:/-*目 录目 录1前 言1第一章 软件开发环境简介21.1 编程环境21.3参数配置41.3.1 OfficeFPM配置41.3.2 OfficWeb配置41.3.3 PHP配置41.3.4 MySQL配置41.3.5 OfficWeb、OfficeFPM和PHP的关系41.4核心文件51.4.1 auth.inc.php (MYOAwebrootinc)51.4.2 header.inc.php (MYOAwebrootinc)51.4.3 common

2、.inc.php (MYOAwebrootinc)51.4.4 conn.php (MYOAwebrootinc)6第二章 数据库管理72.1 phpMyAdmin的安装72.2 phpMyAdmin的使用7第三章 如何创建一个模块103.1建立模块目录103.2 创建菜单103.3 分配菜单权限113.4 编码和测试113.4.1 系统变量123.4.2 PHP代码样例123.4.3 连接数据库代码13第四章 内置类库参考144.1 TD类144.1.1 成员函数144.2 PortalData类154.2.1 成员函数154.3 ExcelReader类184.3.1 成员函数184.4

3、Workflow相关类194.4.1 TworkForm类的成员函数194.4.2 TworkRun类的成员函数20第五章 内置函数参考255.1 utility.php255.1.1 Message255.1.2 Button_Back255.1.3 find_id265.1.4 get_client_ip265.2 utility_all.php265.2.1 csubstr265.2.2 is_ip275.2.3 add_log275.2.4 get_code_name285.2.5 dept_long_name285.2.6 get_sys_para285.2.7 set_sys_pa

4、ra295.3 utility_org.php295.3.1 is_dept_parent295.3.2 top_dept305.3.3 GetDeptNameById305.3.4 GetPrivNameById305.3.5 GetUserNameById315.3.6 GetUserNameByUid315.3.7 my_exclude_uid315.3.8 GetUnionSetOfChildDeptId325.3.9 GetfunmenuByuserID325.3.10 is_module_manager325.3.11 set_priv_menu_priv335.3.12 set_

5、uid_menu_priv335.3.12 del_user_menu_priv345.3.13 GetUidByOther345.4 utility_sms1.php345.4.1 send_sms345.4.2 delete_sms355.5 utility_sms2.php355.5.1 send_mobile_sms_user355.5.2 send_mobile_sms365.6 utility_file.php365.6.1 upload365.6.2 delete_attach375.6.3 attach_size375.6.4 copy_attach375.6.5 is_upl

6、oadable385.6.6 is_text385.6.7 is_office395.6.8 is_image395.6.9 is_viewable395.6.10 is_media405.6.11 dir_size405.6.12 delete_dir405.6.13 attach_sub_dir415.6.14 attach_real_path415.6.15 attach_id_encode425.6.16 attach_id_decode425.6.17 td_copy425.6.18 td_rename435.6.19 td_move_uploaded_file435.6.20 td

7、_file_put_contents435.6.21 add_attach_module445.6.22 attach_module_id445.6.23 attach_sign_key445.6.24 attach_sign_key_netdisk455.6.25 attach_real_path_netdisk455.6.26 cache_attach_para465.6.27 attach_url465.6.28 attach_url_pda475.6.29 attach_link475.6. 30 attach_link_pda485.6.31 attach_url_old485.6.

8、32 upload_old495.6.33 add_attach_old495.6.34 delete_attach_old505.6.35 add_attach505.6.36 copy_attach_netdisk505.6.37 copy_sel_attach515.6.38 office_attach515.6.39 create_attach525.6.40 is_editable525.6.41 is_wps525.6.42 is_ppt_xls535.6.43 is_thumbable535.6.44 image_mimetype535.6.45 Is_SysFile545.6.

9、46 file_type545.6.47 mime_type545.6.48 trim_office_attach555.6.49 dir_file_nums555.6.50 CreateThumb555.6.51 ReplaceImageSrc565.6.52 trim_inserted_image565.6.53 backup_file565.6.54 oc_log575.6.55 attach_id_explode575.6.56 attach_id_implode575.7 utility_email.php585.7.1 GetWebMailNumByUid585.7.2 GetSe

10、ntMailNum585.7.3 trim_notlogin595.7.4 insert_to_address595.7.5 get_email_data595.7.6 remove_email605.7.7 get_sentbox_data605.7.8 delete_email615.7.9 destroy_email615.7.10 get_time615.7.11 email_count625.7.12 get_outbox_data625.7.13 delete_outbox_email625.8 utility_calendar.php635.8.1 insert_taskcent

11、er635.8.2 add_calendar635.8.3 update_calendar635.8.4 get_list_data645.8.5 delete_calendar64第六章 公用组件参考656.1 人员多选656.2 人员单选656.3 部门多选666.4 部门单选676.5 角色多选68第七章 典型功能简析687.1 用户名相关697.2 登录密码加密697.3 系统缓存机制697.4 OA升级产生的变化707.4.1 2013版升级到2013增强版707.4.2 2013增强版升级到2015版71-*前 言Office Anywhere网络智能办公系统（以下简称通达OA），

12、不仅是一套成熟的网络办公系统，同时也是一个完整、精巧的软件开发平台，不仅集成了Web开发的全套环境，并提供了管理架构、系统资源的开放性支持，是开发中小型管理应用系统的理想平台。本文将从不同的技术层面向您揭示通达OA的二次开发细节，是主要针对专职程序设计人员、编程爱好者、软件产品技术支持人员编写的OA二次开发入门教程。通过阅读本文，您将不仅可以了解通达OA的设计奥秘，也将能够运用本文所介绍的知识和技巧，轻松构建属于自己的应用系统或模块，文中将结合具体实例加以说明。第一章 软件开发环境简介1.1 编程环境通达OA主要采用PHP语言开发，系统使用MySQL数据库。在Windows平台下，通达OA主要

13、注册了9个系统服务，可以通过控制面板-管理工具-服务，查看这9项服务，服务名分别是Office_Web、MySQL5_OA、Office_Redis、OfficeDaemon、OfficeIm、OfficeIndex、OfficeMail、OfficePOP3、OfficeTask，Office_Web是管理ngnix进程的服务，Office_Web是通达OA所使用的Web Server，通达OA也可以支持IIS作为Web Server，具体配置方法参见通达网站OA知识库相关文档。关于PHP语言的使用，可参阅http:/，下载PHP手册，作为开发指导，PHP版本已升级至5.3，该版本中许多函数

14、或方法有调整，使用时需要注意；关于MySQL数据库的管理与使用，将在第二章进行详细介绍。1.2目录层次结构通达OA的目录层次结构清晰，体现出对服务程序、应用程序、WEB页面的巧妙整合与组织，便于理解和扩充，下面对目录结构加以说明：MYOAattachOA附件文件存放目录binPHP、Zend等主程序及配置文件，服务配置程序等data5MySQL数据库文件目录 BUS公交线路查询数据库 TD_OA通达OA主数据库 crscell 报表数据库 MySQLMySQL系统数据库 TD_OA_ARCHIVE通达OA归档数据库 ib_logfile0InnoDB引擎使用的日志文件 ib_logfile1I

15、nnoDB引擎使用的日志文件 ibdata1InnoDB引擎存储数据与索引的数据文件logsOA服务等的日志文件目录MyAdmin通达OA的MySQL管理工具mysql5MySQL主程序文件nginx高性能的通达Nginx Web应用服务tmp临时文件目录webroot通达OA的WEB根目录（PHP程序目录）attachment部分OA附件文件存放目录 hrms_pic人事档案照片目录 product_pic销售管理产品照片存放目录 new_sms新短消息提醒状态文件 部分附件目录（略） rss今日资讯信息缓存文件 update系统升级，该文件夹下如存在1.php会被自动执行并删除 weath

16、er天气预报缓存文件 wm外部邮件存储目录 general主要模块目录 一般模块目录（略） ipanel主控面板，集成了菜单、短信箱等应用控制界面 mytable桌面模块程序 system系统功能模块，下级目录略 inc系统通用程序及函数目录ispiritOA精灵页面 mobileOA移动界面 module系统组件 dept_select部门选择组件 editor简易HTML编辑器组件 OCOffice 文档在线编辑与阅读 OC_NETDISK文档在线编辑与阅读-仅适用于网络硬盘 save_file文件转存组件 user_select用户多选组件 user_select_single用户单选组

17、件portal门户界面static系统通用程序及静态文件目录 common通用css文件及其引用的图片文件 images所有代码中的标签src引用的图片文件templates登录界面模版theme界面主题wav微讯提醒声音js界面主题templates登录界面模版modules所有模块非通用的css文件及其引用的图片文件等的目录address通讯簿非通用css文件及其引用的图片文件 部分模块目录（略）workflow工作流非通用css文件及其引用的图片文件注：上表中红色颜色标示的目录是备份数据时需要备份的，是OA的所有数据所存放的目录。1.3参数配置1.3.1 OfficeFPM配置（MYOA

18、binservice.ini）Listen = 8266/监听端口ProcessNumber = 10/fastcgi进程数1.3.2 OfficWeb配置（MYOAbinservice.ini）Listen = 2367/监听端口MemoryWarning= 100/ 非工作时间OfficeNginx.exe占用内存的最大值，单位为兆字节（MB）MemoryMax= 200 / 工作时间OfficeNginx.exe占用内存的最大值，单位为兆字节（MB）1.3.3 PHP配置（MYOAbinphp.ini）display_errors = Off/是否显示PHP程序错误log_errors

19、= Off/是否记录错误日志error_log = filename/错误日志记录文件max_execution_time = 1200/程序最大执行时间，单位秒memory_limit = 256M/单个程序占用内存上限post_max_size = 1000M/表单提交最大数据量，单位MBupload_max_filesize = 200M/上传单个附件大小，单位MB1.3.4 MySQL配置（MYOAmysql5my.ini）basedir=D:/MYOA/mysql5/MySQL主程序路径datadir=D:/MYOA/data5/MySQL数据库路径tmpdir=D:/MYOA/tm

20、p/缓存路径character-set-server=gbk/MySQL数据库字编码port=3336/端口wait_timeout=30/SQL语句执行结束后自动断开时间interactive_timeout=30/运行SQL语句时段开时间skip-name-resolve/避免外部锁定(默认是ON)bind-address=0.0.0.0/允许远程连接innodb_file_per_table=1/启用独立表空间模式innodb_file_format=Barracuda/InnoDB数据压缩注：以上所有的配置选项修改后都需要重启服务才会生效。1.3.5 OfficWeb、OfficeFP

21、M和PHP的关系 OfficeWeb服务守护OfficeFPM进程和OfficeNginx。OfficeFPM进程启动多个（ProcessNumber）FastCGI进程。OfficeWeb根据配置参数（MemoryWarning和MemoryMax）定时检测OfficeNginx的内存占用情况，保证OfficeNginx时刻处于正常响应状态。1.4核心文件1.4.1 auth.inc.php (MYOAwebrootinc)通达OA为满足用户数据安全，原则上所有的php页面执行都将包含auth.inc.php权限验证程序，其中包含session合法性验证、访问路径授权验证等；例：includ

22、e_once(inc/auth.inc.php);1.4.2 header.inc.php (MYOAwebrootinc)为保证通达OA功能显示标准统一，需要使用标准统一的HTML解析模式对页面进行解析和渲染，在所有包含HTML代码输出的页面都需要包含header.inc.php程序，其中包括采用的HTML标准、页面字符集、页面标题、标准界面样式表（style.css）等；例：$HTML_PAGE_TITLE = _(页面标题);include_once(inc/header.inc.php);1.4.3 common.inc.php (MYOAwebrootinc) 为了防止用户输入不安全

23、数据等，通达OA为您提供了用户输入数据（$_GET、$_POST、$_COOKIE）过滤和校验程序，原则上所有php页面文件都需要包含，但如果页面已经包含过auth.inc.php、header.inc.php或conn.php，则无需再单独包含。例：include_once(inc/auth.inc.php);1.4.4 conn.php (MYOAwebrootinc) 为方便用户快速连接操作数据库，且对SQL语句安全验证，原则上在进行数据库操作的所有php页面都需要包含conn.php程序，但如果页面已经包含auth.inc.php程序，则无需再单独包含；例：include_once(i

24、nc/conn.php);第二章 数据库管理2.1 phpMyAdmin的安装MySQL的数据库管理工具很多，phpMyAdmin是使用PHP编写的免费MySQL数据库管理工具。由于OA的MySQL数据库出于安全考虑，被配置为仅能从本机访问，所以使用phpMyAdmin这样的B/S结构的管理工具，可实现数据库的远程管理。第一步、下载程序包phpMyAdmin程序可以从其官方网站http:/下载，建议下载最新的all-language版本。第二步、解压缩在MYOAwebroot目录下新建一个目录，如mysql369(为了防止他人利用该工具侵入数据库系统，可把目录名设为比较复杂的，如MySQL23

25、45，避免目录名被猜测到。),将下载的程序包解压后拷贝至mysql369目录下。第三步、修改配置文件用文本编辑器，如记事本，打开MySQL管理工具目录，复制config.sample.inc.php文件并改名为confing.inc.php，打开后修改以下配置信息：$cfgblowfish_secret = ;/随便输入一个字符串，加密Cookie等信息$cfgServers$iauth_type = http;/http,config,cookie，建议使用http$cfgServers$ihost = localhost;/数据库地址，默认为localhost$cfgServers$ipo

26、rt = 3336;/数据库端口，默认为3336$cfgServers$iuser = root;/数据库用户名，默认为root$cfgServers$ipassword = ;/数据库密码，默认为myoa888第四步、使用phpMyAdminMySQL管理工具地址：http:/OA地址/mysql，注意，进入后先选择中文界面（中文-Chinese simplified ）。该管理工具的使用需具有一定数据库基础，请勿进行危险操作，以免导致数据丢失。2.2 phpMyAdmin的使用phpMyAdmin主界面如下在左侧选择TD数据库，可查看OA所有的数据表，如下图点击左侧的表名，则右侧列出该表的

27、结构和字段、索引、记录数等信息，如下图phpMyAdmin的具体使用教程方法可以参考 通达网站/OA知识库/Office Anywhere 高级应用技巧/OA数据库管理工具/mysql网页方式管理工具/phpMyAdmin的安装和使用.wmv 。第三章 如何创建一个模块创建一个模块一般需要经过以下几个步骤：根据功能建立程序存放目录、创建菜单、分配菜单权限、编码、测试等。3.1建立模块目录在MYOAwebrootgeneral下建议一个目录new_module，作为自己开发模块的目录，将程序放置于该目录下，默认页面是index.php或index.html或index.htm3.2 创建菜单用管

28、理员帐号进入OA，打开 系统管理-菜单设置，在相应的一级菜单后点击“下一级”链接，在右侧的界面上点击“增加子菜单项”按钮，如下图所示：详细阅读上图界面中的说明信息，按界面上说明的要求定义好菜单：子菜单项ID：系统自动生成，无须调整上级菜单：根据自己的实际应用情况调整子菜单项代码：两位的数字或字母，作为排序之用子菜单项名称：根据自己的实际应用自行填写子菜单模块路径：该菜单对应的程序目录，应为上一个步骤创建的目录名称。如果为new_module，则该菜单对应的菜单图片名称为MYOAwebrootstaticimagesmenunew_module.gif，需要自己创建或拷贝new_module.g

29、if拷贝至MYOAwebrootstaticimagesmenu下。3.3 分配菜单权限用系统管理员账号，在菜单创建完成后跳转界面直接可以给指定菜单分配权限（首次分配菜单权限时需要验证超级密码，与系统管理-组织机构设置-角色与权限管理中超级密码一致），如下图所示：也可以使用传统方式给新建菜单分配权限，用管理员帐号进入OA，打开 系统管理-组织机构设置-角色与权限管理，给相关的角色分配刚创建的菜单的使用权限，则相关角色的人员就可以在OA界面左侧的菜单中看到并访问该菜单。3.4 编码和测试为便于用户开发自己的模块，通达科技在用户服务区提供了Office Anywhere部份模块源码的下载，供开发人

30、员参考。用户自行开发OA的功能模块，需要根据OA的相关规范进行开发，这样既可以使自行开发的模块和OA的界面效果一致，又可以保证自行开发的程序在OA安全框架的保护之下，这样不仅可以保证新模块数据的安全，又可以使开发人员集中精力投入到模块功能的开发上。OA的各功能模块下的每个程序都需要包含OA的安全验证程序：inc/auth.inc.php。该程序包含了对用户登录信息、是否有权限访问该路径等的检查等。具体的语法为：include_once(inc/auth.inc.php);为更好兼容更多版本的浏览器，需要使用标准统一的HTML解析模式对页面进行解析和渲染，在所有包含HTML代码输出的页面，都需要

31、包含：inc/header.inc.php，输出统一的HTML头信息，包括采用的HTML标准、页面字符集、页面标题、标准界面样式表（style.css）等。在没有HTML代码输出的页面，不需要包含该文件。OA数据库的所有表名全部使用小写字母，字段名称全部使用大写字母，新模块中字段名也建议与表名统一使用小写字母，开发过程请注意。在开发自己的功能模块时可以参考现有OA模块，把功能相似的OA模块代码复制一份，然后在OA 代码的基础上修改。以下几个小节介绍OA系统变量和数据库的使用。3.4.1 系统变量OA系统提供了多个通过SESSION保存的当前用户的系统变量，分别是$_SESSIONLOGIN_U

32、ID/用户数字ID$_SESSIONLOGIN_USER_ID/用户名，无意义$_SESSIONLOGIN_BYNAME/用户名，又叫用户别名，登录使用$_SESSIONLOGIN_USER_NAME/用户真实姓名$_SESSIONLOGIN_USER_PRIV/用户角色ID$_SESSIONLOGIN_USER_PRIV_OTHER/用户辅助角色ID$_SESSIONLOGIN_SYS_ADMIN/用户是否有系统管理员权限$_SESSIONLOGIN_DEPT_ID/用户部门ID$_SESSIONLOGIN_DEPT_ID_OTHER/用户辅助部门ID$_SESSIONLOGIN_AVATA

33、R/用户头像$_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，可放置于new_module目录下，可作为开发O

34、A应用程序的模版。/或/*/是PHP的注释语句。程序运行结果如下：3.4.3 连接数据库代码以下程序代码为读取admin用户所属部门的示例：?$query = SELECT * from USER where USER_ID=admin;$cursor= exequery(TD:conn(),$query); /*exequery 是OA系统inc/conn.php包装的SQL语句执行函数，TD:conn()是数据库的连接标识符*/if($ROW=MySQL_fetch_array($cursor)$DEPT_ID=$ROWDEPT_ID;echo admin用户所在部门为：.dept_lon

35、g_name($DEPT_ID).;?执行效果如下图：从这段程序可以看出，使用OA系统提供的系统头文件和函数，访问数据库将是一件很轻松的事，不用操心数据库的连接参数等问题，只需简单的写下SQL语句，执行它。MySQL数据库的连接参数在 MYOAwebrootincoa_config.php文件中配置，如果自己安装MySQL数据库，可自行修改连接参数。第四章 内置类库参考4.1 TD类4.1.1 成员函数 conn()函数说明：获取数据库连接。参数：无返回值：数据库连接 get_cache($id)函数说明：获取缓存内容。参数：$id 缓存id键值返回值：缓存内容 set_cache($id,

36、$data, $ttl = 60)函数说明：更新缓存内容。参数：$id /缓存id键值$data /缓存内容$ttl /更新时间返回值：无 delete_cache($id)函数说明：删除指定缓存。参数：$id /缓存id键值返回值：无4.2 PortalData类4.2.1 成员函数 get_portal_info()函数说明：获取门户的基本信息。参数：无 返回值：门户的基本信息数组 get_nav_list()函数说明：获取门户导航栏的基本信息。参数：无 返回值：导航栏的基本信息数组，二维数组，$column_id为一级数组键值 get_columns_info($column_id_st

37、r)函数说明：获取指定栏目的基本信息。参数：$column_id_str /栏目ID串返回值：栏目的基本信息，二维数组，$column_id为一级数组键值 get_column_page($column_id)函数说明：获取指定栏目的页面信息。参数：$column_id /栏目ID返回值：栏目的页面信息，数组 get_child_columns($column_id)函数说明：获取指定栏目的子栏目。参数：$column_id /栏目ID返回值：子栏目数组 get_contents_list($column_id, $start = 0, $limit = 10, $order_by = )函数

38、说明：获取指定栏目的内容列表。参数：$column_id /栏目ID$start /开始条数$limit /返回内容条数$order_by /内容列表排序返回值：内容列表，二维数组 get_contents_info($content_id_str)函数说明：根据内容ID串获取多条内容的详细信息。参数：$content_id_str /内容ID串返回值：内容的详细信息二维数组，键值为content_id get_unit_name()函数说明：获取单位名称。参数：无返回值：单位名称 get_miitbeian_no()函数说明：获取网站备案号。参数：无返回值：网站备案号4.3 ExcelReader类4.3.1 成员函数 getHead()函数说明：获取Excel内容头数据信息。参数：无 返回值：头数据信息数组 getFirstRow()函数说明：获取Excel内容第一行数据信息。参数：无 返回值：Excel内容第一行数据信息数组 getFirstRow()函数说明：获取Excel内容第一行数据信息。参数：无 返回值：Excel内容第一行数据信息数组4.4 Workflow相关类4.4.1 TworkForm类的成员函数 get_all_supported_ctrls()函数说明：public，获取所有支持的控件信息数组。参数：无 返回值：数组，表