Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe JToolbarHelper

Fonctions membres publiques statiques

static title ($title, $icon='generic.png')
 
static spacer ($width='')
 
static divider ()
 
static custom ($task='', $icon='', $iconOver='', $alt='', $listSelect=true)
 
static preview ($url='', $updateEditors=false)
 
static help ($ref, $com=false, $override=null, $component=null)
 
static back ($alt='JTOOLBAR_BACK', $href='javascript:history.back();')
 
static link ($url, $text, $name='link')
 
static media_manager ($directory='', $alt='JTOOLBAR_UPLOAD')
 
static makeDefault ($task='default', $alt='JTOOLBAR_DEFAULT')
 
static assign ($task='assign', $alt='JTOOLBAR_ASSIGN')
 
static addNew ($task='add', $alt='JTOOLBAR_NEW', $check=false)
 
static publish ($task='publish', $alt='JTOOLBAR_PUBLISH', $check=false)
 
static publishList ($task='publish', $alt='JTOOLBAR_PUBLISH')
 
static unpublish ($task='unpublish', $alt='JTOOLBAR_UNPUBLISH', $check=false)
 
static unpublishList ($task='unpublish', $alt='JTOOLBAR_UNPUBLISH')
 
static archiveList ($task='archive', $alt='JTOOLBAR_ARCHIVE')
 
static unarchiveList ($task='unarchive', $alt='JTOOLBAR_UNARCHIVE')
 
static editList ($task='edit', $alt='JTOOLBAR_EDIT')
 
static editHtml ($task='edit_source', $alt='JTOOLBAR_EDIT_HTML')
 
static editCss ($task='edit_css', $alt='JTOOLBAR_EDIT_CSS')
 
static deleteList ($msg='', $task='remove', $alt='JTOOLBAR_DELETE')
 
static trash ($task='remove', $alt='JTOOLBAR_TRASH', $check=true)
 
static apply ($task='apply', $alt='JTOOLBAR_APPLY')
 
static save ($task='save', $alt='JTOOLBAR_SAVE')
 
static save2new ($task='save2new', $alt='JTOOLBAR_SAVE_AND_NEW')
 
static save2copy ($task='save2copy', $alt='JTOOLBAR_SAVE_AS_COPY')
 
static checkin ($task='checkin', $alt='JTOOLBAR_CHECKIN', $check=true)
 
static cancel ($task='cancel', $alt='JTOOLBAR_CANCEL')
 
static preferences ($component, $height='550', $width='875', $alt='JToolbar_Options', $path='')
 
static versions ($typeAlias, $itemId, $height=800, $width=500, $alt='JTOOLBAR_VERSIONS')
 
static modal ($targetModalId, $icon, $alt)
 

Description détaillée

Utility class for the button bar.

Depuis
1.5

Documentation des fonctions membres

◆ addNew()

◆ apply()

◆ archiveList()

static archiveList (   $task = 'archive',
  $alt = 'JTOOLBAR_ARCHIVE' 
)
static

◆ assign()

static assign (   $task = 'assign',
  $alt = 'JTOOLBAR_ASSIGN' 
)
static

Writes a common 'assign' button for a record.

Paramètres
string$taskAn override for the task.
string$altAn override for the alt text.
Renvoie
void
Depuis
1.5

Références $alt, et $task.

Référencé par FOFToolbar\renderToolbarElement().

◆ back()

static back (   $alt = 'JTOOLBAR_BACK',
  $href = 'javascript:history.back();' 
)
static

Writes a cancel button that will go back to the previous page without doing any other operation.

Paramètres
string$altAlternative text.
string$hrefURL of the href attribute.
Renvoie
void
Depuis
1.5

Références $alt, et $href.

Référencé par FOFToolbar\onRead(), et FOFToolbar\renderToolbarElement().

◆ cancel()

◆ checkin()

static checkin (   $task = 'checkin',
  $alt = 'JTOOLBAR_CHECKIN',
  $check = true 
)
static

◆ custom()

static custom (   $task = '',
  $icon = '',
  $iconOver = '',
  $alt = '',
  $listSelect = true 
)
static

◆ deleteList()

◆ divider()

static divider ( )
static

Writes a divider between menu buttons

Renvoie
void
Depuis
1.5

Référencé par CacheViewPurge\addToolbar(), UsersViewMail\addToolbar(), PluginsViewPlugin\addToolbar(), LanguagesViewLanguage\addToolbar(), InstallerViewDiscover\addToolbar(), LanguagesViewLanguages\addToolbar(), MessagesViewMessages\addToolbar(), TagsViewTag\addToolbar(), TemplatesViewStyles\addToolbar(), CacheViewCache\addToolbar(), InstallerViewManage\addToolbar(), UsersViewGroup\addToolbar(), UsersViewLevel\addToolbar(), MediaViewMedia\addToolbar(), InstallerViewUpdatesites\addToolbar(), SearchViewSearches\addToolbar(), InstallerViewDefault\addToolbar(), MenusViewMenu\addToolbar(), BannersViewBanner\addToolbar(), TemplatesViewStyle\addToolbar(), UsersViewUser\addToolbar(), UsersViewGroups\addToolbar(), UsersViewLevels\addToolbar(), LanguagesViewOverrides\addToolbar(), BannersViewTracks\addToolbar(), UsersViewNote\addToolbar(), AdminViewProfile\addToolbar(), InstallerViewUpdate\addToolbar(), MenusViewMenus\addToolbar(), BannersViewClient\addToolbar(), InstallerViewDatabase\addToolbar(), TemplatesViewTemplates\addToolbar(), ContactViewContact\addToolbar(), LanguagesViewInstalled\addToolbar(), NewsfeedsViewNewsfeed\addToolbar(), ConfigViewApplicationHtml\addToolbar(), CheckinViewCheckin\addToolbar(), LanguagesViewOverride\addToolbar(), UsersViewDebuguser\addToolbar(), UsersViewDebuggroup\addToolbar(), ConfigViewComponentHtml\addToolbar(), ContentViewArticle\addToolbar(), UsersViewNotes\addToolbar(), MenusViewItem\addToolbar(), FinderViewFilter\addToolbar(), FinderViewFilters\addToolbar(), CategoriesViewCategory\addToolbar(), FinderViewMaps\addToolbar(), RedirectViewLinks\addToolbar(), UsersViewUsers\addToolbar(), TemplatesViewTemplate\addToolbar(), MenusViewItems\addToolbar(), JoomlaupdateViewUpload\display(), FOFToolbar\onBrowse(), et FOFToolbar\renderToolbarElement().

◆ editCss()

static editCss (   $task = 'edit_css',
  $alt = 'JTOOLBAR_EDIT_CSS' 
)
static

Writes a common 'edit' button for a template css.

Paramètres
string$taskAn override for the task.
string$altAn override for the alt text.
Renvoie
void
Depuis
1.5

Références $alt, et $task.

Référencé par FOFToolbar\renderToolbarElement().

◆ editHtml()

static editHtml (   $task = 'edit_source',
  $alt = 'JTOOLBAR_EDIT_HTML' 
)
static

Writes a common 'edit' button for a template html.

Paramètres
string$taskAn override for the task.
string$altAn override for the alt text.
Renvoie
void
Depuis
1.5

Références $alt, et $task.

Référencé par FOFToolbar\renderToolbarElement().

◆ editList()

◆ help()

static help (   $ref,
  $com = false,
  $override = null,
  $component = null 
)
static

Writes a preview button for a given option (opens a popup window).

Paramètres
string$refThe name of the popup file (excluding the file extension for an xml file).
bool$comUse the help file in the component directory.
string$overrideUse this URL instead of any other
string$componentName of component to get Help (null for current component)
Renvoie
void
Depuis
1.5

Références $component.

Référencé par CacheViewPurge\addToolbar(), InstallerViewWarnings\addToolbar(), UsersViewMail\addToolbar(), PluginsViewPlugin\addToolbar(), InstallerViewInstall\addToolbar(), LanguagesViewLanguage\addToolbar(), ModulesViewModule\addToolbar(), MessagesViewMessage\addToolbar(), RedirectViewLink\addToolbar(), PluginsViewPlugins\addToolbar(), InstallerViewDiscover\addToolbar(), LanguagesViewLanguages\addToolbar(), MessagesViewMessages\addToolbar(), TagsViewTag\addToolbar(), TemplatesViewStyles\addToolbar(), CacheViewCache\addToolbar(), UsersViewGroup\addToolbar(), UsersViewLevel\addToolbar(), InstallerViewManage\addToolbar(), MediaViewMedia\addToolbar(), InstallerViewUpdatesites\addToolbar(), SearchViewSearches\addToolbar(), TemplatesViewStyle\addToolbar(), MenusViewMenu\addToolbar(), BannersViewBanner\addToolbar(), UsersViewUser\addToolbar(), FieldsViewField\addToolbar(), UsersViewGroups\addToolbar(), UsersViewLevels\addToolbar(), LanguagesViewOverrides\addToolbar(), BannersViewClients\addToolbar(), AdminViewProfile\addToolbar(), UsersViewNote\addToolbar(), BannersViewTracks\addToolbar(), InstallerViewUpdate\addToolbar(), BannersViewClient\addToolbar(), MenusViewMenus\addToolbar(), InstallerViewDatabase\addToolbar(), TemplatesViewTemplates\addToolbar(), TagsViewTags\addToolbar(), ContactViewContact\addToolbar(), LanguagesViewInstalled\addToolbar(), ConfigViewApplicationHtml\addToolbar(), NewsfeedsViewNewsfeed\addToolbar(), ModulesViewModules\addToolbar(), BannersViewBanners\addToolbar(), LanguagesViewOverride\addToolbar(), CheckinViewCheckin\addToolbar(), UsersViewDebuggroup\addToolbar(), UsersViewDebuguser\addToolbar(), ConfigViewComponentHtml\addToolbar(), FieldsViewGroup\addToolbar(), ContentViewArticle\addToolbar(), MenusViewItem\addToolbar(), UsersViewNotes\addToolbar(), FinderViewFilter\addToolbar(), FieldsViewGroups\addToolbar(), CategoriesViewCategory\addToolbar(), FinderViewFilters\addToolbar(), NewsfeedsViewNewsfeeds\addToolbar(), FieldsViewFields\addToolbar(), FinderViewMaps\addToolbar(), RedirectViewLinks\addToolbar(), UsersViewUsers\addToolbar(), AdminViewSysinfo\addToolbar(), ContentViewFeatured\addToolbar(), ContactViewContacts\addToolbar(), FinderViewIndex\addToolbar(), CategoriesViewCategories\addToolbar(), ContentViewArticles\addToolbar(), TemplatesViewTemplate\addToolbar(), AssociationsViewAssociation\addToolbar(), AssociationsViewAssociations\addToolbar(), MenusViewItems\addToolbar(), JoomlaupdateViewUpload\display(), CpanelViewCpanel\display(), PostinstallToolbar\onMessages(), et FOFToolbar\renderToolbarElement().

◆ link()

static link (   $url,
  $text,
  $name = 'link' 
)
static

Creates a button to redirect to a link

Paramètres
string$urlThe link url
string$textButton text
string$nameName to be used as apart of the id
Renvoie
void
Depuis
3.5

Références $name, $text, et $url.

Référencé par AdminViewSysinfo\addToolbar().

◆ makeDefault()

static makeDefault (   $task = 'default',
  $alt = 'JTOOLBAR_DEFAULT' 
)
static

Writes a common 'default' button for a record.

Paramètres
string$taskAn override for the task.
string$altAn override for the alt text.
Renvoie
void
Depuis
1.5

Références $alt, et $task.

Référencé par TemplatesViewStyles\addToolbar(), LanguagesViewInstalled\addToolbar(), et MenusViewItems\addToolbar().

◆ media_manager()

static media_manager (   $directory = '',
  $alt = 'JTOOLBAR_UPLOAD' 
)
static

Writes a media_manager button.

Paramètres
string$directoryThe subdirectory to upload the media to.
string$altAn override for the alt text.
Renvoie
void
Depuis
1.5

Références $alt.

Référencé par FOFToolbar\renderToolbarElement().

◆ modal()

static modal (   $targetModalId,
  $icon,
  $alt 
)
static

Displays a modal button

Paramètres
string$targetModalIdID of the target modal box
string$iconIcon class to show on modal button
string$altTitle for the modal button
Renvoie
void
Depuis
3.2

Références $alt, $icon, et $title.

Référencé par TemplatesViewTemplate\addToolbar().

◆ preferences()

static preferences (   $component,
  $height = '550',
  $width = '875',
  $alt = 'JToolbar_Options',
  $path = '' 
)
static

Writes a configuration button and invokes a cancel operation (eg a checkin).

Paramètres
string$componentThe name of the component, eg, com_content.
integer$heightThe height of the popup. [UNUSED]
integer$widthThe width of the popup. [UNUSED]
string$altThe name of the button.
string$pathAn alternative path for the configuation xml relative to JPATH_SITE.
Renvoie
void
Depuis
1.5

Références $alt, $component, $path, $return, et $uri.

Référencé par CacheViewPurge\addToolbar(), UsersViewMail\addToolbar(), PluginsViewPlugins\addToolbar(), LanguagesViewLanguages\addToolbar(), MessagesViewMessages\addToolbar(), TemplatesViewStyles\addToolbar(), CacheViewCache\addToolbar(), MediaViewMedia\addToolbar(), InstallerViewDefault\addToolbar(), SearchViewSearches\addToolbar(), UsersViewLevels\addToolbar(), UsersViewGroups\addToolbar(), LanguagesViewOverrides\addToolbar(), BannersViewClients\addToolbar(), BannersViewTracks\addToolbar(), MenusViewMenus\addToolbar(), TemplatesViewTemplates\addToolbar(), TagsViewTags\addToolbar(), LanguagesViewInstalled\addToolbar(), ModulesViewModules\addToolbar(), BannersViewBanners\addToolbar(), CheckinViewCheckin\addToolbar(), UsersViewDebuggroup\addToolbar(), UsersViewDebuguser\addToolbar(), UsersViewNotes\addToolbar(), FieldsViewGroups\addToolbar(), FinderViewFilters\addToolbar(), NewsfeedsViewNewsfeeds\addToolbar(), FieldsViewFields\addToolbar(), FinderViewMaps\addToolbar(), RedirectViewLinks\addToolbar(), UsersViewUsers\addToolbar(), ContentViewFeatured\addToolbar(), ContactViewContacts\addToolbar(), FinderViewIndex\addToolbar(), CategoriesViewCategories\addToolbar(), ContentViewArticles\addToolbar(), AssociationsViewAssociations\addToolbar(), MenusViewItems\addToolbar(), FOFToolbar\onCpanelsBrowse(), et FOFToolbar\renderToolbarElement().

◆ preview()

static preview (   $url = '',
  $updateEditors = false 
)
static

Writes a preview button for a given option (opens a popup window).

Paramètres
string$urlThe name of the popup file (excluding the file extension)
bool$updateEditorsUnused
Renvoie
void
Depuis
1.5

Références $url.

Référencé par FOFToolbar\renderToolbarElement().

◆ publish()

◆ publishList()

static publishList (   $task = 'publish',
  $alt = 'JTOOLBAR_PUBLISH' 
)
static

Writes a common 'publish' button for a list of records.

Paramètres
string$taskAn override for the task.
string$altAn override for the alt text.
Renvoie
void
Depuis
1.5

Références $alt, et $task.

Référencé par LanguagesViewLanguages\addToolbar(), FinderViewFilters\addToolbar(), FinderViewMaps\addToolbar(), FinderViewIndex\addToolbar(), FOFToolbar\onBrowse(), et FOFToolbar\renderToolbarElement().

◆ save()

◆ save2copy()

static save2copy (   $task = 'save2copy',
  $alt = 'JTOOLBAR_SAVE_AS_COPY' 
)
static

Writes a save as copy button for a given option. Save as copy operation leads to a save after clearing the key, then returns user to edit mode with new key.

Paramètres
string$taskAn override for the task.
string$altAn override for the alt text.
Renvoie
void
Depuis
1.6

Références $alt, et $task.

Référencé par ModulesViewModule\addToolbar(), TagsViewTag\addToolbar(), UsersViewLevel\addToolbar(), UsersViewGroup\addToolbar(), BannersViewBanner\addToolbar(), TemplatesViewStyle\addToolbar(), FieldsViewField\addToolbar(), UsersViewNote\addToolbar(), BannersViewClient\addToolbar(), ContactViewContact\addToolbar(), NewsfeedsViewNewsfeed\addToolbar(), FieldsViewGroup\addToolbar(), ContentViewArticle\addToolbar(), MenusViewItem\addToolbar(), FinderViewFilter\addToolbar(), CategoriesViewCategory\addToolbar(), et FOFToolbar\renderToolbarElement().

◆ save2new()

◆ spacer()

static spacer (   $width = '')
static

Writes a spacer cell.

Paramètres
string$widthThe width for the cell
Renvoie
void
Depuis
1.5

Références $width.

◆ title()

static title (   $title,
  $icon = 'generic.png' 
)
static

Title cell. For the title and toolbar to be rendered correctly, this title function must be called before the starttable function and the toolbars icons this is due to the nature of how the css has been used to position the title in respect to the toolbar.

Paramètres
string$titleThe title.
string$iconThe space-separated names of the image.
Renvoie
void
Depuis
1.5

Références $app, $html, $icon, $layout, $title, et getDocument.

