Microdata
Joomla 平台类，用于与 Microdata 语义交互。
| 自 |
3.2 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
初始化类并设置默认 $Type
__construct( type = '', flag = true) :
| 自 |
3.2 |
|---|
参数
- type
string可选，回退到 'Thing' 类型- flag
bool启用或禁用库输出
响应
混合
content
设置人类内容或机器内容
content( content, machineContent = null) : \Joomla\CMS\Microdata\Microdata
display
此函数处理显示逻辑。
display( displayType = '', emptyOutput = false) :
它检查类型和属性是否可用，如果不可用，则检查回退，然后重置所有参数以供下次使用并返回 HTML。
| 自 |
3.2 |
|---|
参数
- displayType
string可选，'inline'，可用选项 ['inline'|'span'|'div'|meta]- emptyOutput
bool如果库输出已禁用且存在 $content 值，则返回空字符串
响应
string
displayScope
返回当前范围的 HTML
displayScope() :
| 自 |
3.2 |
|---|
响应
string
enable
启用或禁用库输出
enable( flag = true) : \Joomla\CMS\Microdata\Microdata
fallback
设置回退类型和属性
fallback( type, property) : \Joomla\CMS\Microdata\Microdata
getAvailableTypes
返回来自 http://schema.org 词汇表的所有可用类型的数组
getAvailableTypes() : mixed||string|int
| 自 |
3.2 |
|---|
响应
array<string|int, mixed>
getContent
返回当前 $content
getContent() :
| 自 |
3.2 |
|---|
响应
string
getExpectedDisplayType
返回预期的显示类型：[normal|nested|meta] 以何种方式显示属性：normal -> itemprop="name" nested -> itemprop="director" itemscope itemtype="https://schema.org/Person" meta -> <meta itemprop="datePublished" content="1991-05-01">
getExpectedDisplayType( type, property) :
| 自 |
3.2 |
|---|
参数
- type
string要在其中查找属性的类型- property
string要处理的属性
响应
string
getExpectedTypes
返回给定属性的预期类型
getExpectedTypes( type, property) : mixed||string|int
| 自 |
3.2 |
|---|
参数
- type
string要处理的类型- property
string要处理的属性
响应
array<string|int, mixed>
getFallbackProperty
返回当前 $fallbackProperty
getFallbackProperty() :
| 自 |
3.2 |
|---|
响应
string
getFallbackType
返回当前 $fallbackType
getFallbackType() :
| 自 |
3.2 |
|---|
响应
string
getMachineContent
返回当前 $machineContent
getMachineContent() :
| 自 |
3.3 |
|---|
响应
string
getProperty
返回当前 $Property 名称
getProperty() :
| 自 |
3.2 |
|---|
响应
string
getType
返回当前 $Type 名称
getType() :
| 自 |
3.2 |
|---|
响应
string
getTypes
返回来自 http://schema.org 词汇表的所有可用类型和属性的数组
getTypes() : mixed||string|int
| 自 |
3.2 |
|---|
响应
array<string|int, mixed>
htmlDiv
在 <div> 标签中返回 Microdata 语义。
htmlDiv( content, property = '', scope = '', invert = false) :
| 自 |
3.2 |
|---|
参数
- content
string人类内容- property
string可选，要显示的人类内容- scope
string可选，要显示的类型范围- invert
bool可选，默认 = false，将 $scope 与 $property 反转
响应
string
htmlMeta
在带有机器内容的 <meta> 标签中返回 Microdata 语义。
htmlMeta( content, property, scope = '', invert = false) :
| 自 |
3.2 |
|---|
参数
- content
string要显示的机器内容- property
string属性- scope
string可选，要显示的类型范围- invert
bool可选，默认 = false，将 $scope 与 $property 反转
响应
string
htmlProperty
返回 HTML 属性
htmlProperty( property) :
| 自 |
3.2 |
|---|
参数
- property
string要处理的属性
响应
string
htmlScope
返回 HTML 范围
htmlScope( scope) :
| 自 |
3.2 |
|---|
参数
- scope
string要处理的范围
响应
string
htmlSpan
在 <span> 标签中返回 Microdata 语义。
htmlSpan( content, property = '', scope = '', invert = false) :
| 自 |
3.2 |
|---|
参数
- content
string人类内容- property
string可选，要显示的人类内容- scope
string可选，要显示的类型范围- invert
bool可选，默认 = false，将 $scope 与 $property 反转
响应
string
htmlTag
在指定标签中返回 Microdata 语义。
htmlTag( tag, content, property = '', scope = '', invert = false) :
| 自 |
3.3 |
|---|
参数
- tag
stringHTML 标签- content
string人类内容- property
string可选，要显示的人类内容- scope
string可选，要显示的类型范围- invert
bool可选，默认 = false，将 $scope 与 $property 反转
响应
string
isEnabled
如果库输出已启用，则返回 'true'
isEnabled() :
| 自 |
3.2 |
|---|
响应
bool
isPropertyInType
递归函数，控制给定类型是否具有给定属性
isPropertyInType( type, property) :
| 自 |
3.2 |
|---|
参数
- type
string要检查的类型- property
string要检查的属性
响应
bool
isTypeAvailable
控制给定类型类是否可用
isTypeAvailable( type) :
| 自 |
3.2 |
|---|
参数
- type
string要检查的类型
响应
bool
loadTypes
加载 types.json 文件中包含的所有可用类型和属性，来自 http://schema.org 词汇表
loadTypes() :
| 自 |
3.2 |
|---|
响应
void
property
设置 $Property
property( property) : \Joomla\CMS\Microdata\Microdata
resetParams
重置所有参数
resetParams() :
| 自 |
3.2 |
|---|
响应
void
sanitizeProperty
返回已清理的 $Property
sanitizeProperty( property) :
| 自 |
3.2 |
|---|
参数
- property
string要清理的属性
响应
string
sanitizeType
返回已清理的 $Type
sanitizeType( type) :
| 自 |
3.2 |
|---|
参数
- type
string要清理的类型
响应
string
setType
设置新的 http://schema.org 类型
setType( type) : \Joomla\CMS\Microdata\Microdata
属性
types
来自 http://schema.org 词汇表的所有可用类型和属性的数组
| 自 |
3.2 |
|---|
类型
array<string|int, mixed>
type
类型
| 自 |
3.2 |
|---|
类型
string
property
属性
| 自 |
3.2 |
|---|
类型
string
content
人类内容
| 自 |
3.2 |
|---|
类型
string
machineContent
机器内容
| 自 |
3.2 |
|---|
类型
string
fallbackType
回退类型
| 自 |
3.2 |
|---|
类型
string
fallbackProperty
回退属性
| 自 |
3.2 |
|---|
类型
string
enabled
用于检查库输出是否已启用或禁用
| 自 |
3.2 |
|---|
类型
bool