BaseWidget

Type
Abstract Class
Namespace
Craft
Inherits
Craft\BaseWidget » Craft\BaseSavableComponentType » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
Craft\IComponentType, Craft\ISavableComponentType, Craft\IWidget, IApplicationComponent
Extended by
Craft\FeedWidget, Craft\GetHelpWidget, Craft\NewUsersWidget, Craft\QuickPostWidget, Craft\RecentEntriesWidget, Craft\UpdatesWidget
Since
1.0

Widget base class.

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.
$modelCraft\BaseModel

Protected Properties

$componentType

Signature

protected string $componentType = 'Widget'

$multi

Signature

protected boolean $multi = true

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()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()Returns the list of attached event handlers for an event.
getIconPath()Returns the path to the widget’s SVG icon.
getIsInitialized()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()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()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()Raises an event.
setSettings()Sets the setting values.

getBodyHtml()

Returns the widget's body HTML.

IWidget::getBodyHtml()

View source

Returns

string, false – 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()

View source

Returns

string – The path to the widget’s SVG icon

Signature

public string getIconPath ( )

getMaxColspan()

Returns the widget's maximum colspan.

IWidget::getMaxColspan()

View source

Returns

integer – The widget’s maximum colspan.

Signature

public integer getMaxColspan ( )

getTitle()

Returns the widget's title.

IWidget::getTitle()

View source

Returns

string – The widget’s title.

Signature

public string getTitle ( )

isSelectable()

Returns whether this component should be shown when the user is creating a component of this type.

IComponentType::isSelectable()

View source

Returns

boolean – Whether the component should be selectable.

Signature

public boolean isSelectable ( )

Protected Methods

MethodDescription
defineSettings()Defines the settings.
getSettingsModel()Returns the settings model.