manager/controllers/default/dashboard/widget.configcheck.php
Show:
inherited
inherited
Classes
- Package
- modx
- Subpackage
- dashboard
\modDashboardWidgetConfigCheck
Package: modx\dashboard
Renders the config check box
- Parent(s)
- \modDashboardWidgetInterface
Properties
string
$content= ''''
inheritedInherited from:
\modDashboardWidgetInterface::$$content
Default value
''Details- Type
- string
- Inherited_from
- \modDashboardWidgetInterface::$$content
\modManagerController
$controller= ''
inherited
A reference to the currently loaded manager controller
Inherited from: \modDashboardWidgetInterface::$$controller
Details
- Type
- \modManagerController
- Inherited_from
- \modDashboardWidgetInterface::$$controller
string
$cssBlockClass= ''dashboard-block-variable''
Allows widgets to specify a CSS class to attach to the block
Default value
'dashboard-block-variable'Details- Type
- string
\xPDO|\modX
$modx= ''
Details
- Type
- \xPDO | \modX
- Inherited_from
- \modDashboardWidgetInterface::$$modx
\modNamespace
$namespace= ''
inherited
A reference to the Namespace that this widget is executing in
Inherited from: \modDashboardWidgetInterface::$$namespace
Details
- Type
- \modNamespace
- Inherited_from
- \modDashboardWidgetInterface::$$namespace
\modDashboardWidget
$widget= ''
Details
- Type
- \modDashboardWidget
- Inherited_from
- \modDashboardWidgetInterface::$$widget
Methods
__construct(
\xPDO | \modX $modx, \modDashboardWidget $widget, \modManagerController $controller
)
:
void
inherited
Inherited from:
\modDashboardWidgetInterface::__construct()
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 |
getFileChunk(
string $tpl, array $placeholders
=
array()
)
:
string
inherited
Inherited from:
\modDashboardWidgetInterface::getFileChunk()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $tpl | string | |
| $placeholders | array |
| Type | Description |
|---|---|
| string |
process(
)
:
string
inherited
Renders the content of the block in the appropriate size
Inherited from: \modDashboardWidgetInterface::process()
Returns
| Type | Description |
|---|---|
| string |
render(
)
:
stringMust be declared in your derivative class. Must return the processed output of the widget.
Returns
| Type | Description |
|---|---|
| string |
renderAsSnippet(
string $content
=
''
)
:
string
inherited
Render the widget content as if it were a Snippet
Inherited from: \modDashboardWidgetInterface::renderAsSnippet()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $content | string |
| Type | Description |
|---|---|
| string |
setContent(
string $content
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $content | string |
setNamespace(
\modNamespace $namespace
)
:
void
inherited
Sets the Namespace that this widget will execute in
Inherited from: \modDashboardWidgetInterface::setNamespace()
Parameters
| Name | Type | Description |
|---|---|---|
| $namespace | \modNamespace |
toArray(
)
:
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 |