| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2005 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 759 lines (24 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| title($title, $icon = 'generic.png') X-Ref |
| 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: string $title The title. param: string $icon The space-separated names of the image. return: void |
| spacer($width = '') X-Ref |
| Writes a spacer cell. param: string $width The width for the cell return: void |
| divider() X-Ref |
| Writes a divider between menu buttons return: void |
| custom($task = '', $icon = '', $iconOver = '', $alt = '', $listSelect = true, $formId = null) X-Ref |
| Writes a custom option and task button for the button bar. param: string $task The task to perform (picked up by the switch($task) blocks). param: string $icon The image to display. param: string $iconOver @deprecated 5.0 param: string $alt The alt text for the icon image. param: bool $listSelect True if required to check that a standard list item is checked. param: string $formId The id of action form. return: void |
| preview($url = '', $updateEditors = false, $icon = 'preview', $bodyHeight = null, $modalWidth = null) X-Ref |
| Writes a preview button for a given option (opens a popup window). param: string $url The name of the popup file (excluding the file extension) param: bool $updateEditors Unused param: string $icon The image to display. param: integer $bodyHeight The body height of the preview popup param: integer $modalWidth The modal width of the preview popup return: void |
| jooa11y($url = '', $updateEditors = false, $icon = 'icon-universal-access', $bodyHeight = null, $modalWidth = null) X-Ref |
| Writes a jooa11y accessibility checker button for a given option (opens a popup window). param: string $url The url to open param: bool $updateEditors Unused param: string $icon The image to display. param: integer $bodyHeight The body height of the preview popup param: integer $modalWidth The modal width of the preview popup return: void |
| help($ref, $com = false, $override = null, $component = null) X-Ref |
| Writes a help button for a given option (opens a popup window). param: string $ref The name of the popup file (excluding the file extension for an xml file). param: bool $com Use the help file in the component directory. param: string $override Use this URL instead of any other param: string $component Name of component to get Help (null for current component) return: void |
| inlinehelp(string $class = "hide-aware-inline-help") X-Ref |
| Writes a help button for showing/hiding the inline help of a form param: string $class The class used by the inline help items. return: void |
| back($alt = 'JTOOLBAR_BACK', $href = 'javascript:history.back() X-Ref |
| Writes a cancel button that will go back to the previous page without doing any other operation. param: string $alt Alternative text. param: string $href URL of the href attribute. return: void |
| link($url, $text, $name = 'link') X-Ref |
| Creates a button to redirect to a link param: string $url The link url param: string $text Button text param: string $name Name to be used as apart of the id return: void |
| media_manager($directory = '', $alt = 'JTOOLBAR_UPLOAD') X-Ref |
| Writes a media_manager button. param: string $directory The subdirectory to upload the media to. param: string $alt An override for the alt text. return: void |
| makeDefault($task = 'default', $alt = 'JTOOLBAR_DEFAULT') X-Ref |
| Writes a common 'default' button for a record. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| assign($task = 'assign', $alt = 'JTOOLBAR_ASSIGN') X-Ref |
| Writes a common 'assign' button for a record. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| addNew($task = 'add', $alt = 'JTOOLBAR_NEW', $check = false) X-Ref |
| Writes the common 'new' icon for the button bar. param: string $task An override for the task. param: string $alt An override for the alt text. param: boolean $check True if required to check that a standard list item is checked. return: void |
| publish($task = 'publish', $alt = 'JTOOLBAR_PUBLISH', $check = false) X-Ref |
| Writes a common 'publish' button. param: string $task An override for the task. param: string $alt An override for the alt text. param: boolean $check True if required to check that a standard list item is checked. return: void |
| publishList($task = 'publish', $alt = 'JTOOLBAR_PUBLISH') X-Ref |
| Writes a common 'publish' button for a list of records. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| unpublish($task = 'unpublish', $alt = 'JTOOLBAR_UNPUBLISH', $check = false) X-Ref |
| Writes a common 'unpublish' button. param: string $task An override for the task. param: string $alt An override for the alt text. param: boolean $check True if required to check that a standard list item is checked. return: void |
| unpublishList($task = 'unpublish', $alt = 'JTOOLBAR_UNPUBLISH') X-Ref |
| Writes a common 'unpublish' button for a list of records. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| archiveList($task = 'archive', $alt = 'JTOOLBAR_ARCHIVE') X-Ref |
| Writes a common 'archive' button for a list of records. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| unarchiveList($task = 'unarchive', $alt = 'JTOOLBAR_UNARCHIVE') X-Ref |
| Writes an unarchive button for a list of records. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| editList($task = 'edit', $alt = 'JTOOLBAR_EDIT') X-Ref |
| Writes a common 'edit' button for a list of records. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| editHtml($task = 'edit_source', $alt = 'JTOOLBAR_EDIT_HTML') X-Ref |
| Writes a common 'edit' button for a template html. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| editCss($task = 'edit_css', $alt = 'JTOOLBAR_EDIT_CSS') X-Ref |
| Writes a common 'edit' button for a template css. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| deleteList($msg = '', $task = 'remove', $alt = 'JTOOLBAR_DELETE') X-Ref |
| Writes a common 'delete' button for a list of records. param: string $msg Postscript for the 'are you sure' message. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| trash($task = 'remove', $alt = 'JTOOLBAR_TRASH', $check = true) X-Ref |
| Writes a common 'trash' button for a list of records. param: string $task An override for the task. param: string $alt An override for the alt text. param: bool $check True to allow lists. return: void |
| apply($task = 'apply', $alt = 'JTOOLBAR_APPLY') X-Ref |
| Writes a save button for a given option. Apply operation leads to a save action only (does not leave edit mode). param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| save($task = 'save', $alt = 'JTOOLBAR_SAVE') X-Ref |
| Writes a save button for a given option. Save operation leads to a save and then close action. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| save2new($task = 'save2new', $alt = 'JTOOLBAR_SAVE_AND_NEW') X-Ref |
| Writes a save and create new button for a given option. Save and create operation leads to a save and then add action. param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| save2copy($task = 'save2copy', $alt = 'JTOOLBAR_SAVE_AS_COPY') X-Ref |
| 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: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| checkin($task = 'checkin', $alt = 'JTOOLBAR_CHECKIN', $check = true) X-Ref |
| Writes a checkin button for a given option. param: string $task An override for the task. param: string $alt An override for the alt text. param: boolean $check True if required to check that a standard list item is checked. return: void |
| cancel($task = 'cancel', $alt = 'JTOOLBAR_CANCEL') X-Ref |
| Writes a cancel button and invokes a cancel operation (eg a checkin). param: string $task An override for the task. param: string $alt An override for the alt text. return: void |
| preferences($component, $height = 550, $width = 875, $alt = 'JTOOLBAR_OPTIONS', $path = '') X-Ref |
| Writes a configuration button and invokes a cancel operation (eg a checkin). param: string $component The name of the component, eg, com_content. param: integer $height The height of the popup. [UNUSED] param: integer $width The width of the popup. [UNUSED] param: string $alt The name of the button. param: string $path An alternative path for the configuration xml relative to JPATH_SITE. return: void |
| versions($typeAlias, $itemId, $height = 800, $width = 500, $alt = 'JTOOLBAR_VERSIONS') X-Ref |
| Writes a version history param: string $typeAlias The component and type, for example 'com_content.article' param: integer $itemId The id of the item, for example the article id. param: integer $height The height of the popup. param: integer $width The width of the popup. param: string $alt The name of the button. return: void |
| saveGroup($buttons = array() X-Ref |
| Writes a save button for a given option, with an additional dropdown param: array $buttons An array of buttons param: string $class The button class return: void |
| modal($targetModalId, $icon, $alt, $class = 'btn-primary') X-Ref |
| No description |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |