README

项目： uom/tk-domtemplate 网站： http://www.domtemplate.com/
作者： Michael Mifsud http://www.tropotek.com/

PHP5 DOM 模板引擎，用于 XHTML/XML

内容

• 安装
• 简介
• VAR
• CHOICE
• REPEAT
• 表单
• 其他函数
• 自动渲染器
• 加载器
• PHP 示例

安装

可在 Packagist (uom/tk-domtemplate) 上找到，并可通过 Composer 安装。

composer require uom/tk-domtemplate

或者将以下内容添加到您的 composer.json 文件中

"uom/tk-domtemplate": "~3.0"

如果您不使用 Composer，您可以从 GitHub 下载代码，并使用任何 PSR-0 兼容的自动加载器来加载类。

简介

注意：此引擎使用 PHP DOM 模块，该模块要求所有加载到其中的文档都必须是严格的 XML/XHTML 标记。关闭所有标签，并确保所有 & 都是 &，即使在 URL 查询字符串中也是如此。

DOM 模板引擎已开发，以便设计师有一种简单的方式来构建模板，并将他们的需求传达给开发者。

模板引擎使用了三个自定义属性。这些是

1. var：用于向节点添加属性和内容。
2. choice：用于隐藏/显示节点及其内容
3. repeat：用于重复数据，如列表或表格。

不必担心这些属性不符合 HTML5 规范或其他规范，因为一旦解析模板，它们就会被删除。

这就是从设计师的角度来看的全部内容。对于开发者来说，这使与 HTML 模板交互变得容易，而不会覆盖设计师的辛勤工作。

PHP DOMTemplate 还提供了一些其他功能，这些功能有助于渲染表单、CSS、JavaScript 元标签等。以下各节将说明如何使用这些功能。还可以查看代码示例，了解我们如何使用 DOMTemplate。

VAR

这是 var 属性。如果您想修改节点的内容或属性，则可以在节点中使用它。以下是一个在模板中使用 var 的示例

<div><a href="#" var="link"></a></div>

开发者可以构建代码来操纵此节点，使其满意

<?php
// Load a new template from a file. (The file must be XHTML valid or errors will be produced) 
$template = new \Dom\Template::loadFile('index.html');

// Add some text content inside the anchor node
$template->insertText('link', 'This is a link');

//Add some HTML content inside the ancor node
$template->insertHtml('link', '<i class="fa fa-times"></i> Close');

// Add a real URL to the ancor
$template->setAttr('link', 'href', 'http://www.example.com/');

...

CHOICE

choice 属性允许移除 DOM 节点。如果存在该属性，则默认情况下将移除节点。您必须调用 setChoice()。以下是一个示例。

<div choice="showNode"><a href="#" var="link"></a></div>

因此，默认情况下，此节点将从此 DOM 树中移除。要使其可见，请简单地使用

<?php
// Load a new template from a file. (The file must be XHTML valid or errors will be produced) 
$template = new \Dom\Template::loadFile('index.html');

// Add some text content inside the anchor node
$template->setVisible('showNode');

...

REPEAT

repeat 属性用于重复数据，如列表或表格。重复块可以包含嵌套的 var、choice、repeat 节点。当从模板检索 repeat 对象时，请注意，重复对象是模板对象的子类，因此具有相同的功能，并增加了附加的 appendRepeat() 调用，该调用在完成 repeat 渲染并希望将其附加到父模板节点时调用。以下是一个示例。

<ul>
  <li repeat="item" var="item"><a href="#" var="url">Link</a></li>
</ul>

设置了重复标记后，您可以继续填充您的列表或表格。

<?php
// Load a new template from a file. (The file must be XHTML valid or errors will be produced) 
$template = new \Dom\Template::loadFile('index.html');

$list = array(
  'Link 1' => 'http://www.example.com/link1.html',
  'Link 2' => 'http://www.example.com/link2.html',
  'Link 3' => 'http://www.example.com/link3.html',
  'Link 4' => 'http://www.example.com/link4.html'
);

// Loop through the data and render each item
foreach($list as $text => $url) {
  $repeat = $template->getRepeat('item');
  
  $repeat->insertText('url', $text);
  $repeat
  
  // Finish the repeat item and append it to its parent.
  $repeat->appendRepeat();
}

...

表单

使用DOMTemplate对象处理表单时略有不同。您无需任何变量或选择即可访问表单元素节点，但如果需要，也可以这样做。

如果我们有以下基本表单

<form id="contactForm" method="post">
  <table>
    <tr>
      <td class="label">Name:</td>
      <td class="input"><input type="text" name="name" /></td>
    </tr>
    <tr>
      <td class="label">Email:</td>
      <td class="input">
        <p class="formError" choice="email-error" var="email-error" />
        <input type="text" name="email" />
      </td>
    </tr>
    <tr>
      <td class="label">Country</td>
      <td class="input">
        <select name="country"></select>
      </td>
    </tr>
    <tr>
      <td class="label">Comments:</td>
      <td class="input"><textarea name="comments" rows="5" cols="40"></textarea></td>
    </tr>
    <tr>
      <td class="label">&#160;</td>
      <td class="input"><input type="submit" name="process" value="Submit"/></td>
    </tr>
  </table>
</form>

那么我们可以通过以下代码访问表单

<?php
$template = \Dom\Template::load($buff);

// Set the pageTitle tag  --> <h1 var="pageTitle">Default Text</h1>
$template->insertText('pageTitle', 'Dynamic Form Example');

$domForm = $template->getForm('contactForm');
// Init any form elements to a default status
$select = $domForm->getFormElement('country');
/* @var $select \Dom\Form\Select */
$select->appendOption('-- Select --', '');
$select->appendOption('New Zealand', 'NZ');
$select->appendOption('England', 'UK');
$select->appendOption('Australia', 'AU');
$select->appendOption('America', 'US');
$select->setValue('AU');

...

// Then you can set the value from the request if you like....
$domForm->getFormElement('name')->setValue($_REQUEST['name']);
$domForm->getFormElement('email')->setValue($_REQUEST['email']);
$domForm->getFormElement('country')->setValue($_REQUEST['country']);
$domForm->getFormElement('comments')->setValue($_REQUEST['comments']);

其他方法

对于CSS和JavaScript，我们添加了一些独特的方法，这些方法允许您调用insertTemplate()、
appendTemplate()、insertDoc()、appendDoc()等方法，并将JavaScript和CSS插入到父标签中。这允许您在渲染过程中将脚本或URL插入到任何位置，只要最终的父模板有一个Head标签。

• appendCss()

$template->appendCss('body > p {background: #00FF00; }');

• appendCssUrl()

$template->appendCssUrl('http://example.com/css/style.css');

• appendJs()

$js = <<<JS
jQuery(function ($) {
    $('.act').click(function (e) {
        return confirm('Are you sure you want to install this plugin?');
    });
});
JS;
$template->appendJs($js);

• appendJsUrl()

$template->appendJsUrl('http://example.com/js/sctipt.css');

如果您想在显示文档之前遍历DOMTemplate并操作所有CSS或JavaScript节点，这个功能非常棒。

DomTemplate的其他功能包括

• getElementById()：通过ID属性获取节点。
• setTitleText()：如果存在