Joomla! CMS 5.1.x API » \Joomla\CMS\HTML\HTMLHelper

类加载器方法

_( key,  methodArgs) :

static final

可以提供其他参数，这些参数将传递给子类。还可以指定其他包含路径以供第三方使用

自	1.5
抛出	`InvalidArgumentException`

参数

key: string要加载的辅助方法的名称，（前缀）。（类）。函数前缀和类是可选的，可用于加载自定义 html 辅助程序。
methodArgs: mixed要传递给被调用方法的参数

响应

mixedHTMLHelper::call($function, $args) 的结果

方法用于搜索给定路径中是否存在文件，并返回相对路径。如果存在缩小版本，则会优先使用。

addFileToBuffer( path = '',  ext = '',  debugMode = false) :

static

自	4.0.0

参数

path: string文件的实际路径
ext: string文件的扩展名
debugMode: bool表示是否启用了调试

响应

string文件的相对路径

添加 HTMLHelper 应在其中搜索辅助程序的目录。您可以传递字符串或目录数组。

addIncludePath( path = '') : mixed||string|int

static deprecated

自	1.5
已弃用	4.0 将在 6.0 中删除。使用服务注册表代替

参数

path: string要搜索的路径。

响应

array<string|int, mixed>包含目录元素的数组

显示日历控件字段

calendar( value,  name,  id,  format = '%Y-%m-%d',  attribs = []) :

static

自	1.5

参数

value: string日期值
name: string文本字段的名称
id: string文本字段的 id
format: string日期格式
attribs: mixed其他 HTML 属性数组可以包含以下键： readonly 为 input 标签设置 readonly 参数 disabled 为 input 标签设置 disabled 参数 autofocus 为 input 标签设置 autofocus 参数 autocomplete 为 input 标签设置 autocomplete 参数 filter 为 input 标签设置过滤器

响应

string日历字段的 HTML 标记

函数调用方法

call(
Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768
|Array function, mixed||string|int args) :

static

link
自	1.6
抛出	`InvalidArgumentException`

参数

function: callable要调用的函数或方法
args: array<string|int, mixed>要传递给函数的参数

响应

mixed函数结果或错误时的 false。

方法用于获取两条路径并检查文件是否存在于不同的顺序

checkFileOrder( first,  second) :

static

自	4.0.0

参数

first: string缩小文件的路径
second: string非缩小文件的路径

响应

string

获取 URL，清除 Joomla 特定的参数并返回对象

cleanImageURL( url) :

static

示例	{ url: 'string', attributes: [ width: integer, height: integer, ] }
自	4.0.0

参数

url: string要用于 src 属性的相对或绝对 URL。

响应

object

方法用于获取文件路径并将其转换为相对路径

convertToRelativePath( path) :

static

自	4.0.0

参数

path: string文件的实际路径

响应

string文件的相对路径

返回根据给定格式和时区格式化的日期。

date( input = 'now',  format = null,  tz = true,  gregorian = false) :

static

参见	strftime
自	1.5

参数

input: string日期() 接受的格式的字符串，默认为“现在”。
format: string日期格式规范字符串（参见 {@link PHP_MANUAL#date}）。
tz: mixed要用于日期的时区。特殊情况：布尔值 true 表示用户设置，布尔值 false 表示服务器设置。
gregorian: bool布尔值 true 表示使用公历。

响应

string根据给定格式和时区翻译的日期。

方法用于提取键

extract( key) : mixed||string|int

static deprecated

自	1.6
已弃用	4.0 将在 6.0 中删除。使用服务注册表代替 HTMLHelper::getServiceRegistry()->getService($file);

参数

key: string要加载的辅助方法的名称，（前缀）。（类）。函数前缀和类是可选的，可用于加载自定义 html 辅助程序。

响应

array<string|int, mixed>包含小写键、前缀、文件、函数。

检索服务注册表。

getServiceRegistry() : \Joomla\CMS\HTML\Registry

static

自	4.0.0

响应

Registry

写入 <iframe> 元素

iframe( url,  name, array|string attribs = null,  noFrames = '') :

static

自	1.5

参数

url: string要用于 src 属性的相对 URL。
name: string要使用的 target 属性。
attribs: array<string|int, mixed>|string要添加到 <iframe> 元素的属性
noFrames: string如果 iframe 标签不受支持，则要显示的消息。

响应

string

写入 <img> 元素

image( file,  alt, array|string attribs = null,  relative = false,  returnPath) : string|null

static

自	1.5

参数

file: string要用于 src 属性的相对或绝对 URL。
alt: stringalt 文本。
attribs: array<string|int, mixed>|string要添加到 <img> 元素的属性
relative: bool标志表示文件路径是否相对于 /media 文件夹（并在模板中搜索）。
returnPath: int定义方法的返回值： -1：返回一个 <img> 标签，不查找相对文件 0：返回一个 <img> 标签，同时查找相对文件 1：返回图像的相对路径，同时查找相对文件

响应

string|null图像的 HTML 标记、图像的相对路径或未找到图像时要返回的路径的 null

计算要包含的文件

includeRelativeFiles( folder,  file,  relative,  detectBrowser,  detectDebug) : mixed||string|int

static

参见	Browser
自	1.6

参数

folder: string要搜索的文件夹名称（例如：images、css、js）。
file: string文件的路径。
relative: bool标志表示文件路径是否相对于 /media 文件夹（并在模板中搜索）。
detectBrowser: bool标志表示是否应检测浏览器以包含特定浏览器文件。
detectDebug: bool标志表示是否启用了调试模式以在调试模式开启时包含未压缩的文件。

响应

array<string|int, mixed>要包含的文件。

测试键是否已注册。

isRegistered( key) :

static

自	1.6

参数

key: string键的名称

响应

bool如果键已注册，则为 true。

写入 <a> 元素

link( url,  text, array|string attribs = null) :

static

自	1.5

参数

url: string要用于 href 属性的相对 URL
text: string要使用的 target 属性
attribs: array<string|int, mixed>|string要添加到 <a> 元素的属性

响应

string

注册一个要使用特定键调用的函数

register( key, 
Warning: Array to string conversion in /opt/phpdoc/vendor/twig/twig/src/Extension/CoreExtension.php on line 768
|Array function) :

static deprecated

自	1.6
已弃用	4.0 将在 6.0 中删除。使用服务注册表代替 HTMLHelper::getServiceRegistry()->register($key, $function);

参数

key: string键的名称
function: callable函数或方法

响应

bool如果函数可调用，则为 true

写入 <script> 元素以加载 JavaScript 文件

script( file, mixed||string|int options = [], mixed||string|int attribs = []) : array|string|null

static

参见	HTMLHelper::stylesheet()
自	1.5

参数

file: string文件的路径。
options: array<string|int, mixed>选项数组。示例：array('version' => 'auto', 'conditional' => 'lt IE 9')
attribs: array<string|int, mixed>属性数组。示例：array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)

