| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2017 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 322 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ActionButton:: (14 methods):
__construct()
preprocess()
addState()
getState()
removeState()
render()
__toString()
getLayout()
setLayout()
getOptions()
setOptions()
getOption()
setOption()
fetchIconClass()
Class: ActionButton - X-Ref
The TaskButton class.| __construct(array $options = []) X-Ref |
| ActionButton constructor. param: array $options The options for all buttons in this group. |
| preprocess() X-Ref |
| Configure this object. return: void |
| addState(int $value, string $task, string $icon = 'ok', string $title = '', array $options = []) X-Ref |
| Add a state profile. param: integer $value The value of this state. param: string $task The task you want to execute after click this button. param: string $icon The icon to display for user. param: string $title Title text will show if we enable tooltips. param: array $options The button options, will override group options. return: static Return self to support chaining. |
| getState(int $value) X-Ref |
| Get state profile by value name. param: integer $value The value name we want to get. return: array|null Return state profile or NULL. |
| removeState(int $value) X-Ref |
| Remove a state by value name. param: integer $value Remove state by this value. return: static Return to support chaining. |
| render(?int $value = null, ?int $row = null, array $options = []) X-Ref |
| Render action button by item value. param: integer|null $value Current value of this item. param: integer|null $row The row number of this item. param: array $options The options to override group options. return: string Rendered HTML. |
| __toString() X-Ref |
| Render to string. return: string |
| getLayout() X-Ref |
| Method to get property layout. return: string |
| setLayout(string $layout) X-Ref |
| Method to set property template. param: string $layout The layout path. return: static Return self to support chaining. |
| getOptions() X-Ref |
| Method to get property options. return: array |
| setOptions(array $options) X-Ref |
| Method to set property options. param: array $options The options of this button group. return: static Return self to support chaining. |
| getOption(string $name, $default = null) X-Ref |
| Get an option value. param: string $name The option name. param: mixed $default Default value if not exists. return: mixed Return option value or default value. |
| setOption(string $name, $value) X-Ref |
| Set option value. param: string $name The option name. param: mixed $value The option value. return: static Return self to support chaining. |
| fetchIconClass(string $identifier) X-Ref |
| Method to get the CSS class name for an icon identifier. Can be redefined in the final class. param: string $identifier Icon identification string. return: string CSS class name. |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |