directory search
阅读前篇 简介 Yii 是什么 从 Yii 1.1 升级 入门 安装 Yii 运行应用 第一次问候 使用Forms 数据库应用 使用 Gii 生成代码 进阶 应用结构 概述 入口脚本 应用(Applications) 应用组件(Application Components) 控制器(Controllers) 模型(Models) 视图(views) 模块(Modules) 过滤器(Filters) 小部件(Widgets) 前端资源(Assets) 扩展(Extensions) 请求处理 运行概述 启动引导(Bootstrapping) 路由和创建URL 请求(Requests) 响应(Responses) Sessions 和 Cookies 错误处理(Handling Errors) 日志(Logging) 关键概念 组件(Component) 属性(Property) 事件(Events) 行为(Behaviors) 配置(Configurations) 别名(Aliases) 类自动加载(Autoloading) 服务定位器(Service Locator) 依赖注入容器(Dependency Injection Container) 配合数据库工作 数据库访问 (Data Access Objects) 查询生成器(Query Builder) 活动记录(Active Record) 数据库迁移(Migrations) Sphinx Redis MongoDB Elasticsearch 接收用户数据 创建表单(Creating Forms) 输入验证(Validating Input) 文件上传(Uploading Files) 收集列表输入(Collecting Tabular Input) 多模型的复合表单(Getting Data for Multiple Models) 显示数据 格式化输出数据(Data Formatting) 分页(Pagination) 排序(Sorting) 数据提供器(Data Providers) 数据小部件(Data Widgets) 客户端脚本使用(Working with Client Scripts) 主题(Theming) 安全 认证(Authentication) 授权(Authorization) 处理密码(Working with Passwords) 客户端认证(Auth Clients) 最佳安全实践(Best Practices) 缓存 概述 数据缓存 片段缓存 页面缓存 HTTP 缓存 RESTfull Web服务 快速入门(Quick Start) 资源(Resources) 控制器(Controllers) 路由(Routing) 格式化响应(Response Formatting) 授权认证(Authentication) 速率限制(Rate Limiting) 版本(Versioning) 错误处理(Error Handling) 开发工具 调试工具栏和调试器 使用Gii生成代码 生成API文档 测试 概述(Overview) 配置测试环境(Testing environment setup) 单元测试(Unit Tests) 功能测试(Function Tests) 验收测试(Acceptance Tests) 测试夹具(Fixtures) 高级专题 高级应用模板 创建自定义应用程序结构 控制台命令 核心验证器(Core Validators) 国际化 收发邮件 性能优化 共享主机环境 模板引擎 集成第三方代码 小部件 Bootstrap 小部件 Jquery UI 助手类 概述 Array 助手(ArrayHelper) Html 助手(Html) Url 助手(Url)
characters

客户端脚本使用

客户端脚本使用

注意: 此部分应用于开发环境

注册脚本

你可以使用 yii\web\View 对象注册脚本。这里有两个专门的方法: (1)yii\web\View::registerJs() 用于内联脚本。 (2)yii\web\View::registerJsFile() 用于注册引入外部脚本文件。 内联脚本通常用于配置和动态生成代码。 这个方法的使用可以像下面这样:

$this->registerJs("var options = ".json_encode($options).";", View::POS_END,'my-options');

第一个参数是我们想插入的实际JS代码。 第二个参数确定了JS代码插入页面的位置。可用的值如下:

  • yii\web\View::POS_HEAD 用在HEAD部分。
  • yii\web\View::POS_BEGIN 用在标签的右边。
  • yii\web\View::POS_END 用在标签的左边。
  • yii\web\View::POS_READY 为了在ready事件中执行代码,这里将自动注册yii\web\JqueryAsset。
  • yii\web\View::POS_LOAD 为了在load事件中执行代码,这里将自动注册yii\web\JqueryAsset。

最后一个参数是一个唯一的脚本ID,主要是用于标识一段代码块,在添加一段新的代码块时,如果当前页面已经存在同样ID代码块时,那么将会被新的替换。 如果你不传这个参数,JS代码本身将会作为ID来使用。

外部脚本的引入使用像下面这样:

$this->registerJsFile('http://example.com/js/main.js', ['depends'=> [\yii\web\JqueryAsset::className()]]);

yii\web\View::registerJsFile() 中参数的使用与 yii\web\View::registerCssFile() 中的参数使用类似。 在上面的例子中,我们注册了main.js文件,并且依赖于JqueryAsset类。这意味着main.js文件将被添加在jquery.js的后面。 如果没有这个依赖规范的话,main.jsjquery.js两者之间的顺序将不会被定义。

和 yii\web\View::registerCssFile() 一样,我们强烈建议您使用 asset bundles 来注册外部JS文件,而非使用 yii\web\View::registerJsFile() 来注册。

注册资源包

正如前面所提到的,我们推荐优先使用资源包而非直接使用CSS和JavaScript。 你可以在资源管理器 asset manager 部分查看更多细节。 至于怎样使用已经定义的资源包,这很简单:

\frontend\assets\AppAsset::register($this);

注册 CSS

你可以使用 yii\web\View::registerCss() 或者 yii\web\View::registerCssFile() 来注册CSS。 前者是注册一段CSS代码块,而后者则是注册引入外部的CSS文件,例如:

$this->registerCss("body { background: #f00; }");

上面的代码执行结果相当于在页面头部中添加了下面的代码:

<style>body{background:#f00; }style>

如果你想指定样式标记的附加属性,通过一个名值对的数组添加到第三个参数。 如果你需要确保只有一个单样式标签,则需要使用第四个参数作为meta标签的描述。

$this->registerCssFile("http://example.com/css/themes/black-and-white.css", ['depends'=> [BootstrapAsset::className()],'media'=>'print', ],'css-print-theme');

上面的代码将在页面的头部添加一个link引入CSS文件。

  • 第一个参数指明被注册的CSS文件。
  • 第二个参数指明标签的HTML属性,选项depends是专门处理指明CSS文件依赖于哪个资源包。在这种情况下,依赖资源包就是 yii\bootstrap\BootstrapAsset。这意味着CSS文件将被添加在 yii\bootstrap\BootstrapAsset 之后。
  • 最后一个参数指明一个ID来标识这个CSS文件。假如这个参数未传,CSS文件的URL将被作为ID来替代。
我们强烈建议使用 asset bundles 来注册外部CSS文件, 而非使用 yii\web\View::registerCssFile() 来注册。 使用资源包允许你合并并且压缩多个CSS文件,对于高流量的网站来说,这是比较理想的方式。
Previous article: Next article: