README

RdnRequireJS ZF2 模块将 RequireJS 库集成到您的项目中。

如何安装

1. 使用 composer 安装 radnan/rdn-require-js 包

   $ composer require radnan/rdn-require-js:1.*

2. 通过在您的 application.config.php 文件中包含它来激活模块

   <?php
   
   return array(
       'modules' => array(
           'RdnRequireJS',
           // ...
       ),
   );

如何使用

在项目的 public/ 目录中创建您的 RequireJS 模块

// public/Bar.js

define(['./Foo'], function(Foo)
{
	Foo.log('Hello World!');
});

然后，在您的视图模板中，使用模块名称作为参数调用 requireJS($name) 视图辅助函数

/** @var Zend\View\Renderer\PhpRenderer $this */

<?php $this->requireJS('Bar') ?>

视图辅助函数将包括 RequireJS 库以及请求的模块作为内联脚本。

多个依赖项

您可以多次调用视图辅助函数，并且它将不断追加模块依赖项。您也可以一次性提供数组来包括多个依赖项

/** @var Zend\View\Renderer\PhpRenderer $this */

<?php $this->requireJS(['Bar', 'Baz']) ?>

代码补全

如果您想为这个辅助函数添加代码补全，请在您的 PhpRenderer 类中包含以下内容

namespace App\View\Renderer;

use Zend\View\Renderer\PhpRenderer as ZendPhpRenderer;

/**
 * @method requireJS(\string $dependencies = array())
 */
class PhpRenderer extends ZendPhpRenderer
{
}

然后，只需在您的视图模板中简单地对 $this 变量进行类型提示到此类即可。

库

默认情况下，RequireJS 库是从 cdnjs 包含的。您可以使用 rdn_require_js.library 选项进行配置

<?php

return array(
	'rdn_require_js' => array(
		'library' => '/path/to/local/require.js',
	),
);

此路径应相对于您的项目基础路径。视图辅助函数将使用 basePath() 视图辅助函数来解析完整路径。

配置

您可以使用 rdn_require_js.config 选项来管理默认的 requireJS 配置

<?php

return array(
	'rdn_require_js' => array(
		'config' => array(
			'baseUrl' => '/modules',

			'paths' => array(
				'App' => 'app/js',
			),

			'packages' => array(
				'App',
			),
		),
	),
);

RequireJS 配置文档