| Свойство | Тип | Описание | |
|---|---|---|---|
| $perms | Permissions map, see the __construct method for more information |
| Свойство | Тип | Описание | |
|---|---|---|---|
| $container | Component container | ||
| $isDataView | Are we rendering a data-aware view? | ||
| $linkbar | The links to be rendered in the toolbar | ||
| $renderFrontendButtons | Should I render buttons in the front-end? | ||
| $renderFrontendSubmenu | Should I render the submenu in the front-end? | ||
| $useConfigurationFile | Should I use the configuration file (fof.xml) of the component? |
| Метод | Описание | |
|---|---|---|
|
__construct ( |
Public constructor. | |
| appendLink ( string $name, string | null $link = null, boolean $active = false, string | null $icon = null, string | null $parent = '' ) : void | Append a link to the link bar | |
| clearLinks ( ) : void | Removes all links from the link bar | |
| getLinks ( ) : array | Get the link bar's link definitions | |
| getRenderFrontendButtons ( ) : boolean | Return the front-end toolbar rendering flag | |
| getRenderFrontendSubmenu ( ) : boolean | Return the front-end submenu rendering flag | |
| isDataView ( ) : boolean | Is the view we are rendering the toolbar for a data-aware view? | |
| onAdd ( ) : void | Renders the toolbar for the component's Add pages | |
| onBrowse ( ) : void | Renders the toolbar for the component's Browse pages (the plural views) | |
| onCpanelsBrowse ( ) : void | Renders the toolbar for the component's Control Panel page | |
| onEdit ( ) : void | Renders the toolbar for the component's Edit pages | |
| onRead ( ) : void | Renders the toolbar for the component's Read pages | |
| prefixLink ( string $name, string | null $link = null, boolean $active = false, string | null $icon = null ) : void | Prefixes (some people erroneously call this "prepend" – there is no such word) a link to the link bar | |
| renderSubmenu ( ) : void | Renders the submenu (toolbar links) for all detected views of this component | |
| renderToolbar ( string $view = null, string $task = null ) : void | Renders the toolbar for the current view and task | |
| setRenderFrontendButtons ( boolean $renderFrontendButtons ) | ||
| setRenderFrontendSubmenu ( boolean $renderFrontendSubmenu ) |
| Метод | Описание | |
|---|---|---|
| checkACL ( string $area ) : boolean | Checks if the current user has enough privileges for the requested ACL privilege of a custom toolbar button. | |
| getMyViews ( ) : array | Automatically detects all views of the component | |
| renderToolbarElements ( array $tasks ) : void | Simplified default rendering without any attributes. |
| Метод | Описание | |
|---|---|---|
| renderFromConfig ( array $toolbar ) : void | Render the toolbar from the configuration. | |
| renderToolbarElement ( string $type, mixed $value = null, array $attributes = [] ) : void | Render a toolbar element. |
|
public __construct ( |
||
| $c | The container for the component | |
| $config | array | The configuration overrides, see above |
| public appendLink ( string $name, string | null $link = null, boolean $active = false, string | null $icon = null, string | null $parent = '' ) : void | ||
| $name | string | The text of the link |
| $link | string | null | The link to render; set to null to render a separator |
| $active | boolean | True if it's an active link |
| $icon | string | null | Icon class (used by some renderers, like the Bootstrap renderer) |
| $parent | string | null | The parent element (referenced by name)) Thsi will create a dropdown list |
| Результат | void | |
| public clearLinks ( ) : void | ||
| Результат | void | |
| protected getMyViews ( ) : array | ||
| Результат | array | A list of all views, in the order to be displayed in the toolbar submenu |
| public getRenderFrontendButtons ( ) : boolean | ||
| Результат | boolean | |
| public isDataView ( ) : boolean | ||
| Результат | boolean | |
| public onCpanelsBrowse ( ) : void | ||
| Результат | void | |
| public prefixLink ( string $name, string | null $link = null, boolean $active = false, string | null $icon = null ) : void | ||
| $name | string | The text of the link |
| $link | string | null | The link to render; set to null to render a separator |
| $active | boolean | True if it's an active link |
| $icon | string | null | Icon class (used by some renderers, like the Bootstrap renderer) |
| Результат | void | |
| protected renderToolbarElements ( array $tasks ) : void | ||
| $tasks | array | Array of tasks. |
| Результат | void | |
| public setRenderFrontendButtons ( boolean $renderFrontendButtons ) | ||
| $renderFrontendButtons | boolean | |
| public $perms |
| protected $renderFrontendButtons |
