热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

AJAXinCakePHP(1)-GettingStarted

CakePHP(以下简称“Cake”,本文使用的版本是0.10.7.1856RC3)对AJAX的支持是建立在prototype与script.aculo.us之上的,其自身并没有包含客户端的AJAX实现,所以想要在Cake中熟练地使用AJAX,必须首先熟悉prototype和script

一、Cake 中的 AJAX 实质

CakePHP(以下简称“Cake”,本文使用的版本是 0.10.7.1856 RC3)对 AJAX 的支持是建立在 prototypescript.aculo.us 之上的,其自身并没有包含客户端的 AJAX 实现,所以想要在 Cake 中熟练地使用 AJAX,必须首先熟悉 prototype 和 script.aculo.us,而本文的重点并不是这两个出众的 Javascript 库。说白了,Cake 实际上只是简化了繁琐的 AJAX Javascript 代码。

二、Cake 中的 AJAX 相关文件

在 Cake 中,与 AJAX 相关的文件只有两个:

  • cake/cake/libs/view/templates/layouts/ajax.thtml
  • cake/cake/libs/view/helpers/ajax.php

ajax.thtml 文件是执行 AJAX 动作之后用于输出的布局,和一般的布局文件不同的是它是一个空的布局视图文件,没有 header/footer 等等内容。ajax.php 文件则是用于 Cake 视图文件的 AJAX 辅助类 AjaxHelper,此类中包含了很多 AJAX 动作的相关方法,详细 API 请参考 http://api.cakephp.org/class_ajax_helper.html

除了上述的两个文件外,我们还需要 Prototype 的 prototype.js 和 script.aculo.us 中的 *.js 文件,这些文件可在官方网站上下载到,将这些 *.js 文件放置 cake/app/webroot/js/ 目录下即可。对于这两个库,本文用的版本分别是 1.4.0 和 1.5.1。

三、Hello, AJAX world!

现在我们使用一个简单的示例简单演示一下如何在 Cake 中使用 AJAX。这个示例将实现点击链接之后,在页面上加载服务器端输出的“Hello, AJAX world!”信息。为了简单起见,示例中不使用任何数据库,也就是不用 Cake 的模型(Model),而只用控制器(Controller)和视图(View)。首先创建一个布局视图文件 cake/app/views/layouts/demo.thtml,用于自定义布局以及加载需要用到的 Javascript 文件,此文件内容如下:

 


 echo $html->charsetTag('UTF-8')?>
echo $Javascript->link('prototype')?>
echo $Javascript->link('scriptaculous')?> 



    

CakePHP AJAX Demo

    echo $content_for_layout?>

重点在于 $Javascript->link() 的那两行,包含了需要用到的 Javascript 文件 prototype.js 和 scriptaculous.js,而 script.aculo.us 库中的其他 Javascript 文件都由 scriptaculous.js 统一进行包含,不用我们书写额外的代码,如果并不想使用 script.aculo.us 的所有 js 文件,可以使用 load 参数进行指定包含,比如我们只用到 effects.js,可以这样(多个则用英文逗号“,”分割开):

 echo $Javascript->link('scriptaculous.js?load=effects')?>  

接下来是创建一个控制器文件 cake/app/controllers/demos_controller.php:

 class DemosController extends AppController {
    var $name    'Demos';    //兼容 PHP4
    var $layout  'demo';   //指定视图使用的布局为 demo.thtml
    var $helpers = array('Html''Javascript''Ajax'); //需要用到的视图辅助类

    function index()
    {
    }

    function hello()
    {
        sleep(1);   //本地测试时,为了更好地看到效果,模拟延迟状态
        $this->layout 'ajax'//此方法为 AJAX 动作,所以布局需要使用 ajax.thtml
    }
}   ///:~ ?>  

此控制器的重点有三个:

对应于控制器中的两个方法(Action),我们需要在 cake/app/views/demos/ 目录下创建两个视图文件:index.thtml 和 hello.thtml。

index.thtml:

 Loading...

    //设置 AJAX 选项     $options = array(         //设置加载成功之后需要进行更新的元素为 view         'update'   => 'view',         //加载过程中隐藏 view 元素,显示“Loading...”字样         'loading'  => "Element.hide('view');Element.show('loading')",         //加载成功之后隐藏 loading,同时显示 view 元素         'complete' => "Element.hide('loading');Effect.Appear('view')"     );     //使用 AjaxHelper 创建 AJAX 动作链接     echo $ajax->link('Click here!''/demos/hello'$options);     ?>

