GetHelpWidget
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\GetHelpWidget » Craft\BaseWidget » Craft\BaseSavableComponentType » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
- Craft\IComponentType, Craft\ISavableComponentType, Craft\IWidget,
IApplicationComponent - Since
- 1.0
Get Help widget.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
| $model | Craft\BaseModel |
# Protected Properties
| Property | Description |
|---|---|
| $componentType | string (opens new window) |
| $multi | boolean (opens new window) |
# $multi
Signature
protected boolean $multi = false
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getBodyHtml() | Returns the widget's body HTML. |
| getClassHandle() | Returns the component’s handle, ideally based on the class name. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIconPath() | Returns the path to the widget’s SVG icon. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| getMaxColspan() | Returns the widget's maximum colspan. |
| getName() | Returns the component’s name. |
| getSettings() | Returns the component’s settings model. |
| getSettingsHtml() | Returns the component’s settings HTML. |
| getTitle() | Returns the widget's title. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| isSelectable() | Returns whether this component should be shown when the user is creating a component of this type. |
| prepSettings() | Preps the settings before they’re saved to the database. |
| raiseEvent() (opens new window) | Raises an event. |
| setSettings() | Sets the setting values. |
# getBodyHtml()
Returns the widget's body HTML.
IWidget::getBodyHtml()
IWidget::getBodyHtml()
View source (opens new window)
Returns
string (opens new window), false (opens new window) – The widget’s body HTML, or false if the widget
should not be visible. (If you don’t want the widget
to be selectable in the first place, use {@link isSelectable()}.)
Signature
public string, false getBodyHtml ( )
# getIconPath()
Returns the path to the widget’s SVG icon.
IWidget::getIconPath()
IWidget::getIconPath()
View source (opens new window)
Returns
string (opens new window) – The path to the widget’s SVG icon
Signature
public string getIconPath ( )
# getName()
Returns the component’s name.
This is what your component will be called throughout the Control Panel.
IComponentType::getName()
View source (opens new window)
Returns
string (opens new window) – The component’s name.
Signature
public string getName ( )
# isSelectable()
Returns whether this component should be shown when the user is creating a component of this type.
IComponentType::isSelectable()
IComponentType::isSelectable()
View source (opens new window)
Returns
boolean (opens new window) – Whether the component should be selectable.
Signature
public boolean isSelectable ( )
# Protected Methods
| Method | Description |
|---|---|
| defineSettings() | Defines the settings. |
| getSettingsModel() | Returns the settings model. |