HTML 助手

HTML 助手文件包含用于处理 HTML 的函数。

配置 

从 v4.3.0 开始，html_helper 函数中的空 HTML 元素（例如 <img>）默认情况下已更改为与 HTML5 兼容，如果您需要与 XHTML 兼容，则必须在 **app/Config/DocTypes.php** 中将 $html5 属性设置为 false。

加载此助手 

此助手使用以下代码加载

<?php

helper('html');

可用函数 

以下函数可用

img([$src = ''[, $indexPage = false[, $attributes = '']]])

参数:

$src (string|array) – 图片源 URI 或属性和值的数组
$indexPage (bool) – 是否将 $src 视为路由的 URI 字符串
$attributes (mixed) – 额外的 HTML 属性

返回值:

HTML 图片标签

返回类型:

string

允许您创建 HTML <img /> 标签。第一个参数包含图片源。示例

<?php

echo img('images/picture.jpg');
// <img src="http://site.com/images/picture.jpg">

有一个可选的第二个参数，它是一个真/假值，指定是否应该将由 $config['indexPage'] 指定的页面添加到它创建的地址。据推测，如果您使用的是媒体控制器，则会这样做

<?php

echo img('images/picture.jpg', true);
// <img src="http://site.com/index.php/images/picture.jpg" alt="">

此外，可以将关联数组作为第一个参数传递，以完全控制所有属性和值。如果未提供 alt 属性，CodeIgniter 将生成一个空字符串。

示例

<?php

$imageProperties = [
    'src'    => 'images/picture.jpg',
    'alt'    => 'Me, demonstrating how to eat 4 slices of pizza at one time',
    'class'  => 'post_images',
    'width'  => '200',
    'height' => '200',
    'title'  => 'That was quite a night',
    'rel'    => 'lightbox',
];

img($imageProperties);
// <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox">

img_data([$src = ''[, $indexPage = false[, $attributes = '']]])

参数:

$path (string) – 图片文件路径
$mime (string|null) – 要使用的 MIME 类型，或 null 以猜测

返回值:

base64 编码的二进制图像字符串

返回类型:

string

使用“data:”协议从图像生成一个可用于 src 的字符串。示例

<?php

$src = img_data('public/images/picture.jpg'); // data:image/jpg;base64,R0lGODl...
echo img($src);

有一个可选的第二个参数来指定 MIME 类型，否则该函数将使用您的 Mimes 配置来猜测

<?php

$src = img_data('path/img_without_extension', 'image/png'); // data:image/png;base64,HT5A822...

请注意，$path 必须存在并且是 data: 协议支持的可读图像格式。此函数不建议用于非常大的文件，但它提供了一种方便的方式来提供来自您的应用程序的不可访问网络的图像（例如，在 public/ 中）。

