DashboardService

Type
Class
Namespace
Craft
Inherits
Craft\DashboardService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

Class DashboardService

See also http://craftcms.com

View source

Public Properties

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

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.
changeWidgetColspan()Changes the colspan of a widget.
deleteUserWidgetById()Soft deletes a widget.
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.
doesUserHaveWidget()Returns whether the current user has a widget of the given type.
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.
getAllWidgetTypes()Returns all installed widget types.
getEventHandlers()Returns the list of attached event handlers for an event.
getIsInitialized()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()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.
populateWidgetType()Populates a widget type.
raiseEvent()Raises an event.
reorderUserWidgets()Reorders widgets.
saveUserWidget()Saves a widget for the current user.

changeWidgetColspan()

Changes the colspan of a widget.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean changeWidgetColspan ( $widgetId, $colspan )

deleteUserWidgetById()

Soft deletes a widget.

View source

Arguments

Returns

boolean

Signature

public boolean deleteUserWidgetById ( $widgetId )

doesUserHaveWidget()

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

View source

Arguments

  • $type

Returns

boolean

Signature

public boolean doesUserHaveWidget ( $type )

getAllWidgetTypes()

Returns all installed widget types.

View source

Returns

array

Signature

public array getAllWidgetTypes ( )

getUserWidgetById()

Returns a widget by its ID.

View source

Arguments

Returns

Craft\WidgetModel

Signature

public Craft\WidgetModel getUserWidgetById ( $id )

getUserWidgets()

Returns the dashboard widgets for the current user.

View source

Arguments

Returns

array

Signature

public array getUserWidgets ( $indexBy = null )

getWidgetType()

Returns a widget type.

View source

Arguments

Returns

Craft\BaseWidget, null

Signature

public Craft\BaseWidget, null getWidgetType ( $class )

populateWidgetType()

Populates a widget type.

View source

Arguments

Returns

Craft\BaseWidget, null

Signature

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

reorderUserWidgets()

Reorders widgets.

View source

Arguments

Returns

boolean

Throws

Signature

public boolean reorderUserWidgets ( $widgetIds )

saveUserWidget()

Saves a widget for the current user.

View source

Arguments

Returns

boolean

Signature

public boolean saveUserWidget ( Craft\WidgetModel $widget )