MapWidget class - Documentation for SproutCMS

Info Page:

Page options:

class MapWidget

Displays a google map

Variables

Name	Visibility	Description
`$default_settings`
`$friendly_desc`
`$friendly_name`
`$heading`		Optional HTML H2 heading that's rendered on front-end view
`$settings`		Settings - These get automatically set in the admin and loaded on the front-end

Functions

Name	Visibility	Description
cleanupSettings	public	Ensure settings are sane
getDefaultSettings	public	Returns the default settings for the widget
getEditUrl	public	This function should return a URL which can be used to edit the content which is
getFriendlyDesc	public	Gets the english name of this widget
getFriendlyName	public	Gets the english name of this widget
getInfoLabels	public	Returns a label which describes the contents of this widget
getNotAvailableReason	public	Is there sufficent content to add this addon at the moment?
getSettings	public	Return the currently loaded settings for the widget
getSettingsForm	public	Return the settings form for this widget
getTitle	public	Returns the title to use for the widget - should not contain HTML
importSettings	public	Imports the settings
render	public	Return the front-end view of this widget
setTitle	public	Set widget title

public cleanupSettings

void $MapWidget->cleanupSettings ( );

Ensure settings are sane

public getDefaultSettings (from Widget)

unknown $Widget->getDefaultSettings ( );

Returns the default settings for the widget

public getEditUrl (from Widget)

unknown $Widget->getEditUrl ( );

This function should return a URL which can be used to edit the *content* which is
displayed by this widget.

Most widgets show content using a category selection box; the URL should in that
case direct the user to the contents list for that category.

Return NULL if there isn't an appropriate URL to use.

public getFriendlyDesc (from Widget)

unknown $Widget->getFriendlyDesc ( );

Gets the english name of this widget

public getFriendlyName (from Widget)

unknown $Widget->getFriendlyName ( );

Gets the english name of this widget

public getInfoLabels

unknown $MapWidget->getInfoLabels ( );

Returns a label which describes the contents of this widget
See Widget::get_info_label for full documentation

public getNotAvailableReason (from Widget)

unknown $Widget->getNotAvailableReason ( );

Is there sufficent content to add this addon at the moment?
If this widget is not available, a string message should be returned
If this widget *is* available, NULL should be returned.

public getSettings (from Widget)

array $Widget->getSettings ( );

Return the currently loaded settings for the widget

public getSettingsForm

unknown $MapWidget->getSettingsForm ( );

Return the settings form for this widget

public getTitle (from Widget)

unknown $Widget->getTitle ( );

Returns the title to use for the widget - should not contain HTML

public importSettings (from Widget)

void $Widget->importSettings ( array $settings );

Imports the settings

public render

unknown $MapWidget->render ( int $orientation );

Return the front-end view of this widget

public setTitle (from Widget)

void $Widget->setTitle ( string $str );

Set widget title

SproutCMS

Search documentation