link_tag([$href = ''[, $rel = 'stylesheet'[, $type = 'text/css'[, $title = ''[, $media = ''[, $indexPage = false[, $hreflang = '']]]]]])

参数:

$href (string) – 链接文件的来源
$rel (string) – 关系类型
$type (string) – 相关文档的类型
$title (string) – 链接标题
$media (string) – 媒体类型
$indexPage (bool) – 是否将 $src 视为路由的 URI 字符串
$hreflang (string) – Hreflang 类型

返回值:

HTML 链接标签

返回类型:

string

允许您创建 HTML <link /> 标签。这对于样式表链接以及其他链接很有用。参数是 href，以及可选的 rel、type、title、media 和 indexPage。

indexPage 是一个布尔值，用于指定 href 是否应该在其创建的地址中添加由 $config['indexPage'] 指定的页面。

示例

<?php

echo link_tag('css/mystyles.css');
// <link href="http://site.com/css/mystyles.css" rel="stylesheet" type="text/css">

更多示例

<?php

echo link_tag('favicon.ico', 'shortcut icon', 'image/ico');
// <link href="http://site.com/favicon.ico" rel="shortcut icon" type="image/ico">

echo link_tag('feed', 'alternate', 'application/rss+xml', 'My RSS Feed');
// <link href="http://site.com/feed" rel="alternate" type="application/rss+xml" title="My RSS Feed">

或者，可以将一个关联数组传递给 link_tag() 函数，以完全控制所有属性和值

<?php

$link = [
    'href'  => 'css/printer.css',
    'rel'   => 'stylesheet',
    'type'  => 'text/css',
    'media' => 'print',
];

echo link_tag($link);
// <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print">

script_tag([$src = ''[, $indexPage = false]])

参数:

$src (array|string) – JavaScript 文件的源名称或 URL，或指定属性的关联数组
$indexPage (bool) – 是否将 $src 视为路由的 URI 字符串

返回值:

HTML 脚本标签

返回类型:

string

允许您创建 HTML <script></script> 标签。参数是 src，可选参数是 indexPage。

indexPage 是一个布尔值，指定 src 是否应该在它创建的地址中添加由 $config['indexPage'] 指定的页面。

示例

<?php

echo script_tag('js/mystyles.js');
// <script src="http://site.com/js/mystyles.js"></script>

或者，可以将一个关联数组传递给 script_tag() 函数，以完全控制所有属性和值

<?php

$script = ['src' => 'js/printer.js', 'defer' => null];

echo script_tag($script);
// <script src="http://site.com/js/printer.js" defer></script>

ul($list[, $attributes = ''])

参数:

$list (array) – 列表条目
$attributes (array) – HTML 属性

返回值:

HTML 格式的无序列表

返回类型:

string

允许您从简单或多维数组生成无序 HTML 列表。示例

<?php

$list = [
    'red',
    'blue',
    'green',
    'yellow',
];

$attributes = [
    'class' => 'boldlist',
    'id'    => 'mylist',
];

echo ul($list, $attributes);

上面的代码将生成以下内容

<ul class="boldlist" id="mylist">
    <li>red</li>
    <li>blue</li>
    <li>green</li>
    <li>yellow</li>
</ul>

这是一个更复杂的示例，使用多维数组

<?php

$attributes = [
    'class' => 'boldlist',
    'id'    => 'mylist',
];

$list = [
    'colors' => [
        'red',
        'blue',
        'green',
    ],
    'shapes' => [
        'round',
        'square',
        'circles' => [
            'ellipse',
            'oval',
            'sphere',
        ],
    ],
    'moods' => [
        'happy',
        'upset' => [
            'defeated' => [
                'dejected',
                'disheartened',
                'depressed',
            ],
            'annoyed',
            'cross',
            'angry',
        ],
    ],
];

echo ul($list, $attributes);

上面的代码将生成以下内容

<ul class="boldlist" id="mylist">
    <li>colors
        <ul>
            <li>red</li>
            <li>blue</li>
            <li>green</li>
        </ul>
    </li>
    <li>shapes
        <ul>
            <li>round</li>
            <li>square</li>
            <li>circles
                <ul>
                    <li>ellipse</li>
                    <li>oval</li>
                    <li>sphere</li>
                </ul>
            </li>
        </ul>
    </li>
    <li>moods
        <ul>
            <li>happy</li>
            <li>upset
                <ul>
                    <li>defeated
                        <ul>
                            <li>dejected</li>
                            <li>disheartened</li>
                            <li>depressed</li>
                        </ul>
                    </li>
                    <li>annoyed</li>
                    <li>cross</li>
                    <li>angry</li>
                </ul>
            </li>
        </ul>
    </li>
</ul>

ol($list, $attributes = '')

参数:

$list (array) – 列表条目
$attributes (array) – HTML 属性

返回值:

HTML 格式的有序列表

返回类型:

string

与 ul() 相同，只是它生成 <ol> 标签用于有序列表，而不是 <ul>。

video($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

参数:

$src (mixed) – 来源字符串或来源数组。请参见 source() 函数
$unsupportedMessage (string) – 如果浏览器不支持媒体标签，则显示的消息
$attributes (string) – HTML 属性
$tracks (array) – 在数组中使用 track 函数。请参见 track() 函数
$indexPage (bool) –

返回值:

HTML 格式的视频元素

返回类型:

string

允许您从简单或来源数组生成 HTML 视频元素。示例

<?php

$tracks = [
    track('subtitles_no.vtt', 'subtitles', 'no', 'Norwegian No'),
    track('subtitles_yes.vtt', 'subtitles', 'yes', 'Norwegian Yes'),
];

echo video('test.mp4', 'Your browser does not support the video tag.', 'controls');

echo video(
    'http://www.codeigniter.com/test.mp4',
    'Your browser does not support the video tag.',
    'controls',
    $tracks
);

echo video(
    [
        source('movie.mp4', 'video/mp4', 'class="test"'),
        source('movie.ogg', 'video/ogg'),
        source('movie.mov', 'video/quicktime'),
        source('movie.ogv', 'video/ogv; codecs=dirac, speex'),
    ],
    'Your browser does not support the video tag.',
    'class="test" controls',
    $tracks
);

上面的代码将生成以下内容

<video src="test.mp4" controls>
  Your browser does not support the video tag.
</video>

<video src="http://www.codeigniter.com/test.mp4" controls>
  <track src="subtitles_no.vtt" kind="subtitles" srclang="no" label="Norwegian No" />
  <track src="subtitles_yes.vtt" kind="subtitles" srclang="yes" label="Norwegian Yes" />
  Your browser does not support the video tag.
</video>

<video class="test" controls>
  <source src="movie.mp4" type="video/mp4" class="test" />
  <source src="movie.ogg" type="video/ogg" />
  <source src="movie.mov" type="video/quicktime" />
  <source src="movie.ogv" type="video/ogv; codecs=dirac, speex" />
  <track src="subtitles_no.vtt" kind="subtitles" srclang="no" label="Norwegian No" />
  <track src="subtitles_yes.vtt" kind="subtitles" srclang="yes" label="Norwegian Yes" />
  Your browser does not support the video tag.
</video>

audio($src[, $unsupportedMessage = ''[, $attributes = ''[, $tracks = [][, $indexPage = false]]]])

参数:

$src (mixed) – 来源字符串或来源数组。请参见 source() 函数
$unsupportedMessage (string) – 如果浏览器不支持媒体标签，则显示的消息
$attributes (string) –
$tracks (array) – 在数组中使用 track 函数。请参见 track() 函数
$indexPage (bool) –

返回值:

HTML 格式的音频元素

返回类型:

string

与 video() 相同，只是它生成的是 <audio> 标签而不是 <video>。

source($src = ''[, $type = false[, $attributes = '']])

参数:

$src (string) – 媒体资源的路径
$type (bool) – 资源的 MIME 类型，包含可选的编解码器参数
$attributes (array) – HTML 属性

返回值:

HTML 源代码标签

返回类型:

string

允许您创建 HTML <source /> 标签。第一个参数包含源代码。示例

<?php

echo source('movie.mp4', 'video/mp4', 'class="test"');
// <source src="movie.mp4" type="video/mp4" class="test">

embed($src = ''[, $type = false[, $attributes = ''[, $indexPage = false]]])

参数:

$src (string) – 要嵌入的资源的路径
$type (bool) – MIME 类型
$attributes (array) – HTML 属性
$indexPage (bool) –

返回值:

HTML 嵌入标签

返回类型:

string

允许您创建 HTML <embed /> 标签。第一个参数包含嵌入源代码。示例

<?php

echo embed('movie.mov', 'video/quicktime', 'class="test"');
// <embed src="movie.mov" type="video/quicktime" class="test">

object($data = ''[, $type = false[, $attributes = '']])

参数:

$data (string) – 资源 URL
$type (bool) – 资源的内容类型
$attributes (array) – HTML 属性
$params (array) – 在数组中使用 param 函数。请参阅 param() 函数

返回值:

HTML 对象标签

返回类型:

string

允许您创建 HTML <object /> 标签。第一个参数包含对象数据。示例

<?php

echo object('movie.swf', 'application/x-shockwave-flash', 'class="test"');

echo object(
    'movie.swf',
    'application/x-shockwave-flash',
    'class="test"',
    [
        param('foo', 'bar', 'ref', 'class="test"'),
        param('hello', 'world', 'ref', 'class="test"'),
    ]
);

上面的代码将生成以下内容

<object data="movie.swf" class="test"></object>

<object data="movie.swf" class="test">
  <param name="foo" type="ref" value="bar" class="test" />
  <param name="hello" type="ref" value="world" class="test" />
</object>

param($name = ''[, $type = false[, $attributes = '']])

参数:

$name (string) – 参数的名称
$value (string) – 参数的值
$attributes (array) – HTML 属性

返回值:

HTML param 标签

返回类型:

string

允许您创建 HTML <param /> 标签。第一个参数包含参数源。示例

<?php

echo param('movie.mov', 'video/quicktime', 'class="test"');
// <param src="movie.mov" type="video/quicktime" class="test">

track($name = ''[, $type = false[, $attributes = '']])

参数:

$name (string) – 参数的名称
$value (string) – 参数的值
$attributes (array) – HTML 属性

返回值:

HTML track 标签

返回类型:

string

生成一个 track 元素来指定定时轨道。轨道以 WebVTT 格式格式化。示例

<?php

echo track('subtitles_no.vtt', 'subtitles', 'no', 'Norwegian No');
// <track src="subtitles_no.vtt" kind="subtitles" srclang="no" label="Norwegian No">

doctype([$type = 'html5'])

参数:

$type (string) – 文档类型名称

返回值:

HTML 文档类型标签

返回类型:

string

帮助您生成文档类型声明或 DTD。默认情况下使用 HTML 5，但可以使用许多文档类型。

示例

<?php

echo doctype();
// <!DOCTYPE html>

echo doctype('html4-trans');
// <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

以下是预定义的文档类型选择的列表。这些是可配置的，从 app/Config/DocTypes.php 中提取，或者可以在您的 .env 配置中覆盖。

文档类型	选项	结果
XHTML 1.1	xhtml11	<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.1//EN” “http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd”>
XHTML 1.0 Strict	xhtml1-strict	<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Strict//EN” “http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd”>
XHTML 1.0 Transitional	xhtml1-trans	<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Transitional//EN” “http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd”>
XHTML 1.0 Frameset	xhtml1-frame	<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Frameset//EN” “http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd”>
XHTML Basic 1.1	xhtml-basic11	<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML Basic 1.1//EN” “http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd”>
HTML 5	html5	<!DOCTYPE html>
HTML 4 严格模式	html4-strict	<!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01//EN” “http://www.w3.org/TR/html4/strict.dtd”>
HTML 4 过渡模式	html4-trans	<!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01 Transitional//EN” “http://www.w3.org/TR/html4/loose.dtd”>
HTML 4 框架集	html4-frame	<!DOCTYPE HTML PUBLIC “-//W3C//DTD HTML 4.01 Frameset//EN” “http://www.w3.org/TR/html4/frameset.dtd”>
MathML 1.01	mathml1	<!DOCTYPE math SYSTEM “http://www.w3.org/Math/DTD/mathml1/mathml.dtd”>
MathML 2.0	mathml2	<!DOCTYPE math PUBLIC “-//W3C//DTD MathML 2.0//EN” “http://www.w3.org/Math/DTD/mathml2/mathml2.dtd”>
SVG 1.0	svg10	<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.0//EN” “http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd”>
SVG 1.1 完整版	svg11	<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1//EN” “http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd”>
SVG 1.1 基本版	svg11-basic	<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1 Basic//EN” “http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-basic.dtd”>
SVG 1.1 简化版	svg11-tiny	<!DOCTYPE svg PUBLIC “-//W3C//DTD SVG 1.1 Tiny//EN” “http://www.w3.org/Graphics/SVG/1.1/DTD/svg11-tiny.dtd”>
XHTML+MathML+SVG (XHTML 主机)	xhtml-math-svg-xh	<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN” “http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd”>
XHTML+MathML+SVG (SVG 主机)	xhtml-math-svg-sh	<!DOCTYPE svg:svg PUBLIC “-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN” “http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd”>
XHTML+RDFa 1.0	xhtml-rdfa-1	<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML+RDFa 1.0//EN” “http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd”>
XHTML+RDFa 1.1	xhtml-rdfa-2	<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML+RDFa 1.1//EN” “http://www.w3.org/MarkUp/DTD/xhtml-rdfa-2.dtd”>

HTML 助手

配置

加载此助手

可用函数

配置 

加载此助手 

可用函数 