响应

array<string|int, mixed>|string|null如果 $returnPath 为 false、null、路径或特定 JavaScript 浏览器文件检测到的路径数组，则不返回任何内容

设置格式相关选项。

setFormatOptions(mixed||string|int options) :

static

使用传递的数组中所有有效值更新 formatOptions 数组。

参见	HTMLHelper::$formatOptions
自	1.5

参数

options: array<string|int, mixed>选项键值对。

响应

void

将最流行的 strftime 格式转换为 php 日期格式，因为 strftime 已弃用，我们需要能够提供与现有格式字符串相同的向后兼容性。

strftimeFormatToDateFormat( strftimeformat) :

static

自	4.2.9

参数

strftimeformat: mixedstring 与 strftime 兼容的格式。

响应

mixed如果成功，则为与 PHP 的 Date 函数兼容的格式，否则为 false

写入 <link> 元素以加载 CSS 文件

stylesheet( file, mixed||string|int options = [], mixed||string|int attribs = []) : array|string|null

static

参见	Browser
自	1.5

参数

file: string文件的路径
options: array<string|int, mixed>选项数组。示例：array('version' => 'auto', 'conditional' => 'lt IE 9')
attribs: array<string|int, mixed>属性数组。示例：array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)

响应

array<string|int, mixed>|string|null如果 $returnPath 为 false、null、路径或特定 CSS 浏览器文件检测到的路径数组，则不返回任何内容

使用图像作为按钮创建工具提示

tooltip( tooltip,  title = '',  image = 'tooltip.png',  text = '',  href = '',  alt = 'Tooltip',  class = 'hasTooltip') :

static

自	1.5

参数

tooltip: string提示字符串。
title: mixed工具提示的标题或包含 {'title','image','text','href','alt'} 键的关联数组，以及与相同名称的参数对应的值。
image: string提示的图像（如果未提供文本）。
text: string提示的文本。
href: string将用于创建链接的 URL。
alt: stringimg 标签的 alt 属性。
class: string工具提示的 CSS 类。

响应

string

将双冒号分隔的字符串或 2 个单独的字符串转换为适合 bootstrap 工具提示的字符串

tooltipText( title = '',  content = '',  translate = true,  escape = true) :

static

自	3.1.2

参数

title: string工具提示的标题（或组合的 '::' 分隔的字符串）。
content: string工具提示的内容。
translate: bool如果为真，将通过 Text 传递文本。
转义: bool如果为真，将通过 htmlspecialchars 传递文本。

响应

string工具提示字符串

从注册表中删除方法的键。

unregister( key) :

static deprecated

自	1.6
已弃用	4.0 将在 6.0 中删除。使用服务注册表代替

参数

key: string键的名称

响应

bool如果设置的键被取消设置，则为真

与生成 HTML 输出相关的选项值。识别的选项包括：fmtDepth，整数。当前缩进深度。

static

fmtEol，字符串。行尾字符串，默认为换行符。 fmtIndent，字符串。用于缩进的字符串，默认为制表符。

自	1.5

类型

array<string|int, mixed>

一个用于保存包含路径的数组

static deprecated

自	1.5
已弃用	4.0 将在 6.0 中删除

类型

array<string|int, string>

一个用于保存方法引用的数组

static deprecated

自	1.6
已弃用	4.0 将在 6.0 中删除

类型

array<string|int, callable>

用于自定义和覆盖 JHtml 帮助程序的服务注册表

static

自	4.0.0

类型

Registry

HTMLHelper

方法

_

参数

响应

addFileToBuffer

参数

响应

addIncludePath

参数

响应

calendar

参数

响应

call

参数

响应

checkFileOrder

参数

响应

cleanImageURL

参数

响应

convertToRelativePath

参数

响应

date

参数

响应

extract

参数

响应

getServiceRegistry

响应

iframe

参数

响应

image

参数

响应

includeRelativeFiles

参数

响应

isRegistered

参数

响应

link

参数

响应

register

参数

响应

script

参数

响应

setFormatOptions

参数

响应

strftimeFormatToDateFormat

参数

响应

stylesheet

参数

响应

tooltip

参数

响应

tooltipText

参数

响应

unregister

参数

响应

属性

formatOptions

类型

includePaths

类型

registry

类型