0

0

使用php在win下生成chm文档

php中文网

php中文网

发布时间:2016-06-07 11:45:28

|

1286人浏览过

|

来源于php中文网

原创

一个类和hhc.exe还有hha.dll
用于生成包含html目录的chm项目文件 ,然后通过hhp项目文件和内容文件生成 .chm手册。
    /* 函数 listDirTree( $dirName = null )
    ** 功能 列出目录下所有文件及子目录
    ** 参数 $dirName 目录名称
    ** 返回 目录结构数组 false为失败
    */

    function listDir($dirName = null) {
        if (empty($dirName))
            exit("IBFileSystem: directory is empty.");
        if (is_dir($dirName)) {
            if ($dh = opendir($dirName)) {
                $tree = array();
                while (( $file = readdir($dh) ) !== false) {
                    if ($file != "." && $file != "..") {
                        $filePath = $dirName . DIRECTORY_SEPARATOR . $file;
                        if (is_dir($filePath)) { //为目录,递归
                            $tree2 =listDir($filePath);
                            $tree = $tree2? array_merge($tree,$tree2):$tree;
                        } else { //为文件,添加到当前数组
                            $tree[] = $filePath;
                        }
                    }
                }
                closedir($dh);
            } else {
                exit("IBFileSystem: can not open directory $dirName.");
            }

            //返回当前的$tree
            $tree = array_unique($tree);
            natsort($tree);
            return $tree;
        } else {
            exit("IBFileSystem: $dirName is not a directory.");
        }
    }

    function listDirTree($dirName = null,$remove) {
        if (empty($dirName))
            exit("IBFileSystem: directory is empty.");
        if (is_dir($dirName)) {
            if ($dh = opendir($dirName)) {
                $tree = array();
                while (( $file = readdir($dh) ) !== false) {
                    if ($file != "." && $file != ".." && stripos($remove, $file) === false) {
                        $filePath = $dirName . DIRECTORY_SEPARATOR . $file;
                        if (is_dir($filePath)) { //为目录,递归
                            $arr = listDirTree($filePath,$remove);
                            natsort($arr);
                            $tree[$file] = $arr;
                        } else { //为文件,添加到当前数组
                            $tree[] = $filePath;
                        }
                    }
                }
                closedir($dh);
            } else {
                exit("IBFileSystem: can not open directory $dirName.");
            }
            
            //返回当前的$tree
            return $tree;
        } else {
            exit("IBFileSystem: $dirName is not a directory.");
        }
    }

    function cmp($a,$b){
        $a = (int)$a;
        $b = (int)$b;
        if($a == $b)    return 0;
        return ($a>$b)? 1:-1;
    }


    class chmBuilder{
        // const version = 0.1;
        public $chm_name;
        public $chm_path;
        public $chm_hhp;
        public $chm_hhc;
        public $chm_hhk;
        public $chm_uninclude_dirs;
        public $chm_uninclude_files;
        public $chm_image_type;
        public $chm_first_open;
        public $chm_title;

        public function __construct($chm_name='your_chm',$chm_path='',$chm_uninclude_dirs,$chm_uninclude_files){
            $this->chm_name = $chm_name;
            $this->chm_path = $chm_path;
            $this->chm_uninclude_dirs = $chm_uninclude_dirs;
            $this->chm_uninclude_files = $chm_uninclude_files;
            $this->chm_image_type = 'Folder';
        }

        public function build(){
            $this->buildHhp();
            $this->buildHhc();
            $this->buildHhk();
        }

        public function buildHhp(){
            $manual_files = listDir($this->chm_path);
            $files = implode(PHP_EOL, $manual_files);
            $this->chm_first_open = iconv('UTF-8', 'GB2312', $this->chm_first_open);
            $this->chm_title = iconv('UTF-8', 'GB2312', $this->chm_title);
            $tpl =  [OPTIONS]
Compatibility=1.1 or later
Compiled file={$this->chm_path}/{$this->chm_name}.chm
Contents file={$this->chm_hhc}.hhc
COPYRIGHT=www.thinkphp.cn
Display compile progress=No
Default topic={$this->chm_first_open}
Error log file=chm_builder.Log
Full-text search=Yes
Index file={$this->chm_hhk}.hhk
ImageType={$this->chm_image_type}
Language=0x804
Title={$this->chm_title}

[FILES]
{$files}
eof;
            file_put_contents("{$this->chm_path}/{$this->chm_hhp}.hhp", $tpl);
        }

        public function buildHhc(){
            $list = array();
            $file_tree = listDirTree($this->chm_path,"{$this->chm_hhp} {$this->chm_uninclude_dirs}{$this->chm_uninclude_files}");
            uksort($file_tree, 'cmp');
            foreach ($file_tree as $key => $value) {
                if(is_string($value)){
                    $title = explode(DIRECTORY_SEPARATOR, $value);
                    $title = array_pop($title);
                    $title = rtrim($title,'.html');
                    $list[] =      


  •         
            
            

    eof;
                    }else{
                        $child = array();
                        foreach ($value as $k => $val) {
                            $title = explode(DIRECTORY_SEPARATOR, $val);
                            $title = array_pop($title);
                            $title = rtrim($title,'.html');
                            $child[] =          

  •             
                
                
                

    eof;
                        }
                        $child = implode(PHP_EOL, $child);
                        $list[] =      
  •  
            
            
            

        
          
      {$child}
          
        
    eof;
                    }
                }
                $list = implode(PHP_EOL, $list);
                $tpl =  nbsp;HTML PUBLIC "-//IETF//DTD HTML//EN">






        
        
        


      {$list}


    eof;
                file_put_contents("{$this->chm_path}/{$this->chm_hhc}.hhc", $tpl);
            }

            public function buildHhk(){
                $list = array();
                $file_tree = listDir($this->chm_path);
                foreach ($file_tree as $key => $value) {
                    if(is_string($value)){
                        if(stripos($value, '.html')){
                            $title = explode(DIRECTORY_SEPARATOR, $value);
                            $title = array_pop($title);
                            $title = rtrim($title,'.html');
                            $list[] =      

  •         
            
            

    eof;
                        }
                    }
                }
                $list = implode(PHP_EOL, $list);
                $tpl =  nbsp;HTML PUBLIC "-//IETF//DTD HTML//EN">






      {$list}


    eof;
                file_put_contents("{$this->chm_path}/{$this->chm_hhk}.hhk", $tpl);
            }

            public function makeChm(){
                if(!is_file("{$this->chm_path}/{$this->chm_hhp}.hhp"))    
                    return "build error:can't generate *.hhp file!";
                $command = "hhc {$this->chm_path}/{$this->chm_hhp}.hhp";
                system($command);
                if(file_exists("{$this->chm_path}/{$this->chm_name}.chm"))
                    return true;
                else
                    return 'generate chm failed!';
            }
        }

    ?>
  • 使用方法,放到要生成目录的外面 定义好路径,手册名,不包含目录,不包含文件 字符串(空格分割),设置好一些属性后, 将hhc.exe的位置加入环境变量path中,cmd 里调用 执行的index.php 可以看到生成的信息,或者错误
    index.php     header('Content-type:text/plain;charset=utf-8');
        error_reporting(E_ERROR);
        ini_set('memory_limit', '30M');
        include 'chm_builder.php';
        $chm = new chmBuilder('ThinkPHP manual',__DIR__.DIRECTORY_SEPARATOR.'manual','public ','.DS_Store Thumbs.db book.tpl');
        $chm->chm_hhp = 'index';
        $chm->chm_hhc = 'index';
        $chm->chm_first_open = $chm->chm_path.DIRECTORY_SEPARATOR.'序言.html';
        $chm->chm_hhk = 'index';
        $chm->chm_title = 'ThinkPHP 3.1.2官方手册';
        $chm->build();
        //$chm->makeChm();
    ?>
    这个可以配合ThinkPHP Sublime 插件来生成手册,目前排序方面有点问题,故没集成到插件里去。目前只支持二级分类,多级的大家递归时tab缩进好个是就行了,用手册里第一层目录和单文件名作为章节,里面的文件作为子章节

    附件 chm_buider.zip ( 473.81 KB 下载:281 次 )

    AD:真正免费,域名+虚机+企业邮箱=0元

    PHP速学教程(入门到精通)
    PHP速学教程(入门到精通)

    PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

    下载

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

    相关专题

    更多
    Golang gRPC 服务开发与Protobuf实战
    Golang gRPC 服务开发与Protobuf实战

    本专题系统讲解 Golang 在 gRPC 服务开发中的完整实践,涵盖 Protobuf 定义与代码生成、gRPC 服务端与客户端实现、流式 RPC(Unary/Server/Client/Bidirectional)、错误处理、拦截器、中间件以及与 HTTP/REST 的对接方案。通过实际案例,帮助学习者掌握 使用 Go 构建高性能、强类型、可扩展的 RPC 服务体系,适用于微服务与内部系统通信场景。

    8

    2026.01.15

    公务员递补名单公布时间 公务员递补要求
    公务员递补名单公布时间 公务员递补要求

    公务员递补名单公布时间不固定,通常在面试前,由招录单位(如国家知识产权局、海关等)发布,依据是原入围考生放弃资格,会按笔试成绩从高到低递补,递补考生需按公告要求限时确认并提交材料,及时参加面试/体检等后续环节。要求核心是按招录单位公告及时响应、提交材料(确认书、资格复审材料)并准时参加面试。

    44

    2026.01.15

    公务员调剂条件 2026调剂公告时间
    公务员调剂条件 2026调剂公告时间

    (一)符合拟调剂职位所要求的资格条件。 (二)公共科目笔试成绩同时达到拟调剂职位和原报考职位的合格分数线,且考试类别相同。 拟调剂职位设置了专业科目笔试条件的,专业科目笔试成绩还须同时达到合格分数线,且考试类别相同。 (三)未进入原报考职位面试人员名单。

    58

    2026.01.15

    国考成绩查询入口 国考分数公布时间2026
    国考成绩查询入口 国考分数公布时间2026

    笔试成绩查询入口已开通,考生可登录国家公务员局中央机关及其直属机构2026年度考试录用公务员专题网站http://bm.scs.gov.cn/pp/gkweb/core/web/ui/business/examResult/written_result.html,查询笔试成绩和合格分数线,点击“笔试成绩查询”按钮,凭借身份证及准考证进行查询。

    11

    2026.01.15

    Java 桌面应用开发(JavaFX 实战)
    Java 桌面应用开发(JavaFX 实战)

    本专题系统讲解 Java 在桌面应用开发领域的实战应用,重点围绕 JavaFX 框架,涵盖界面布局、控件使用、事件处理、FXML、样式美化(CSS)、多线程与UI响应优化,以及桌面应用的打包与发布。通过完整示例项目,帮助学习者掌握 使用 Java 构建现代化、跨平台桌面应用程序的核心能力。

    65

    2026.01.14

    php与html混编教程大全
    php与html混编教程大全

    本专题整合了php和html混编相关教程,阅读专题下面的文章了解更多详细内容。

    36

    2026.01.13

    PHP 高性能
    PHP 高性能

    本专题整合了PHP高性能相关教程大全,阅读专题下面的文章了解更多详细内容。

    75

    2026.01.13

    MySQL数据库报错常见问题及解决方法大全
    MySQL数据库报错常见问题及解决方法大全

    本专题整合了MySQL数据库报错常见问题及解决方法,阅读专题下面的文章了解更多详细内容。

    21

    2026.01.13

    PHP 文件上传
    PHP 文件上传

    本专题整合了PHP实现文件上传相关教程,阅读专题下面的文章了解更多详细内容。

    35

    2026.01.13

    热门下载

    更多
    网站特效
    /
    网站源码
    /
    网站素材
    /
    前端模板

    精品课程

    更多
    相关推荐
    /
    热门推荐
    /
    最新课程
    Git 教程
    Git 教程

    共21课时 | 2.7万人学习

    Kotlin 教程
    Kotlin 教程

    共23课时 | 2.5万人学习

    PHP新手语法线上课程教学
    PHP新手语法线上课程教学

    共13课时 | 0.9万人学习

    关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
    php中文网:公益在线php培训,帮助PHP学习者快速成长!
    关注服务号 技术交流群
    PHP中文网订阅号
    每天精选资源文章推送

    Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号