Joomla! CMS 5.1.x API » \Joomla\CMS\Toolbar\Toolbar

魔术方法代理。

__call( name, mixed||string|int args) : \Joomla\CMS\Toolbar\ToolbarButton

抛出	`异常`
自	4.0.0

参数

name: string方法名称。
args: array<string|int, mixed>方法参数。

响应

ToolbarButton

构造函数

__construct( name = 'toolbar', \Joomla\CMS\Toolbar\ToolbarFactoryInterface factory = null) :

自	1.5

参数

name: string工具栏名称。
factory: ToolbarFactoryInterface工具栏工厂。

响应

混合

添加工具栏应按 LIFO 顺序搜索按钮类型的目录。

addButtonPath( path) :

已弃用

您可以传递字符串或目录数组。

工具栏将按您添加它们的顺序搜索元素类型。如果在自定义文件夹中找不到参数类型，它将在 libraries/joomla/html/toolbar/button 中查找。

自	1.5
已弃用	4.0 将在 6.0 中移除 ToolbarButton 类应通过命名空间自动加载

参数

path: mixed要搜索的目录或目录。

响应

无效

为按钮栏编写常见的“新建”图标。

addNew( task,  text = 'JTOOLBAR_NEW') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

将按钮附加到工具栏。

appendButton(\Joomla\CMS\Toolbar\ToolbarButton button, mixed||string|int args) : \Joomla\CMS\Toolbar\ToolbarButton|bool

自	1.5

参数

button: ToolbarButton按钮实例。
args: array<string|int, mixed>更多参数。

响应

ToolbarButton|bool返回按钮实例以帮助链接配置。如果使用旧版参数，则返回 true

为给定选项编写保存按钮。

apply( task,  text = 'JTOOLBAR_APPLY') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

应用操作仅导致保存操作（不会退出编辑模式）。

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

编写一个常见的“存档”按钮。

archive( task,  text = 'JTOOLBAR_ARCHIVE') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

为记录编写一个常见的“分配”按钮。

assign( task,  text = 'JTOOLBAR_ASSIGN') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

编写一个取消按钮，该按钮将返回到上一页，而无需执行任何其他操作。

back( text = 'JTOOLBAR_BACK') : \Joomla\CMS\Toolbar\Button\LinkButton

继承

自	4.0.0

参数

text: string按钮的文本。

响应

LinkButton

basicButton( name = '\'\'',  text = '\'\'',  task = '\'\'') : \Joomla\CMS\Toolbar\Button\BasicButton

参数

name: 字符串
text: 字符串
task: 字符串

响应

BasicButton

编写一个取消按钮并调用取消操作（例如签入）。

cancel( task,  text = 'JTOOLBAR_CLOSE') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

为给定选项编写签入按钮。

checkin( task,  text = 'JTOOLBAR_CHECKIN') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

confirmButton( name = '\'\'',  text = '\'\'',  task = '\'\'') : \Joomla\CMS\Toolbar\Button\ConfirmButton

参数

name: 字符串
text: 字符串
task: 字符串

响应

ConfirmButton

创建子工具栏。

createChild( name) :

自	4.0.0

参数

name: string工具栏名称。

响应

静态

customButton( name = '\'\'',  text = '\'\'',  task = '\'\'') : \Joomla\CMS\Toolbar\Button\CustomButton

参数

name: 字符串
text: 字符串
task: 字符串

响应

CustomButton

将自定义 HTML 写入工具栏。

customHtml( html,  name = 'custom') : \Joomla\CMS\Toolbar\Button\CustomButton

继承

自	4.0.0

参数

html: string要编写的 HTML 字符串。
name: string按钮名称。

响应

CustomButton

编写一个常见的“删除”按钮。

delete( task,  text = 'JTOOLBAR_DELETE') : \Joomla\CMS\Toolbar\Button\ConfirmButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

ConfirmButton

在下拉菜单项之间编写分隔符。

divider( text = '') : \Joomla\CMS\Toolbar\Button\SeparatorButton

继承

自	4.0.0

参数

text: string按钮的文本。

响应

SeparatorButton

dropdownButton( name = '\'\'',  text = '\'\'',  task = '\'\'') : \Joomla\CMS\Toolbar\Button\DropdownButton

参数

name: 字符串
text: 字符串
task: 字符串

响应

DropdownButton

编写一个常见的“编辑”按钮。

edit( task,  text = 'JTOOLBAR_EDIT') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

编写一个常见的“editCss”按钮。

editCss( task,  text = 'JTOOLBAR_EDIT_CSS') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

编写一个常见的“editHtml”按钮。

editHtml( task,  text = 'JTOOLBAR_EDIT_HTML') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

获取按钮对象的查找路径

getButtonPath() : mixed||string|int

已弃用

自	4.0.0
已弃用	4.0 将在 6.0 中移除 ToolbarButton 按钮应通过命名空间自动加载

响应

array<string|int, mixed>

返回全局 Toolbar 对象，仅当它不存在时才创建它。

getInstance( name = 'toolbar') : \Joomla\CMS\Toolbar\Toolbar

静态已弃用

自	1.5
已弃用	4.0 将在 6.0 中移除使用 ToolbarFactoryInterface 代替例如：Factory::getContainer()->get(ToolbarFactoryInterface::class)->createToolbar($name)
待办事项	在移除之前需要一个合适的替代方案，因为单独的 ToolbarFactoryInterface 不会在任何地方共享对象
抛出	`KeyNotFoundException`

参数

name: string工具栏的名称。

响应

ToolbarToolbar 对象。

获取工具栏链接列表。

getItems() : mixed||string|int

自	1.6

响应

array<string|int, mixed>

获取工具栏的名称。

getName() :

自	1.6

响应

字符串

为给定选项编写帮助按钮（打开一个弹出窗口）。

help( ref,  useComponent = false,  url = null,  component = null) : \Joomla\CMS\Toolbar\Button\HelpButton

继承

自	4.0.0

参数

ref: string弹出文件的名称（不包括 xml 文件的文件扩展名）。
useComponent: bool使用组件目录中的帮助文件。
url: string使用此 URL 而不是任何其他 URL。
component: string获取帮助的组件名称（当前组件为 null）

响应

HelpButton

helpButton( name = '\'\'',  text = '\'\'',  task = '\'\'') : \Joomla\CMS\Toolbar\Button\HelpButton

参数

name: 字符串
text: 字符串
task: 字符串

响应

HelpButton

为给定选项编写帮助按钮（打开一个弹出窗口）。

inlinehelp( class = 'hide-aware-inline-help') : \Joomla\CMS\Toolbar\Button\InlinehelpButton

继承

自	4.3.0

参数

class: string内联帮助项使用的类。

响应

InlinehelpButton

inlinehelpButton( name = '\'\'',  text = '\'\'',  task = '\'\'') : \Joomla\CMS\Toolbar\Button\InlinehelpButton

参数

name: 字符串
text: 字符串
task: 字符串

响应

InlinehelpButton

为给定选项编写 jooa11y 可访问性检查器按钮（打开一个弹出窗口）。

jooa11y( url,  text = 'JGLOBAL_JOOA11Y',  newWindow = false) : \Joomla\CMS\Toolbar\Button\PopupButton|\Joomla\CMS\Toolbar\Button\LinkButton

继承

自	4.1.0

参数

url: string要打开的 url
text: string按钮的文本。
newWindow: bool是否在 _blank 中打开预览或只是一个模态

响应

PopupButton|LinkButton

创建一个按钮以重定向到链接。

link( text,  url) : \Joomla\CMS\Toolbar\Button\LinkButton

继承

自	4.0.0

参数

text: string按钮文本。
url: string链接 url。

响应

LinkButton

linkButton( name = '\'\'',  text = '\'\'',  task = '\'\'') : \Joomla\CMS\Toolbar\Button\LinkButton

参数

name: 字符串
text: 字符串
task: 字符串

响应

LinkButton

加载按钮类型。

loadButtonType( type,  new = false) : false|\Joomla\CMS\Toolbar\ToolbarButton

自	1.5

参数

type: string按钮类型
new: bool默认为 false

响应

false|ToolbarButton

为记录编写一个常见的“默认”按钮。

makeDefault( task,  text = 'JTOOLBAR_DEFAULT') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string任务的覆盖。
text: string替代文本的覆盖。

响应

StandardButton

编写一个 media_manager 按钮。

mediaManager( directory,  text = 'JTOOLBAR_UPLOAD') : \Joomla\CMS\Toolbar\Button\PopupButton

继承

自	4.0.0

参数

directory: string将媒体上传到的子目录。
text: string替代文本的覆盖。

响应

PopupButton

popupButton( name = '\'\'',  text = '\'\'',  task = '\'\'') : \Joomla\CMS\Toolbar\Button\PopupButton

参数

name: 字符串
text: 字符串
task: 字符串

响应

PopupButton

编写一个配置按钮并调用取消操作（例如签入）。

preferences( component,  text = 'JTOOLBAR_OPTIONS',  path = '') : \Joomla\CMS\Toolbar\Button\LinkButton

继承

自	4.0.0

参数