这个视图中有三个元素:loading、view 与 AJAX 链接。初始状态下 loading 与 view 是隐藏的(display:none),只有点击了 AJAX 链接之后,在加载状态中显示 loading,加载完成之后将其隐藏,然后显示 view,“Hello, AJAX world!”即显示在 view 中。此视图的重点在于 $ajax->link(),$ajax 是 AjaxHelper 的对象实例,link() 方法的第一个参数是链接显示的文本,第二个参数是 Cake 的 URL,这里的 URL 为 /demos/hello,指向了 AJAX 动作方法 hello(),此动作最终输出视图 hello.thtml,第三个参数为 AJAX 选项,Cake 会自动根据选项生成链接中使用到的 Javascript 代码。对于一个简单的 AJAX 动作,主要就是设置三个选项:update、loading 与 complete,这几个选项的意义在视图代码的注释中都有了详细说明。

最后就是 hello.thtml 视图文件了,只是一行简单的文本:

 
Hello, AJAX world!

OK,通过尽量少的编码,我们完成了这个示例,可以通过 http://www.somesite.com/cake/demos/ 浏览最终效果。

四、Live Search

Live Search 指的是即时查询,通常是用户在文本框中输入想要查询的关键字,由客户端 Javascript 对文本框进行观察,监测到用户输入之后即时提交到服务器,并显示服务器返回的结果。接下来我们将使用 Cake 的 AJAX 实现 Live Search,从一个数组中获取符合查询关键字的数据,然后即时更新到页面中。

首先修改我们的控制器 demos_controller.php,增加一个方法 search():

 function search()
    {
        $langs = array(
            'C''C++''C#',
            'Java''Javascript',
            'PHP''Perl''Python', 
            'Ruby''Delphi');
        $this->layout 'ajax';
        if (empty($this->params['form']['livesearch'])) { //未提交任何数据
            $result $langs;
        } else {    //根据提交的关键字进行查询
            $word   $this->params['form']['livesearch'];
            $result = array();
            foreach ($langs as $lang)
                if (stristr($lang$word) !== false)
                    $result[] = $lang;
        }
        $this->set('result'$result);
    } ?>  

在 index.thtml 视图文件中,加入 Live Search 的表单代码:

 
    

        Live Search:              

//设置 AJAX 选项     $options = array(         'update' => 'view',         //处理查询的 URL,对应于控制器中的 search() 方法         'url'    => '/demos/search',         //观察频率,单位为“秒”         'frequency' => 1,         'loading' => "Element.hide('view');Element.show('loading')",         'complete' => "Element.hide('loading');Effect.Appear('view')"     );     echo $ajax->observeField('livesearch'$options); ?>

这里用到了 AjaxHelper 中的另一个方法 observeField(),此方法用于观察某个元素的数据是否发生变化,发生变化时则调用相应的 AJAX 操作。方法的第一个参数为需要观察的元素 id,这里是“livesearch”文本框,第二个参数为 AJAX 选项,和 link() 方法中的相似,只不过这里的选项设置多了 url 与 frequency,url 即 Cake 的 URL,对应于控制器中的方法,frequency 则是观察的间隔时间,单位为“秒”,即每隔多少秒查看一下对应的元素是否发生了改变。

对应于 search() 方法,创建视图文件 cake/app/views/demos/search.thtml:

 if (count($result) > 0): ?>     
            foreach ($result as $lang): ?>         
  • echo $lang ?>
  •         endforeach ?>     
else: ?>     Found nothing! endif ?>

好了,这个 Live Search 已经完成了,是不是很简单 ;) 现在只要在文本框中输入字符,就会在 $langs 数组中查找,只要包含了查询关键字的结果都会被返回并更新到 view 元素中。

五、其他应用

Cake 的 AjaxHelper 中还提供了很多方法,如用于拖曳的 drag()、drop() 及 dropRemote();用于排序的 sortable();用于自动完成的 autoComplete() 等等,由于涉及到的讲解篇幅比较大,暂时就不深入了,有时间的话我再一一道来。drag/drop 可以在我写的 Cake Framework AJAX Demo 中看到在线演示,并可下载到源代码。

六、一些问题

Cake 当前版本(0.10.7.1856 RC3)的一些方法还不是非常完善,对于最新版本的 script.aculo.us 库中的一些参数还不支持,相信很快会得到更新。实际应用中可能会碰到中文乱码的问题,那是因为 XMLHttpRequest 获取到的数据都是以 UTF-8 编码的,所以解决的办法有两个,一个是所有页面、数据库数据均使用 UTF-8 编码,这样可以省去很多麻烦,另外一个就是通过 PHP 的 iconv() 函数进行转码,但这需要用到 iconv 扩展,所以比较麻烦一些,而且无形中为服务器增加了额外的负担。

七、相关资源

Update@2006.11.26: 有兴趣的同学可以继续阅读本序列文章的第二篇《AJAX in CakePHP (2) - Sortable》。


推荐阅读
  • 理解文档对象模型(DOM)
    本文介绍了文档对象模型(DOM)的基本概念,包括其作为HTML文档的节点树结构,以及如何通过JavaScript操作DOM来实现网页的动态交互。 ... [详细]
  • 本文将详细介绍如何在ThinkPHP6框架中实现多数据库的部署,包括读写分离的策略,以及如何通过负载均衡和MySQL同步技术优化数据库性能。 ... [详细]
  • 深入分析十大PHP开发框架
    随着PHP技术的发展,各类开发框架层出不穷,成为了开发者们热议的话题。本文将详细介绍并对比十款主流的PHP开发框架,旨在帮助开发者根据自身需求选择最合适的工具。 ... [详细]
  • 本文详细介绍了如何使用PHP检测AJAX请求,通过分析预定义服务器变量来判断请求是否来自XMLHttpRequest。此方法简单实用,适用于各种Web开发场景。 ... [详细]
  • 1:有如下一段程序:packagea.b.c;publicclassTest{privatestaticinti0;publicintgetNext(){return ... [详细]
  • 深入理解Cookie与Session会话管理
    本文详细介绍了如何通过HTTP响应和请求处理浏览器的Cookie信息,以及如何创建、设置和管理Cookie。同时探讨了会话跟踪技术中的Session机制,解释其原理及应用场景。 ... [详细]
  • 本文探讨了在不使用服务器控件的情况下,如何通过多种方法获取并修改页面中的HTML元素值。除了常见的AJAX方式,还介绍了其他可行的技术方案。 ... [详细]
  • 探讨了如何解决Ajax请求响应时间过长的问题。本文分析了一个从服务器获取少量数据的Ajax请求,尽管服务器已经对JSON响应进行了缓存,但实际响应时间仍然不稳定。 ... [详细]
  • 当unique验证运到图片上传时
    2019独角兽企业重金招聘Python工程师标准model:public$imageFile;publicfunctionrules(){return[[[na ... [详细]
  • 一个登陆界面
    预览截图html部分123456789101112用户登入1314邮箱名称邮箱为空15密码密码为空16登 ... [详细]
  • 本文详细介绍了如何利用Go语言和WebSockets技术构建一个高效的实时聊天系统。随着网络应用的日益复杂化,实时交互成为了提升用户体验的关键要素之一。通过本指南,开发者可以学习到最新的技术和最佳实践。 ... [详细]
  • 本文探讨了2019年前端技术的发展趋势,包括工具化、配置化和泛前端化等方面,并提供了详细的学习路线和职业规划建议。 ... [详细]
  • 本文深入探讨了JavaScript中实现继承的四种常见方法,包括原型链继承、构造函数继承、组合继承和寄生组合继承。对于正在学习或从事Web前端开发的技术人员来说,理解这些继承模式对于提高代码质量和维护性至关重要。 ... [详细]
  • 本文探讨了如何通过WebBrowser控件在用户点击输入框时自动显示图片验证码。该过程可能涉及JavaScript事件的触发与响应。 ... [详细]
  • 本文将介绍如何利用Python爬虫技术抓取国内主流在线学习平台的数据,并以51CTO学院为例,进行详细的技术解析和实践操作。 ... [详细]
author-avatar
mobiledu2502881853
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有