README

一个用于构建 HTML5 视图的 PHP 包（基于 HTML5 Boilerplate 布局和 Composer Assets 插件）。

这个包是什么？

此包定义了一个简单的模板引擎，用于管理 PHP 视图文件，一些包含 PHP 脚本的 HTML 文件用于传递参数和对象构建视图，以及一些用于管理全局布局以嵌入这些视图的工具。由于它基于 Composer Assets 插件，模板引擎还简化了资源文件的使用和 URL。

此包尚未真正进行文档记录。请查看代码和 PHP 文档 以获取更多信息。包本身提供了一个完整的演示（需要 PHP 服务器）。

安装

此包要求您使用 Composer 来管理您的依赖关系。

要使用此包，您需要在您的 composer.json 中添加它，并调用其 TemplateEngineInstaller::postAutoloadDump 以处理 Composer 的 post-autoload-dump 事件。

"require": {
    ...
    "atelierspierrot/templatengine": "1.*"
},
...
"scripts": {
    ...
    "post-autoload-dump": "Assets\\Composer\\TemplateEngineInstaller::postAutoloadDump"
}

Assets 和 TemplateEngine 命名空间将被自动添加到项目的 Composer 自动加载器中。

Composer 扩展设置

使用 模板引擎，您可以在包的 composer.json 中定义一些额外功能，以指定由引擎使用的路径和预设。

示例

以下是在默认的 Composer Assets 插件配置值中添加的包默认配置值的示例

"extra": {
    "views": [ "www", "www/html5boilerplate" ],
    "views-functions": "src/TemplateEngine/views_functions.php",
    "cache-dir": "tmp",
    "cache-assets-dir": "tmp_assets",
    "layouts": "www/html5boilerplate"
}

views: array|string

这定义了一个或多个从您的包根目录到您的视图文件的相对路径。这些目录必须存在，默认为 www/（默认资源目录）。

views-functions: array|string

视图函数在渲染任何视图之前加载，并可能定义一些在您的视图文件中使用的有用方法。有关更多信息，请参阅下面的 视图函数 部分。

此条目定义了一个或多个从您的包根目录到您的视图函数的相对文件路径。这些文件必须存在。

cache-dir: string

这定义了从您的 assets 目录到生成临时文件的相对路径。如果不存在，则创建目录。此设置的默认值为 tmp/。

cache-assets-dir: string

这定义了从您的 assets 目录到生成临时资源文件的相对路径，例如合并或压缩的 CSS 或 JS。如果不存在，则创建目录。此设置的默认值为 tmp_assets/。

layouts: array|string

这定义了一个或多个从您的包根目录到您的布局文件的相对路径，这些布局文件是作为其他部分视图包装器的全局模板。这些目录必须存在。

视图函数

任何定义了额外 views-functions 设置的包都可以定义一组独立的方法用于视图文件；所有声明的 views-functions 的函数文件都将被加载到所有视图中，因此这些方法都可以在任何视图文件中访问。

作者 & 许可证

模板引擎

http://github.com/atelierspierrot/templatengine

版权（c）2013-2016 Pierre Cassat 和贡献者

根据Apache 2许可证授权。

https://apache.ac.cn/licenses/LICENSE-2.0

Les Ateliers Pierrot - 法国巴黎

http://www.ateliers-pierrot.fr/ - contact@ateliers-pierrot.fr