component: string组件的名称，例如 com_content。
text: string此按钮的文本。
path: string相对于 JPATH_SITE 的配置 xml 的备用路径。

响应

LinkButton

将按钮预置到工具栏。

prependButton(\Joomla\CMS\Toolbar\ToolbarButton button, mixed||string|int args) : \Joomla\CMS\Toolbar\ToolbarButton|bool

自	1.5

参数

button: ToolbarButton按钮实例。
args: array<string|int, mixed>更多参数。

响应

ToolbarButton|bool返回按钮实例以帮助链接配置。如果使用旧版参数，则返回 true

为给定选项编写预览按钮（打开一个弹出窗口）。

preview( url,  text = 'JGLOBAL_PREVIEW',  newWindow = false) : \Joomla\CMS\Toolbar\Button\PopupButton|\Joomla\CMS\Toolbar\Button\LinkButton

继承

自	4.0.0

参数

url: string弹出文件的名称（不包括文件扩展名）
text: string按钮的文本。
newWindow: bool是否在 _blank 中打开预览或只是一个模态

响应

PopupButton|LinkButton

编写一个常见的“发布”按钮。

publish( task,  text = 'JTOOLBAR_PUBLISH') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

渲染工具栏。

render(mixed||string|int options = []) :

抛出	`异常`
自	1.5

参数

options: array<string|int, mixed>工具栏的选项。

响应

string工具栏的 HTML。

渲染按钮。

renderButton(mixed||string|int &node) :

自	1.5
抛出	`异常`

参数

node: array<string|int, mixed>工具栏节点。

响应

字符串

为给定选项编写保存按钮。

save( task,  text = 'JTOOLBAR_SAVE') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

保存操作会导致保存然后关闭操作。

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

为给定选项编写保存为副本按钮。

save2copy( task,  text = 'JTOOLBAR_SAVE_AS_COPY') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

保存为副本操作会导致清除密钥后保存，然后用户以新密钥返回编辑模式。

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

为给定选项编写保存并创建新按钮。

save2new( task,  text = 'JTOOLBAR_SAVE_AND_NEW') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

保存并创建操作会导致保存然后添加操作。

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

separatorButton( name = '\'\'',  text = '\'\'',  task = '\'\'') : \Joomla\CMS\Toolbar\Button\SeparatorButton

参数

name: 字符串
text: 字符串
task: 字符串

响应

SeparatorButton

设置工厂实例

setFactory(\Joomla\CMS\Toolbar\ToolbarFactoryInterface factory) :

自	4.0.0

参数

factory: ToolbarFactoryInterface工厂实例

响应

$this

设置按钮列表。

setItems(\Joomla\CMS\Toolbar\ToolbarButton||string|int items) :

自	4.0.0

参数

items: array<string|int, ToolbarButton>按钮列表数组。

响应

静态

standardButton( name = '\'\'',  text = '\'\'',  task = '\'\'') : \Joomla\CMS\Toolbar\Button\StandardButton

参数

name: 字符串
text: 字符串
task: 字符串

响应

StandardButton

编写一个常见的“垃圾箱”按钮。

trash( task,  text = 'JTOOLBAR_TRASH') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

编写一个常见的“取消存档”按钮。

unarchive( task,  text = 'JTOOLBAR_UNARCHIVE') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

编写一个常见的“取消发布”按钮。

unpublish( task,  text = 'JTOOLBAR_UNPUBLISH') : \Joomla\CMS\Toolbar\Button\StandardButton

继承

自	4.0.0

参数

task: string此按钮的任务名称。
text: string此按钮的文本。

响应

StandardButton

编写版本历史记录

versions( typeAlias,  itemId,  height = 800,  width = 500,  text = 'JTOOLBAR_VERSIONS') : \Joomla\CMS\Toolbar\Button\CustomButton

继承

自	4.0.0

参数

typeAlias: string组件和类型，例如“com_content.article”
itemId: int项目的 ID，例如文章 ID。
height: int弹出窗口的高度。
width: int弹出窗口的宽度。
text: string按钮的名称。

响应

CustomButton

工具栏名称

自	1.5

类型

字符串

工具栏数组

自	1.5

类型

array<string|int, mixed>

可以存储按钮类型的目录。

自	1.5

类型

array<string|int, mixed>

存储各种工具栏的单例实例。

静态已弃用

自	2.5
已弃用	5.0 将在 7.0 中移除工具栏实例将存储在 \Joomla\CMS\Document\HTMLDocument 对象中从 Factory::getApplication()->getDocument()->getToolbar('name'); 请求实例。

类型

array<string|int, Toolbar>

用于创建 Toolbar API 对象的工厂

自	4.0.0

类型

ToolbarFactoryInterface