Référencé par CacheViewPurge\addToolbar(), UsersViewMail\addToolbar(), ModulesViewSelect\addToolbar(), PluginsViewPlugin\addToolbar(), LanguagesViewLanguage\addToolbar(), ModulesViewModule\addToolbar(), MessagesViewMessage\addToolbar(), RedirectViewLink\addToolbar(), PluginsViewPlugins\addToolbar(), LanguagesViewLanguages\addToolbar(), MessagesViewMessages\addToolbar(), TagsViewTag\addToolbar(), TemplatesViewStyles\addToolbar(), CacheViewCache\addToolbar(), UsersViewGroup\addToolbar(), UsersViewLevel\addToolbar(), MediaViewMedia\addToolbar(), InstallerViewDefault\addToolbar(), SearchViewSearches\addToolbar(), MenusViewMenutypes\addToolbar(), TemplatesViewStyle\addToolbar(), BannersViewBanner\addToolbar(), MenusViewMenu\addToolbar(), UsersViewUser\addToolbar(), FieldsViewField\addToolbar(), UsersViewGroups\addToolbar(), UsersViewLevels\addToolbar(), BannersViewClients\addToolbar(), LanguagesViewOverrides\addToolbar(), BannersViewTracks\addToolbar(), UsersViewNote\addToolbar(), AdminViewProfile\addToolbar(), MenusViewMenus\addToolbar(), BannersViewClient\addToolbar(), TemplatesViewTemplates\addToolbar(), TagsViewTags\addToolbar(), ContactViewContact\addToolbar(), LanguagesViewInstalled\addToolbar(), ConfigViewApplicationHtml\addToolbar(), ModulesViewModules\addToolbar(), NewsfeedsViewNewsfeed\addToolbar(), LanguagesViewOverride\addToolbar(), CheckinViewCheckin\addToolbar(), BannersViewBanners\addToolbar(), UsersViewDebuggroup\addToolbar(), UsersViewDebuguser\addToolbar(), ConfigViewComponentHtml\addToolbar(), FieldsViewGroup\addToolbar(), AdminViewHelp\addToolbar(), ContentViewArticle\addToolbar(), UsersViewNotes\addToolbar(), MenusViewItem\addToolbar(), FinderViewFilter\addToolbar(), FieldsViewGroups\addToolbar(), FinderViewFilters\addToolbar(), CategoriesViewCategory\addToolbar(), NewsfeedsViewNewsfeeds\addToolbar(), FieldsViewFields\addToolbar(), FinderViewMaps\addToolbar(), RedirectViewLinks\addToolbar(), UsersViewUsers\addToolbar(), AdminViewSysinfo\addToolbar(), ContentViewFeatured\addToolbar(), ContactViewContacts\addToolbar(), FinderViewIndex\addToolbar(), CategoriesViewCategories\addToolbar(), ContentViewArticles\addToolbar(), TemplatesViewTemplate\addToolbar(), AssociationsViewAssociation\addToolbar(), AssociationsViewAssociations\addToolbar(), MenusViewItems\addToolbar(), JoomlaupdateViewUpdate\display(), JoomlaupdateViewUpload\display(), CpanelViewCpanel\display(), FOFToolbar\onAdd(), FOFToolbar\onBrowse(), FOFToolbar\onCpanelsBrowse(), FOFToolbar\onRead(), et FOFToolbar\renderToolbarElement().

◆ trash()

◆ unarchiveList()

static unarchiveList (   $task = 'unarchive',
  $alt = 'JTOOLBAR_UNARCHIVE' 
)
static

Writes an unarchive button for a list of records.

Paramètres
string$taskAn override for the task.
string$altAn override for the alt text.
Renvoie
void
Depuis
1.5

Références $alt, et $task.

Référencé par BannersViewBanners\addToolbar(), RedirectViewLinks\addToolbar(), et FOFToolbar\renderToolbarElement().

◆ unpublish()

◆ unpublishList()

static unpublishList (   $task = 'unpublish',
  $alt = 'JTOOLBAR_UNPUBLISH' 
)
static

Writes a common 'unpublish' button for a list of records.

Paramètres
string$taskAn override for the task.
string$altAn override for the alt text.
Renvoie
void
Depuis
1.5

Références $alt, et $task.

Référencé par LanguagesViewLanguages\addToolbar(), FinderViewFilters\addToolbar(), FinderViewMaps\addToolbar(), FinderViewIndex\addToolbar(), FOFToolbar\onBrowse(), et FOFToolbar\renderToolbarElement().

◆ versions()

static versions (   $typeAlias,
  $itemId,
  $height = 800,
  $width = 500,
  $alt = 'JTOOLBAR_VERSIONS' 
)
static

Writes a version history

Paramètres
string$typeAliasThe component and type, for example 'com_content.article'
integer$itemIdThe id of the item, for example the article id.
integer$heightThe height of the popup.
integer$widthThe width of the popup.
string$altThe name of the button.
Renvoie
void
Depuis
3.2

Références $alt, $height, $itemId, $lang, $layout, $options, $width, et JPATH_ADMINISTRATOR.

Référencé par TagsViewTag\addToolbar(), BannersViewBanner\addToolbar(), UsersViewNote\addToolbar(), BannersViewClient\addToolbar(), ContactViewContact\addToolbar(), NewsfeedsViewNewsfeed\addToolbar(), ContentViewArticle\addToolbar(), et CategoriesViewCategory\addToolbar().


La documentation de cette classe a été générée à partir du fichier suivant :