FCKeditor使用方法技术详解.doc

FCKeditor使用方法技术详解 FCKeditor使用方法技术详解1、概述FCKeditor是目前最优秀的可见即可得网页编辑器之一，它采用JavaScript编写。具备功能强大、配置容易、跨浏览器、支持多种编程语言、开源等特点。它非常流行，互联网上很容易找到相关技术文档，国内许多WEB项目和大型网站均采用了FCKeditor（如百度，阿里巴巴）。本文将通过与PHP相结合，从基本安装到高级的配置循序渐进介绍给广大PHPer。FCKeditor官方网站：/FCKeditor Wiki：/2、下载FCKeditor登录FCKeditor官方站（），点击网站右上角“Download”链接。笔者编写本文时，FCKeditor当前最新的稳定版本是2.6.6，因此我们下载此版本的zip压缩格式文档。FCKeditor 2.6.6版下载地址：/project/fckeditor/FCKeditor/2.6.6/FCKeditor_2.6.6.zip3、安装FCKeditor解压“FCKeditor_2.6.6.zip”文档到您的网站目录下，我们先假定您存放FCKeditor和调用脚本存于同一个目录下。fckeditor目录包含FCKeditor2.4.3程序文件。check.php用于处理表单数据。add_article.php和add_article_js.html分别是PHP调用FCKeditor和JavaScript调用FCKeditor实例脚本文件。3.1、用PHP调用FCKeditor调用FCKeditor必须先载入FCKeditor类文件。具体代码如下。接下来，我们需要创建FCKeditor实例、指定FCKeditor存放路径和创建（显示）编辑器等。具体代码如下所示（代码一般放在表单内）。BasePath = ./fckeditor/; / 设置FCKeditor目录地址$FCKeditor-Width=100%; /设置显示宽度$FCKeditor-Height=300px; /设置显示高度的高度$oFCKeditor-Create() ; / 创建编辑器?下面是笔者创建好的实例代码，您可将代码保存为add_article.php。用PHP调用FCKeditorBasePath = ./fckeditor/; / 设置FCKeditor目录地址$oFCKeditor-Create() ; / 创建编辑器?通过浏览里打开http:/you-address/add_article.php 查看FCKeditor安装效果。如图3所示。图3：FCKeditor安装成功注意：如果您想将FCKeditor创建为HTML结果代码，以便于在模板引擎里面调用（如Smarty）可使用如下代码。$output = $oFCKeditor-CreateHtml() ;现在，您可通过POST方式获得编辑器的变量值。本例将表单的action设置为check.php，您可在check.php里使用代码$fckeditorValue = $_POSTFCKeditor1;获得编辑器的变量值了。FCKeditor安装成功了。但是，我们还可以通过更多设置来使FCKeditor更加灵活人性化。具体方法文本后面介绍。3.2、用JavaScript调用FCKeditor调用FCKeditor必须先载入FCKeditor类文件，但与PHP调用方法不同，应用下面的代码。 载入FCKeditor类成功后，有三种方法创建（显示）编辑器。一：内嵌方法（推荐）在您想要显示FCKeditor的地方创建如下代码（通常在表单里）： var oFCKeditor = new FCKeditor(FCKeditor1); oFCKeditor.BasePath = ./fckeditor /; oFCKeditor.Create();下面是笔者创建好的实例代码，您可将代码保存为add_article_js.html。 用JavaScript调用FCKeditor var oFCKeditor = new FCKeditor(FCKeditor1); oFCKeditor.BasePath = ./fckeditor/; oFCKeditor.Create();通过浏览里打开http:/you-address/add_article_js.html 查看FCKeditor安装效果。效果和图3完全一样。同样，如果您可以使用和前面一样的方法取得编辑器的POST变量值。$fckeditorValue = $_POSTFCKeditor1;二：文本区域（TEXTAREA）方法同内嵌方法一样，也必须先载入fckeditor类。但创建（显示）编辑器同内嵌方法不同，我们需要为window.onload定义一个函数。这样，函数便可以在页面加载时执行了。函数的定义代码如下所示。 window.onload = function() var oFCKeditor = new FCKeditor( MyTextarea ) ; oFCKeditor.BasePath = ./FCKeditor/ ; oFCKeditor.ReplaceTextarea() ;接着，您就可以在页面中（通常在表单里）定义id为MyTextarea的文本区域（TEXTAREA）。代码如下所示：下面是笔者创建好的实例代码，显示效果当然也是一样的。笔者这里就不哆嗦了。 window.onload = function() var oFCKeditor = new FCKeditor( MyTextarea ) ; oFCKeditor.BasePath = ./fckeditor/ ; oFCKeditor.ReplaceTextarea() ; 用JavaScript调用FCKeditor三：适合于Ajax的调用方法同理，您同样需要加载类文件。然后使用下面的代码对div元素创建（显示）编辑器。var div = document.getElementById(myFCKeditor); /使用getElementById方法取得myFCKeditor ID元素var fck = new FCKeditor(myFCKeditor); /创建fckeditor实例div.innerHTML = fck.CreateHtml();/使用innerHTML方法，在myFCKeditor div元素里创建编辑器和使用PHP调用fckeditor实例一样，用javascript方法调用fckeditor实例也可以设置编辑器宽度和高度等。oFCKeditor.Height = 400 ; / 400 像素oFCKeditor.Height = 250 ; / 250 像素oFCKeditor.Width = 100% ; / 百分比4、FCKeditor常用设置FCKeditor已经安装成功了，也可以使用了。但是我们可以通过一些简单的设置使FCKeditor更加符合您的项目需求。设置工具栏很简单，只需打开fckeditor目录下面的fckconfig.js文件，按CTRL+F搜索FCKConfig.ToolbarSetsDefault代码，找到如下代码。FCKConfig.ToolbarSetsDefault = Source,DocProps,-,Save,NewPage,Preview,-,Templates,Cut,Copy,Paste,PasteText,PasteWord,-,Print,SpellCheck,Undo,Redo,-,Find,Replace,-,SelectAll,RemoveFormat,Form,Checkbox,Radio,TextField,Textarea,Select,Button,ImageButton,HiddenField,/,Bold,Italic,Underline,StrikeThrough,-,Subscript,Superscript,OrderedList,UnorderedList,-,Outdent,Indent,JustifyLeft,JustifyCenter,JustifyRight,JustifyFull,Link,Unlink,Anchor,Image,Flash,Table,Rule,Smiley,SpecialChar,PageBreak,/,Style,FontFormat,FontName,FontSize,TextColor,BGColor,FitWindow,-,About在默认情况下，FCKeditor会调用上面定义的所有工具栏按钮。大家可以根据自己的需求进行设置。表1对上面的配置选项功能说明进行汇总。代码名称功能代码名称功能Source源代码DocProps页面属性-分隔符Save保存NewPage新建Preview预览Templates模板Cut剪切Copy复制Paste粘贴PasteText粘贴为无格式文本PasteWord从MS Word粘贴Print打印SpellCheck拼写检查Undo撤消Redo重做Find查找Replace替换SelectAll全选RemoveFormat清除格式Form表单Checkbox复选框Radio单选框TextField单行文本Textarea多行文本Select列表菜单Button按钮ImageButton图像域HiddenField隐藏域Bold加粗Italic倾斜Underline下划线StrikeThrough删除线Subscript下标Superscript上标OrderedList插入删除编号列表UnorderedList插入删除项目列表Outdent减少缩进Indent增加缩进JustifyLeft左对齐JustifyCenter居中对齐JustifyRight右对齐JustifyFull两端对齐Link插入编辑链接Unlink取消链接Anchor插入编辑锚点链接Image插入编辑图像Flash插入编辑FlashTable插入编辑表格Rule插入水平线Smiley插入表情SpecialChar插入特殊符号PageBreak插入分页Style样式FontFormat格式FontName字体FontSize大小TextColor文本颜色BGColor背景颜色FitWindow全屏编辑About关于Fuckeditor表1：工具栏配置选项功能进行汇总你也可以创建一个非默认的工具栏按钮设置，您可以从FCKConfig.ToolbarSetsDefault当中的代码重新复制一份，然后将Default改成您想要的名字。注意：fckconfig.js配置选项采用JavaScript语法，如果您不懂JavaScript的话，请在配置之前进行备份。笔者这里配置了一个适合于大部份网站使用的工栏目按钮（取消了一些不常用的工具栏按钮，并重新布局）。FCKConfig.ToolbarSetsMyDesign = Cut,Copy,Paste,PasteText,PasteWord,-,Undo,Redo,-,Find,Replace,-,RemoveFormat,Link,Unlink,-,Image,Flash,Table,FitWindow,-,Source,/,FontFormat,FontSize,Bold,Italic,Underline,OrderedList,UnorderedList,-,Outdent,Indent,JustifyLeft,JustifyCenter,JustifyRight,TextColor ;要想使用自定义的工具栏按钮，必须在创建FCKeditor实例后设置使用的工具栏选项。$oFCKeditor-ToolbarSet = MyDesign ; /PHP oFCKeditor.ToolbarSet = MyDesign; /JavaScript接下来，我们对常用的一些设置选项功能进行总结，读者可参考fckeditor目录下fckconfig.js文件进行阅读。见表2FCKConfig.AutoDetectLanguage自动语言检查FCKConfig.DefaultLanguage默认语言设计，建议改成zh-cnFCKConfig.ContextMenu 右键菜单内容FCKConfig.ToolbarStartExpanded 当页面载入的时候，工具栏默认情况下是否展开FCKConfig.FontColors文字颜色列表FCKConfig.FontNames字体列表，可加入国内常用的字体，如宋体、揩体、黑体等FCKConfig.FontSizes字号列表FCKConfig.FontFormats文字格式列表FCKConfig.StylesXmlPath指定风格XML文件路径FCKConfig.TemplatesXmlPath指定模板XML文件路径FCKConfig.BodyId设置编辑器的idFCKConfig.BodyClass设置编辑器的classFCKConfig.DefaultLinkTarget设置链接默认情况下的target属性FCKConfig.BaseHref 相对链接的基地址FCKConfig.SkinPath 设置默认皮肤路径FCKConfig.SmileyPath表情文件路径，您可以设置此项更改表情FCKConfig.SmileyImage表情文件FCKConfig.SmileyColumns将表情分成几列显示FCKConfig.SmileyWindowWidth显示表情窗口的宽度，单位像素FCKConfig.SmileyWindowHeight显示表情窗口的高度，单位像素表2：常用设置选项功能汇总表2是笔者认为最重要的几个常选项，如果读者还需要更多选项的详细信息，可访问/archives/2006/3467.shtml网址获得。5、配置上传文件浏览功能5.1、配置上传 浏览功能要使您的FCKeditor2.6.6 能够使用上传功能，您必须进行以下配制。注意：FCKeditor2.6.6 不支持虚拟目录，您的路径设置都是针对网站根目录的绝对路径而言的。这点对于发布到远程网站目录的开发者极为不便，后面我们会对此进行讨论。一、打开fckeditoreditorfilemanagerconnectorsphpconfig.php，找到代码$ConfigEnabled，将值设置为true。二、接下来几行，设置$ConfigUserFilesPath，设置上传路径。三、打开fckeditorfckconfig.js文件，找到代码_FileBrowserLanguage，将值设置为php。接下来一行，把_QuickUploadLanguage值也设置为php。5.2 、关于上传文件浏览安全性问题为了解决FCKeditor不支持虚拟目录问题，和FCKeditor文件上传的安全性考良。我们有必要在这里单论对此进行讨论。打开fckeditoreditorfilemanageruploadphpconfig.php，找到$ConfigUserFilesPath代码，在此行代码之前定义变量$root_path = $_SERVERPHP_SELF;重新设置$ConfigUserFilesPath变量的值，示例如下。$ConfigUserFilesPath = $root_path . 您想上传的目录名/ ;打开fckeditoreditorfilemanagerbrowserdefaultconnectorsphpconfig.php，找到代码$ConfigUserFilesPath,在此行代码之前定义变量$root_path = $_SERVERPHP_SELF;重新设置$ConfigUserFilesPath变量的值，示例如下。$ConfigUserFilesPath = $root_path . 您想浏览的目录名/至此，您的FCKeditor已解决不支持虚拟目录问题。接下来，我们介绍一种技巧配置只允许管理员才可以使用FCKeditor上传问题。解决方法其实很简单，假如网站采用$_SESSIONadmin_id验证管理员的登录id，您只需将相关的脚本文件引入即可。然后使用下面的代码配置文件上传浏览开关。$ConfigEnabled = isset($_SESSIONadmin_id);5.3 、上传文件自动生成随机文件名Fckeditor默认使用上传的文件名作为放在服务器上的文件名，但很多时候我们需要它自动生成随机文件。下面介绍实现方法打开fckeditoreditorfilemanagerconnectorsphpIo.php，这个文件里有一个函数名叫function SanitizeFileName( $sNewFileName ),这个函数原来的功能是清理掉文件名的非法字符，以阻止一些可能发生的问题。现在我们可以注释掉原来的代码，再加上我们返回生成随机文件名的代码。代码如下：/ Do a cleanup of the file name to avoid possible problemsfunction SanitizeFileName( $sNewFileName )/global $Config ;/$sNewFileName = stripslashes( $sNewFileName ) ;/ Replace dots in the name with underscores (only one dot can be there. security issue)./if ( $ConfigForceSingleExtension )/$sNewFileName = preg_replace( /.(?!.*$)/, _, $sNewFileName ) ;/ Remove / | : ? * /$sNewFileName = preg_replace( /|/|:|?|*|:cntrl:/, _, $sNewFileName ) ;/ print_r($sNewFileName);/ return $sNewFileName; $ext = substr($sNewFileName,strripos($sNewFileName,.)+1); $filename = rand_string();return $filename.$ext;6、FCKeditor Api最详细的FCKeditor Api文档默过于官方wiki提供的文档了。FCKeditor Api官方文档地址：/Developers_Guide/Javascript_API下面提供国内某网友的翻译文档，转载地址：/article.asp?id=322FCK 编辑器加载后，将会注册一个全局的 FCKeditorAPI 对象。FCKeditorAPI 对象在页面加载期间是无效的，直到页面加载完成。如果需要交互式地知道 FCK 编辑器已经加载完成，可使用FCKeditor_OnComplete函数。function FCKeditor_OnComplete(editorInstance) FCKeditorAPI.GetInstance(FCKeditor1).Commands.GetCommand(FitWindow).Execute();在当前页获得 FCK 编辑器实例：var Editor = FCKeditorAPI.GetInstance(InstanceName);从 FCK 编辑器的弹出窗口中获得 FCK 编辑器实例：var Editor = window.parent.InnerDialogLoaded().FCK;从框架页面的子框架中获得其它子框架的 FCK 编辑器实例：var Editor = window.FrameName.FCKeditorAPI.GetInstance(InstanceName);从页面弹出窗口中获得父窗口的 FCK 编辑器实例： var Editor = opener.FCKeditorAPI.GetInstance(InstanceName);获得 FCK 编辑器的内容：oEditor.GetXHTML(formatted); / formatted 为：true|false，表示是否按HTML格式取出也可用： oEditor.GetXHTML();设置 FCK 编辑器的内容：oEditor.SetHTML(content, false); / 第二个参数为：true|false，是否以所见即所得方式设置其内容。此方法常用于设置初始值或表单重置哦作。插入内容到 FCK 编辑器：oEditor.InsertHtml(html); / html为HTML文本检查 FCK 编辑器内容是否发生变化：oEditor.IsDirty();在 FCK 编辑器之外调用 FCK 编辑器工具条命令：命令列表如下：DocProps, Templates, Link, Unlink, Anchor, BulletedList, NumberedList, About, Find, Replace, Image, Flash, SpecialChar, Smiley, Table, TableProp, TableCellProp, UniversalKey, Style, FontName, FontSize, FontFormat, Source, Preview, Save, NewPage, PageBreak, TextColor, BGColor, PasteText, PasteWord, TableInsertRow, TableDeleteRows, TableInsertColumn, TableDeleteColumns, TableInsertCell, TableDeleteCells, Tab