Class DashboardPlugin

Abstract class for dashboard plugins.

Object

Extended by

ViewableData implements IteratorAggregate

Extended by

DashboardPlugin

Direct known subclasses

RecentComments, RecentFiles, RecentPages, SiteInfo, UnmoderatedComments, WebylonNews

Abstract
Package: Dashboard
Located at dashboard/code/DashboardPlugin.php

Methods summary

`public static`	# `disable( mixed $plugin )` Sets a plugin class as disabled, so it will not appear on the dashboard. Sets a plugin class as disabled, so it will not appear on the dashboard.
`public static array`	# `get_disabled_plugins( )` Getter for $disabled_plugins Getter for $disabled_plugins Returns `array` array
`public string`	# `IconCSS( )` Returns an inline style for the icon. Used on dashboard template. Returns an inline style for the icon. Used on dashboard template. Returns `string` string
`public string`	# `getTitle( )` Translates the $title property Translates the $title property Returns `string` string
`public string`	# `getLinkText( )` Translates the $link_text property Translates the $link_text property Returns `string` string
`public string`	# `getLink( )` Getter for the $link property. Useful on templates, which don't have access to static vars. Getter for the $link property. Useful on templates, which don't have access to static vars. Returns `string` string
`public string`	# `getCaption( )` Getter for the $caption property. Allows you to add a quick caption to the top of your dash item Getter for the $caption property. Allows you to add a quick caption to the top of your dash item Returns `string` string
`public string`	# `getNullMessage( )` Getter for the $caption property. Allows you to add a quick caption to the top of your dash item Getter for the $caption property. Allows you to add a quick caption to the top of your dash item Returns `string` string
`public string`	# `getEditLink( )` Getter for the $edit_link property. Allows you to set the base url for an edit link Getter for the $edit_link property. Allows you to set the base url for an edit link Returns `string` string
`public string`	# `getEditPopup( )` Getter for the $edit_popup. Sets whether the edit link will be in a popup Getter for the $edit_popup. Sets whether the edit link will be in a popup Returns `string` string
`public string`	# `forTemplate( )` For rendering the plugin. Assumes template name of plugin class name. For rendering the plugin. Assumes template name of plugin class name. Returns `string` string

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), ColumnBreak(), ColumnCalc(), ColumnNumber(), ColumnPad(), ColumnPos(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), ThemeName(), Top(), TotalItems(), XML_val(), __get(), __isset(), __set(), buildCastingCache(), cachedCall(), castingClass(), castingHelper(), castingHelperPair(), castingObjectCreator(), castingObjectCreatorPair(), customise(), defineMethods(), escapeTypeForField(), getField(), getIterator(), getSecurityID(), getXMLValues(), hasField(), hasValue(), i18nLocale(), iteratorProperties(), obj(), renderWith(), setCustomisedObj(), setField()

Methods inherited from Object

__call(), __construct(), __toString(), __wakeup(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), exists(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

`public static string`	`$position`	# = The position of this plugin on the dashboard. Value must be contained in DashboardPlugin::$positions = The position of this plugin on the dashboard. Value must be contained in DashboardPlugin::$positions
`public static integer`	`$sort`	# = Index of where the plugin will appear in a given position. = Index of where the plugin will appear in a given position.
`public static array`	`$positions`	# = A lookup for the available positions of a plugin on the dashboard. = A lookup for the available positions of a plugin on the dashboard.
`public static mixed`	`$icon`	# = Path to the icon that is embedded in the plugin heading = Path to the icon that is embedded in the plugin heading
`public static mixed`	`$title`	# = Title of the plugin on dashboard view = Title of the plugin on dashboard view
`public static mixed`	`$link`	# = A link for more info embdedded in the header = A link for more info embdedded in the header
`public static string`	`$link_text`	# = Text for the more info link = Text for the more info link
`public static mixed`	`$limit_count`	# = Limiter to set how many items should be displayed = Limiter to set how many items should be displayed
`public static mixed`	`$caption`	# = Short caption to appear at the top of your plugin = Short caption to appear at the top of your plugin
`public static mixed`	`$null_message`	# = Short message to return if no data is returned = Short message to return if no data is returned
`public static mixed`	`$edit_link`	# = URL for edit button, if it exists = URL for edit button, if it exists
`public static boolean`	`$edit_popup`	# = Boolean value of whether an edit link should generate a popup = Boolean value of whether an edit link should generate a popup

Properties inherited from ViewableData

$casting, $customisedObject, $default_cast, $failover, $iteratorPos, $iteratorTotalItems

Properties inherited from Object

$class, $extension_instances, $extensions

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -