manager/controllers/default/dashboard/widget.grid-online.php

Show: inherited
Table of Contents

Package
modx  
Subpackage
dashboard  

\modDashboardWidgetWhoIsOnline

Package: modx\dashboard

Abstract class used for creating Dashboard Widgets. In your widget file, simply return the name of the class at the end of the file, and MODX will instantiate your class as a widget, and run the render() method to get the widget output.

Parent(s)
\modDashboardWidgetInterface

Properties

Propertypublicstring  $content= ''''
inherited

Inherited from: \modDashboardWidgetInterface::$$content
Default value''Details
Type
string
Inherited_from
\modDashboardWidgetInterface::$$content  
Propertypublic\modManagerController  $controller= ''
inherited

A reference to the currently loaded manager controller

Inherited from: \modDashboardWidgetInterface::$$controller
Propertypublicstring  $cssBlockClass= ''''
inherited

Allows widgets to specify a CSS class to attach to the block

Inherited from: \modDashboardWidgetInterface::$$cssBlockClass
Default value''Details
Type
string
Inherited_from
\modDashboardWidgetInterface::$$cssBlockClass  
Propertypublic\xPDO|\modX  $modx= ''
inherited

A reference to the modX|xPDO instance

Inherited from: \modDashboardWidgetInterface::$$modx
Details
Type
\xPDO | \modX
Inherited_from
\modDashboardWidgetInterface::$$modx  
Propertypublic\modNamespace  $namespace= ''
inherited

A reference to the Namespace that this widget is executing in

Inherited from: \modDashboardWidgetInterface::$$namespace
Propertypublic\modDashboardWidget  $widget= ''
inherited

A reference to this class's widget

Inherited from: \modDashboardWidgetInterface::$$widget

Methods

methodpublic__construct( \xPDO | \modX $modx, \modDashboardWidget $widget, \modManagerController $controller ) : void
Parameters
Name Type Description
$modx \xPDO | \modX

A reference to the modX instance

$widget \modDashboardWidget

A reference to this class's widget

$controller \modManagerController

A reference to the currently loaded manager controller

methodpublicgetFileChunk( string $tpl, array $placeholders = array() ) : string
Parameters
Name Type Description
$tpl string
$placeholders array
Returns
Type Description
string
methodpublicprocess( ) : string
inherited

Renders the content of the block in the appropriate size

Inherited from: \modDashboardWidgetInterface::process()
Returns
Type Description
string
methodpublicrender( ) : string

Must be declared in your derivative class. Must return the processed output of the widget.

Returns
Type Description
string
methodpublicrenderAsSnippet( string $content = '' ) : string
inherited

Render the widget content as if it were a Snippet

Inherited from: \modDashboardWidgetInterface::renderAsSnippet()
Parameters
Name Type Description
$content string
Returns
Type Description
string
methodpublicsetContent( string $content ) : void
inherited

Set the widget content

Inherited from: \modDashboardWidgetInterface::setContent()
Parameters
Name Type Description
$content string
methodpublicsetNamespace( \modNamespace $namespace ) : void
inherited

Sets the Namespace that this widget will execute in

Inherited from: \modDashboardWidgetInterface::setNamespace()
Parameters
Name Type Description
$namespace \modNamespace
methodpublictoArray( ) : array
inherited

Returns an array of placeholders for the block from the widget class. Override to add or change placeholders.

Inherited from: \modDashboardWidgetInterface::toArray()
Returns
Type Description
array
Documentation was generated by DocBlox 0.18.1.