DashboardService

Type
Class
Namespace
Craft
Inherits
Craft\DashboardService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements
IApplicationComponent
Since
1.0

Class DashboardService

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.

# 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.
changeWidgetColspan() Changes the colspan of a widget.
deleteUserWidgetById() Soft deletes a widget.
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.
doesUserHaveWidget() Returns whether the current user has a widget of the given type.
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.
getAllWidgetTypes() Returns all installed widget types.
getEventHandlers() (opens new window) Returns the list of attached event handlers for an event.
getIsInitialized() (opens new window) Checks if this application component has been initialized.
getUserWidgetById() Returns a widget by its ID.
getUserWidgets() Returns the dashboard widgets for the current user.
getWidgetType() Returns a widget type.
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.
populateWidgetType() Populates a widget type.
raiseEvent() (opens new window) Raises an event.
reorderUserWidgets() Reorders widgets.
saveUserWidget() Saves a widget for the current user.

# changeWidgetColspan()

Signature

public boolean changeWidgetColspan ( $widgetId, $colspan )

# deleteUserWidgetById()

Soft deletes a widget.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Signature

public boolean deleteUserWidgetById ( $widgetId )

# doesUserHaveWidget()

Returns whether the current user has a widget of the given type.

View source (opens new window)

Arguments

  • $type

Returns

boolean (opens new window)

Signature

public boolean doesUserHaveWidget ( $type )

# getAllWidgetTypes()

Returns all installed widget types.

View source (opens new window)

Returns

array (opens new window)

Signature

public array getAllWidgetTypes ( )

# getUserWidgetById()

Returns a widget by its ID.

View source (opens new window)

Arguments

Returns

Craft\WidgetModel

Signature

public Craft\WidgetModel getUserWidgetById ( $id )

# getUserWidgets()

Returns the dashboard widgets for the current user.

View source (opens new window)

Arguments

Returns

array (opens new window)

Signature

public array getUserWidgets ( $indexBy = null )

# getWidgetType()

Signature

public Craft\BaseWidget, null getWidgetType ( $class )

# populateWidgetType()

Signature

public Craft\BaseWidget, null populateWidgetType ( Craft\WidgetModel $widget )

# reorderUserWidgets()

Signature

public boolean reorderUserWidgets ( $widgetIds )

# saveUserWidget()

Saves a widget for the current user.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

Signature

public boolean saveUserWidget ( Craft\WidgetModel $widget )